FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface WriteableMetadataObject

All Superinterfaces:
BaseObject, ReadableMetadataObject, java.io.Serializable, ValueObject
All Known Subinterfaces:
Annotation, CustomObject, Document, Document, DynamicReferentialContainmentRelationship, EventAction, FeatureAddOn, Folder, Folder, Link, PublishRequest, PublishTemplate, ReferentialContainmentRelationship, SecurityPolicy, StoredSearch, StyleTemplate, Subscription, WorkflowDefinition, WorkflowSubscription, WriteableSecurityObject

public interface WriteableMetadataObject
extends ReadableMetadataObject

An object implementing the WriteableMetadataObject interface is an object for which metadata (including properties, but not permissions) can be changed and persisted to the object store.

See Also:
CS Java Toolkit Developer's Guide

Field Summary
 
Fields inherited from interface com.filenet.wcm.api.BaseObject
EXPORT_DEFAULT, EXPORT_ENCODED_CONTENT, EXPORT_FULL, EXPORT_OBJECT_ID, EXPORT_OBJECT_SECURITY, IMPORT_DEFAULT, IMPORT_OBJECT_ID, IMPORT_OWNER, IMPORT_PERMISSIONS, TYPE_ACTIVE_MARKING, TYPE_ANNOTATION, TYPE_ANY, TYPE_CBR_ENGINE_TYPE, TYPE_CHOICE, TYPE_CHOICELIST, TYPE_CLASS_SUBSCRIPTION, TYPE_CLASSDEFINITION, TYPE_CLASSDESCRIPTION, TYPE_COLUMN_DEFINITION, TYPE_COMPUTER, TYPE_CONTENT_CACHE_SERVICE, TYPE_CONTENT_MGR_SERVICE, TYPE_CONTENT_REFERENCE, TYPE_CONTENT_TRANSFER, TYPE_CUSTOMOBJECT, TYPE_DOCUMENT, TYPE_DOCUMENT_CLASSIFICATION_ACTION, TYPE_DOCUMENT_LIFECYCLE_ACTION, TYPE_DOCUMENT_LIFECYCLE_POLICY, TYPE_DOCUMENTSTATE, TYPE_DOMAIN, TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_ENTIRENETWORK, TYPE_EVENT, TYPE_EVENT_ACTION, TYPE_FEATURE_ADD_ON, TYPE_FILESTORE, TYPE_FOLDER, TYPE_GROUP, TYPE_INSTANCE_SUBSCRIPTION, TYPE_LINK, TYPE_LOCALIZED_STRING, TYPE_MARKING_SET, TYPE_MULTIPLEVALUES, TYPE_OBJECT_STORE, TYPE_OBJECTSET, TYPE_OBJSTORE_SERVICE, TYPE_PERMISSION, TYPE_PROPERTY_DEFINITION, TYPE_PROPERTYDESCRIPTION, TYPE_PROPERTYDESCRIPTIONS, TYPE_PUBLISH_REQUEST, TYPE_PUBLISH_TEMPLATE, TYPE_READONLY_OBJECT_SET, TYPE_REALM, TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_SECURITY_POLICY, TYPE_SECURITY_TEMPLATE, TYPE_STORAGE_POLICY, TYPE_STORED_SEARCH, TYPE_STYLE_TEMPLATE, TYPE_SUBSCRIPTION, TYPE_TABLE_DEFINITION, TYPE_TRANSIENT, TYPE_USER, TYPE_VERSIONSERIES, TYPE_WORKFLOW_CLASS_SUBSCRIPTION, TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION, TYPE_WORKFLOWDEFINITION, TYPE_XML_PROPERTY_MAPPING_SCRIPT
 
Method Summary
 void setProperties(Properties props)
          Sets the specified properties for the object implementing the WriteableMetadataObject interface and persists them to the Content Services server.
 
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
 
Methods inherited from interface com.filenet.wcm.api.BaseObject
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
 

Method Detail

setProperties

public void setProperties(Properties props)
Sets the specified properties for the object implementing the WriteableMetadataObject interface and persists them to the Content Services server. To successfully execute this method, the user must have permission to modify this WriteableMetadataObject object's properties.

Specify the properties to set in the Properties collection. Note that you need only set properties you want to change; you do not need to include those properties for which values should remain unchanged. This method will throw an exception if you explicitly set the value of a contained Property object that cannot be set due to its Settability property (e.g., it is Read-only). Note that this exception will be thrown even if the new value of a property you explicitly set is the same as its old value.

After a successful call to setProperties, all properties are considered stale and are removed from cache for this WriteableMetadataObject object. A subsequent request for any properties causes the CS Java Connector to retrieve fresh data from the Content Services server.

Parameters:
props - A Properties collection containing the Property elements to persist to the Content Services server.


FileNet Content Services
Java Connector v3.0