FileNet Content Services
Java Connector v3.0

com.filenet.Panagon
Interface PropertyDescription

All Superinterfaces:
BaseObject, GettableObject, PanagonObject, PropertyDescription, ReadableMetadataObject, java.io.Serializable, ValueObject

public interface PropertyDescription
extends PanagonObject, PropertyDescription

A PropertyDescription object is a collection of metadata that describes a property. This interface defines the custom and system properties of a PropertyDescription object. For information on instantiating or creating a PropertyDescription object, see the description of the the com.filenet.wcm.api.PropertyDescription base interface.

See Also:
CS Java Toolkit Developer's Guide

Field Summary
static java.lang.String idmDefault
          The default value of the property.
static java.lang.String idmLabel
          This property returns the user-displayable name for the PropertyDescription.
static java.lang.String idmPropKey
          Indicates that the property is a key condition (has an index).
static java.lang.String idmPropMultiValue
          Indicates that the property has multiple values.
static java.lang.String idmPropRequired
          Indicates that the property is requires a value to be provided when creating or saving a document
static java.lang.String idmPropSearchWithEqualOperator
          Indicates that the property can be used in a search expression with the Equal operator.
static java.lang.String idmPropSearchWithGreaterThanOperator
          Indicates that the property can be used in a search expression with the Greater than operator.
static java.lang.String idmPropSearchWithGreaterThanOrEqualOperator
          Indicates that the property can be used in a search expression with the Greater Than Or Equal operator.
static java.lang.String idmPropSearchWithLessThanOperator
          Indicates that the property can be used in a search expression with the Less Than operator.
static java.lang.String idmPropSearchWithLessThanOrEqualOperator
          Indicates that the property can be used in a search expression with the Less Than Or Equal operator.
static java.lang.String idmPropSearchWithLikeOperator
          Indicates that the property can be used in a search expression with the Like operator.
static java.lang.String idmPropSearchWithNotEqualOperator
          Indicates that the property can be used in a search expression with the Not Equal operator.
static java.lang.String idmPropSearchWithNotLikeOperator
          Indicates that the property can be used in a search expression with the Not Like operator.
static java.lang.String idmPropSelectable
          Indicates that the property can be selected for return from a query.
static java.lang.String idmPropSortable
          Indicates that the property can be sorted.
static java.lang.String idmPropVersion
          Indicates that the property is a Content Services (CS) version property and not an item property.
static java.lang.String idmSize
          Indicates the maximum size, in bytes, of the Property described by the PropertyDescription.
static java.lang.String idmTypeId
          Indicates data type for the property value.
static java.lang.String STATE_PROP_CAN_WRITE
          Indicates that the property can be set.
static java.lang.String STATE_PROP_CUSTOM
          Indicates that the property is custom-defined (i.e. not a system property).
static java.lang.String STATE_PROP_DISPLAYABLE
          Indicates that the property can be displayed in the user interface.
static java.lang.String STATE_PROP_HAS_CHOICES
          Indicates that the property has a choice list.
static java.lang.String STATE_PROP_HAS_CVL
          Indicates that the Choices for the property are derived from Controlled Vocabulary Lists (CVLs).
static java.lang.String STATE_PROP_HAS_CVL_PLUGIN
          Indicates that this property is configured in Content Services to derive it's Choices from a custom CVL plugin.
static java.lang.String STATE_PROP_HAS_DEFAULT
          Indicates that the property has a default value.
static java.lang.String STATE_PROP_IS_MUST_PICK
          Indicates that the value of the property can only be selected from the choice list.
static java.lang.String STATE_PROP_READ_ONLY
          Indicates that the property is read-only.
static java.lang.String STATE_PROP_SEARCHABLE
          Indicates that the property can be in used in a query condition.
 
Fields inherited from interface com.filenet.Panagon.PanagonObject
idmId, idmName
 
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
 
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.PropertyDescription
getChoices
 
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
 

Field Detail

idmDefault

public static final java.lang.String idmDefault
The default value of the property.

See Also:
Constant Field Values

idmSize

public static final java.lang.String idmSize
Indicates the maximum size, in bytes, of the Property described by the PropertyDescription.

See Also:
Constant Field Values

idmTypeId

public static final java.lang.String idmTypeId
Indicates data type for the property value. It also describes the values returned in choice lists and multi-valued lists.

See Also:
Constant Field Values

idmLabel

public static final java.lang.String idmLabel
This property returns the user-displayable name for the PropertyDescription. The value of this field is the same as the value in com.filenet.wcm.api.Property.DISPLAY_NAME.

See Also:
Constant Field Values

idmPropMultiValue

public static final java.lang.String idmPropMultiValue
Indicates that the property has multiple values.

