FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface PropertyDescription

All Superinterfaces:
BaseObject, GettableObject, ReadableMetadataObject, java.io.Serializable, ValueObject
All Known Subinterfaces:
PropertyDescription, SearchPropertyDescription

public interface PropertyDescription
extends BaseObject, ReadableMetadataObject, GettableObject

A PropertyDescription object is a collection of metadata that describes a property. The metadata defines the attributes of a property, such as its display name, its data type, and whether it can be be set. A PropertyDescription object has the same function for a property that a ClassDescription object has for a class.

You cannot create a new PropertyDescription object to persist to the Content Services server. To instantiate a persisted one, instantiate a PropertyDescriptions collection, then return a PropertyDescription object from the collection. For ways to instantiate a PropertyDescriptions collection, see the PropertyDescriptions interface.

Note that you can, however, create a local PropertyDescription object to include in a PropertyDescriptions collection (which is ultimately used as an argument to various methods) by calling the ObjectFactory's getPropertyDescription method.

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
 ChoiceList getChoices(int depth)
          Returns the collection of Choice objects (values) for this PropertyDescription object.
 
Methods inherited from interface com.filenet.wcm.api.BaseObject
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
 
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
 

Method Detail

getChoices

public ChoiceList getChoices(int depth)

Returns the collection of Choice objects (values) for this PropertyDescription object.

Parameters:
depth - Requires an integer value; however, the value is ignored by the CS Java Connector.

Returns:
A ChoiceList collection that contains the Choice objects for this PropertyDescription object.

FileNet Content Services
Java Connector v3.0