See Also:
Constant Field Values

idmPropRequired

public static final java.lang.String idmPropRequired
Indicates that the property is requires a value to be provided when creating or saving a document

See Also:
Constant Field Values

idmPropVersion

public static final java.lang.String idmPropVersion
Indicates that the property is a Content Services (CS) version property and not an item property.

See Also:
Constant Field Values

idmPropSearchWithEqualOperator

public static final java.lang.String idmPropSearchWithEqualOperator
Indicates that the property can be used in a search expression with the Equal operator.

See Also:
Constant Field Values

idmPropSearchWithNotEqualOperator

public static final java.lang.String idmPropSearchWithNotEqualOperator
Indicates that the property can be used in a search expression with the Not Equal operator.

See Also:
Constant Field Values

idmPropSearchWithGreaterThanOperator

public static final java.lang.String idmPropSearchWithGreaterThanOperator
Indicates that the property can be used in a search expression with the Greater than operator.

See Also:
Constant Field Values

idmPropSearchWithGreaterThanOrEqualOperator

public static final java.lang.String idmPropSearchWithGreaterThanOrEqualOperator
Indicates that the property can be used in a search expression with the Greater Than Or Equal operator.

See Also:
Constant Field Values

idmPropSearchWithLessThanOperator

public static final java.lang.String idmPropSearchWithLessThanOperator
Indicates that the property can be used in a search expression with the Less Than operator.

See Also:
Constant Field Values

idmPropSearchWithLessThanOrEqualOperator

public static final java.lang.String idmPropSearchWithLessThanOrEqualOperator
Indicates that the property can be used in a search expression with the Less Than Or Equal operator.

See Also:
Constant Field Values

idmPropSearchWithLikeOperator

public static final java.lang.String idmPropSearchWithLikeOperator
Indicates that the property can be used in a search expression with the Like operator.

See Also:
Constant Field Values

idmPropSearchWithNotLikeOperator

public static final java.lang.String idmPropSearchWithNotLikeOperator
Indicates that the property can be used in a search expression with the Not Like operator.

See Also:
Constant Field Values

idmPropSelectable

public static final java.lang.String idmPropSelectable
Indicates that the property can be selected for return from a query.

See Also:
Constant Field Values

idmPropSortable

public static final java.lang.String idmPropSortable
Indicates that the property can be sorted.

See Also:
Constant Field Values

idmPropKey

public static final java.lang.String idmPropKey
Indicates that the property is a key condition (has an index).

See Also:
Constant Field Values

STATE_PROP_SEARCHABLE

public static final java.lang.String STATE_PROP_SEARCHABLE
Indicates that the property can be in used in a query condition.

See Also:
Constant Field Values

STATE_PROP_CUSTOM

public static final java.lang.String STATE_PROP_CUSTOM
Indicates that the property is custom-defined (i.e. not a system property).

See Also:
Constant Field Values

STATE_PROP_HAS_DEFAULT

public static final java.lang.String STATE_PROP_HAS_DEFAULT
Indicates that the property has a default value.

See Also:
Constant Field Values

STATE_PROP_DISPLAYABLE

public static final java.lang.String STATE_PROP_DISPLAYABLE
Indicates that the property can be displayed in the user interface. False if the currently logged-on user does not have access to the property value.

See Also:
Constant Field Values

STATE_PROP_READ_ONLY

public static final java.lang.String STATE_PROP_READ_ONLY
Indicates that the property is read-only.

See Also:
Constant Field Values

STATE_PROP_CAN_WRITE

public static final java.lang.String STATE_PROP_CAN_WRITE
Indicates that the property can be set.

See Also:
Constant Field Values

STATE_PROP_HAS_CVL

public static final java.lang.String STATE_PROP_HAS_CVL
Indicates that the Choices for the property are derived from Controlled Vocabulary Lists (CVLs).

See Also:
Constant Field Values

STATE_PROP_HAS_CVL_PLUGIN

public static final java.lang.String STATE_PROP_HAS_CVL_PLUGIN
Indicates that this property is configured in Content Services to derive it's Choices from a custom CVL plugin. CVL plugins are not supported within the CS Java Connector; thus, properties that return a value of True for this state cannot be set.

See Also:
Constant Field Values

STATE_PROP_IS_MUST_PICK

public static final java.lang.String STATE_PROP_IS_MUST_PICK
Indicates that the value of the property can only be selected from the choice list.

See Also:
Constant Field Values

STATE_PROP_HAS_CHOICES

public static final java.lang.String STATE_PROP_HAS_CHOICES
Indicates that the property has a choice list.

See Also:
Constant Field Values

FileNet Content Services
Java Connector v3.0