FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface ClassDescription

All Superinterfaces:
BaseObject, GettableObject, ReadableMetadataObject, java.io.Serializable, ValueObject, WorkflowTarget
All Known Subinterfaces:
ClassDescription

public interface ClassDescription
extends GettableObject, BaseObject, WorkflowTarget, ReadableMetadataObject

A ClassDescription object is a collection of metadata that describes a Content Services class. The major uses of a ClassDescription object are:

You cannot create a new ClassDescription object via the CS Java Connector, but you can instantiate an existing one in the following ways:

You can also return a ClassDescription object by instantiating a ClassDescriptions collection, then returning a ClassDescription object from the collection. See the ClassDescriptions interface for ways to instantiate a ClassDescriptions collection.

See Also:
CS Java Connector Developer's Guide

Field Summary
static java.lang.String ANNOTATION
          Value of "{D54A3E9C-0704-11D3-8A0E-00104B6CB1DA}"; specifies an Annotation ClassDescription.
static java.lang.String APPLICATION_SECURITY_TEMPLATE
          Value of "{5CE0407C-AAC6-48B9-9CE3-DEC3A2D4DF1F}"; specifies a ApplicationSecurityTemplate ClassDescription.
static java.lang.String AUDIT_CONFIGURATION_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String AUDIT_DEFINITION
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String CANCEL_CHECKOUT_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String CHANGE_CLASS_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String CHANGE_STATE_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String CHECKIN_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String CHECKOUT_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String CHOICELIST
          Value of "{D32E4F70-AFB2-11D2-8BD6-00E0290F729A}"; specifies a ChoiceList ClassDescription.
static java.lang.String CLASS_SUBSCRIPTION
          Value of "{8A782BAB-E5EE-4914-94C7-B4481A54E385}"; specifies a ClassSubscription ClassDescription.
static java.lang.String CLASS_WORKFLOW_SUBSCRIPTION
          Value of "{5763CE24-8D28-47F3-84AB-5F1FBC2BB24A}"; specifies a ClassWorkflowSubscription ClassDescription.
static java.lang.String CLASSDEFINITION
          Value of "{D32E4F5A-AFB2-11D2-8BD6-00E0290F729A}"; specifies a ClassDefinition ClassDescription.
static java.lang.String CLASSIFY_COMPLETE_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String CREATION_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String CUSTOM_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String CUSTOM_OBJECT
          Value of "{D32E4F58-AFB2-11D2-8BD6-00E0290F729A}"; specifies a CustomObject ClassDescription.
static java.lang.String DELETION_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String DEMOTE_VERSION_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String DOCUMENT
          Value of "{01A3A8C2-7AEC-11D1-A31B-0020AF9FBB1C}"; specifies a Document ClassDescription.
static java.lang.String DOCUMENT_CLASSDEFINITION
          Value of "{C57469A4-1592-4428-B7EE-0C970E4DB76A}"; specifies a DocumentClassDefinition ClassDescription.
static java.lang.String DOCUMENT_CLASSIFICATION_ACTION
          Value of "{BF416C8B-FD3D-4998-97D1-EB110F912FBE}"; specifies a DocumentClassificationAction ClassDescription.
static java.lang.String DOCUMENT_LIFECYCLE_ACTION
          Value of "{9C1E8B0B-4490-4B06-85E5-C686502733C8}"; specifies a DocumentLifecycleAction ClassDescription.
static java.lang.String DOCUMENT_LIFECYCLE_POLICY
          Value of "{FD923C38-5C1B-442C-956B-8A0585FAA1F2}"; specifies a DocumentLifecyclePolicy ClassDescription.
static java.lang.String DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP
          Value of "{D32E4F77-AFB2-11D2-8BD6-00E0290F729A}"; specifies a DynamicReferentialContainmentRelationship ClassDescription.
static java.lang.String EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String EVENT_ACTION
          Value of "{A21F7DA0-012A-4AEE-8894-F9CB1389D061}"; specifies an EventAction ClassDescription.
static java.lang.String FILE_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String FOLDER
          Value of "{01A3A8CA-7AEC-11D1-A31B-0020AF9FBB1C}"; specifies a Folder ClassDescription.
static java.lang.String GET_CONTENT_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String GET_OBJECT_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String GLOBAL_PROPERTY_DEFINITION
          Value of "{D32E4F64-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinition ClassDescription.
static java.lang.String GLOBAL_PROPERTY_DEFINITION_BINARY
          Value of "{D32E4F66-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionBinary ClassDescription.
static java.lang.String GLOBAL_PROPERTY_DEFINITION_BOOLEAN
          Value of "{D32E4F65-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionBoolean ClassDescription.
static java.lang.String GLOBAL_PROPERTY_DEFINITION_DATETIME
          Value of "{D32E4F67-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionDateTime ClassDescription.
static java.lang.String GLOBAL_PROPERTY_DEFINITION_FLOAT64
          Value of "{D32E4F68-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionFloat64 ClassDescription.
static java.lang.String GLOBAL_PROPERTY_DEFINITION_ID
          Value of "{D32E4F69-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionId ClassDescription.
static java.lang.String GLOBAL_PROPERTY_DEFINITION_INTEGER32
          Value of "{D32E4F6A-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionInteger32 ClassDescription.
static java.lang.String GLOBAL_PROPERTY_DEFINITION_OBJECT
          Value of "{D32E4F6B-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinition ClassDescription.
static java.lang.String GLOBAL_PROPERTY_DEFINITION_STRING
          Value of "{D32E4F6C-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionString ClassDescription.
static java.lang.String INSTANCE_SUBSCRIPTION
          Value of "{B504B8D1-BD9D-44BD-BF53-D6221EFF203C}"; specifies an InstanceSubscription ClassDescription.
static java.lang.String INSTANCE_WORKFLOW_SUBSCRIPTION
          Value of "{C4984168-0059-4FDD-9826-979D44C7E3D2}"; specifies an InstanceWorkflowSubscription ClassDescription.
static java.lang.String LINK
          Value of "{21036306-574C-4917-B0F3-F181E215A536}"; specifies a Link ClassDescription.
static java.lang.String MARKING
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String MARKING_SET
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String OBJECT_CHANGE_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String OBJECT_STORE
          Value of "{01A3A8A9-7AEC-11D1-A31B-0020AF9FBB1C}"; specifies a ObjectStore ClassDescription.
static java.lang.String PROMOTE_VERSION_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String PUBLISH_REQUEST
          Value of "{05F49D01-C7B5-4A98-BBA0-907D776DD251}"; specifies a PublishRequest ClassDescription.
static java.lang.String PUBLISH_STYLE_TEMPLATE
          Value of "{468E5D1F-DBB2-485A-A96B-8E4781D5EAB5}"; specifies a PublishStyleTemplate ClassDescription.
static java.lang.String PUBLISH_SUBSIDIARY_FOLDER_OWNER
          Value of "{A1B237AD-0C25-4AFC-BE07-B3581DB20F11}"; specifies a PublishSubsidiaryFolderOwner ClassDescription.
static java.lang.String PUBLISH_TEMPLATE
          Value of "{FBA25CE9-A06A-4F79-8A23-E09AE54DD7CD}"; specifies a PublishTemplate ClassDescription.
static java.lang.String PUBLISH_TRANSFORM_ENGINE
          Value of "{C32F0EBF-94A4-4072-BE71-C76438B0EF69}"; specifies a PublishTransformationEngine ClassDescription.
static java.lang.String QUERY_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String REFERENTIAL_CONTAINMENT_RELATIONSHIP
          Value of "{01A3A8CE-7AEC-11D1-A31B-0020AF9FBB1C}"; specifies a ReferentialContainmentRelationship ClassDescription.
static java.lang.String RETRIEVAL_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String SCENARIO_DEFINITION
          Value of "{902C0C1F-65DC-4925-B8FA-B4ECA4AD752A}"; specifies a ScenarioDefinition ClassDescription (for Process Engine scenario definition documents).
static java.lang.String SECURITY_POLICY
          Value of "{9C78F00D-E098-419A-AE10-5D854757EC79}"; specifies a SecurityPolicy ClassDescription.
static java.lang.String SIMULATION
          Value of "{193E5683-C724-4C3B-8D55-F4091B9B7222}"; specifies a Simulation ClassDescription (for Process Engine simulation documents).
static java.lang.String STORED_SEARCH
          Value of "{D508E302-7E74-42F4-A7D7-B985DD333509}"; specifies a StoredSearch ClassDescription.
static java.lang.String STRING_LOOKUP
          Value of "{65CC2041-96D5-4FB9-88F1-8C568B29E4CD}"; specifies a StringLookup ClassDescription.
static java.lang.String STYLE_TEMPLATE
          An alias for PUBLISH_STYLE_TEMPLATE; specifies a StyleTemplate ClassDescription.
static java.lang.String SUBSCRIBABLE_CLASSDEFINITION
          Value of "{F028E2D2-C18C-407D-A5A2-38C6D383F4BC}"; specifies a SubscribableClassDefinition ClassDescription.
static java.lang.String TRANSIENT
          Value of "{D32E4F59-AFB2-11D2-8BD6-00E0290F729A}"; specifies a Transient ClassDescription.
static java.lang.String UNFILE_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String UPDATE_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String UPDATE_SECURITY_EVENT
          

Not Implemented in CS Java Connector v3.0.

static java.lang.String VERSION_SERIES
          Value of "{01A3A8C8-7AEC-11D1-A31B-0020AF9FBB1C}"; specifies a VersionSeries ClassDescription.
static java.lang.String VERSIONABLE_CLASSDEFINITION
          Value of "{ED70B437-135A-488E-997D-285CF6D63C3B}"; specifies a VersionableClassDefinition ClassDescription.
static java.lang.String VERSIONING_SECURITY_TEMPLATE
          Value of "{07B27C4E-E018-4AC8-9C5C-45F211986EB4}"; specifies a VersioningSecurityTemplate ClassDescription.
static java.lang.String WORKFLOW_EVENT_ACTION
          Value of "{A8A9A512-F479-43E1-BCDC-9EB395C54F3B}"; specifies a WorkflowEventAction ClassDescription.
static java.lang.String WORKFLOWDEFINITION
          Value of "{A5C636CD-11BD-455D-9E1A-604A356ABFBA}"; specifies a WorkflowDefinition ClassDescription.
static java.lang.String XML_PROPERTY_MAPPING_SCRIPT
          Value of "{B88E2937-CCAD-4BD1-8920-54C6D1B9331F}"; specifies an XMLPropertyMappingScript ClassDescription.
 
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
 AuditDefinitions getAuditDefinitions()
          Deprecated. Use getAuditDefinitions(boolean incInherited).
 AuditDefinitions getAuditDefinitions(boolean incInherited)
          

Not Implemented in CS Java Connector v3.0.

 Permissions getDefaultPermissions()
          Retrieves the default permissions for an object of this class.
 Permissions getDefaultPermissions(java.lang.String collectionType)
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getDefaultPermissionsXML()
          Retrieves a string that represents the default permissions for an object of this class.
 PropertyDescriptions getPropertyDescriptions()
          Returns all property descriptions for this ClassDescription object.
 PropertyDescriptions getPropertyDescriptions(boolean getAll)
          Returns all property descriptions for this ClassDescription object.
 java.lang.String getPropertyDescriptionsXML(java.lang.String[] propNames)
          Returns a string in XML that represents the requested property descriptions for this ClassDescription object.
 java.lang.String getPropertyDescriptionsXML(java.lang.String[] propNames, boolean getAll)
          Returns a string in XML that represents the requested property descriptions for this ClassDescription object.
 java.lang.String getRegisteredEventsXML()
          

Not Implemented in CS Java Connector v3.0.

 boolean isInstantiableByUser()
          Specifies whether the current user has the appropriate access rights to create a new object of this class.
 boolean isSubclassOf(java.lang.String className)
          

Not Implemented in CS Java Connector v3.0.

 
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.WorkflowTarget
getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML
 
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
 

Field Detail

DOCUMENT

public static final java.lang.String DOCUMENT
Value of "{01A3A8C2-7AEC-11D1-A31B-0020AF9FBB1C}"; specifies a Document ClassDescription.

See Also:
Constant Field Values

STORED_SEARCH

public static final java.lang.String STORED_SEARCH
Value of "{D508E302-7E74-42F4-A7D7-B985DD333509}"; specifies a StoredSearch ClassDescription.

See Also:
Constant Field Values

PUBLISH_TEMPLATE

public static final java.lang.String PUBLISH_TEMPLATE
Value of "{FBA25CE9-A06A-4F79-8A23-E09AE54DD7CD}"; specifies a PublishTemplate ClassDescription.

See Also:
Constant Field Values

PUBLISH_REQUEST

public static final java.lang.String PUBLISH_REQUEST
Value of "{05F49D01-C7B5-4A98-BBA0-907D776DD251}"; specifies a PublishRequest ClassDescription.

See Also:
Constant Field Values

PUBLISH_TRANSFORM_ENGINE

public static final java.lang.String PUBLISH_TRANSFORM_ENGINE
Value of "{C32F0EBF-94A4-4072-BE71-C76438B0EF69}"; specifies a PublishTransformationEngine ClassDescription.

See Also:
Constant Field Values

CUSTOM_OBJECT

public static final java.lang.String CUSTOM_OBJECT
Value of "{D32E4F58-AFB2-11D2-8BD6-00E0290F729A}"; specifies a CustomObject ClassDescription.

See Also:
Constant Field Values

WORKFLOWDEFINITION

public static final java.lang.String WORKFLOWDEFINITION
Value of "{A5C636CD-11BD-455D-9E1A-604A356ABFBA}"; specifies a WorkflowDefinition ClassDescription.

See Also:
Constant Field Values

OBJECT_STORE

public static final java.lang.String OBJECT_STORE
Value of "{01A3A8A9-7AEC-11D1-A31B-0020AF9FBB1C}"; specifies a ObjectStore ClassDescription.

See Also:
Constant Field Values

FOLDER

public static final java.lang.String FOLDER
Value of "{01A3A8CA-7AEC-11D1-A31B-0020AF9FBB1C}"; specifies a Folder ClassDescription.

See Also:
Constant Field Values

TRANSIENT

public static final java.lang.String TRANSIENT
Value of "{D32E4F59-AFB2-11D2-8BD6-00E0290F729A}"; specifies a Transient ClassDescription.

See Also:
Constant Field Values

VERSIONING_SECURITY_TEMPLATE

public static final java.lang.String VERSIONING_SECURITY_TEMPLATE
Value of "{07B27C4E-E018-4AC8-9C5C-45F211986EB4}"; specifies a VersioningSecurityTemplate ClassDescription.

See Also:
Constant Field Values

VERSION_SERIES

public static final java.lang.String VERSION_SERIES
Value of "{01A3A8C8-7AEC-11D1-A31B-0020AF9FBB1C}"; specifies a VersionSeries ClassDescription.

See Also:
Constant Field Values

SECURITY_POLICY

public static final java.lang.String SECURITY_POLICY
Value of "{9C78F00D-E098-419A-AE10-5D854757EC79}"; specifies a SecurityPolicy ClassDescription.

See Also:
Constant Field Values

XML_PROPERTY_MAPPING_SCRIPT

public static final java.lang.String XML_PROPERTY_MAPPING_SCRIPT
Value of "{B88E2937-CCAD-4BD1-8920-54C6D1B9331F}"; specifies an XMLPropertyMappingScript ClassDescription.

See Also:
Constant Field Values

ANNOTATION

public static final java.lang.String ANNOTATION
Value of "{D54A3E9C-0704-11D3-8A0E-00104B6CB1DA}"; specifies an Annotation ClassDescription.

See Also:
Constant Field Values

APPLICATION_SECURITY_TEMPLATE

public static final java.lang.String APPLICATION_SECURITY_TEMPLATE
Value of "{5CE0407C-AAC6-48B9-9CE3-DEC3A2D4DF1F}"; specifies a ApplicationSecurityTemplate ClassDescription.

See Also:
Constant Field Values

CHOICELIST

public static final java.lang.String CHOICELIST
Value of "{D32E4F70-AFB2-11D2-8BD6-00E0290F729A}"; specifies a ChoiceList ClassDescription.

See Also:
Constant Field Values

CLASSDEFINITION

public static final java.lang.String CLASSDEFINITION
Value of "{D32E4F5A-AFB2-11D2-8BD6-00E0290F729A}"; specifies a ClassDefinition ClassDescription.

See Also:
Constant Field Values

SUBSCRIBABLE_CLASSDEFINITION

public static final java.lang.String SUBSCRIBABLE_CLASSDEFINITION
Value of "{F028E2D2-C18C-407D-A5A2-38C6D383F4BC}"; specifies a SubscribableClassDefinition ClassDescription.

See Also:
Constant Field Values

VERSIONABLE_CLASSDEFINITION

public static final java.lang.String VERSIONABLE_CLASSDEFINITION
Value of "{ED70B437-135A-488E-997D-285CF6D63C3B}"; specifies a VersionableClassDefinition ClassDescription.

See Also:
Constant Field Values

DOCUMENT_CLASSDEFINITION

public static final java.lang.String DOCUMENT_CLASSDEFINITION
Value of "{C57469A4-1592-4428-B7EE-0C970E4DB76A}"; specifies a DocumentClassDefinition ClassDescription.

See Also:
Constant Field Values

CLASS_SUBSCRIPTION

public static final java.lang.String CLASS_SUBSCRIPTION
Value of "{8A782BAB-E5EE-4914-94C7-B4481A54E385}"; specifies a ClassSubscription ClassDescription.

See Also:
Constant Field Values

CLASS_WORKFLOW_SUBSCRIPTION

public static final java.lang.String CLASS_WORKFLOW_SUBSCRIPTION
Value of "{5763CE24-8D28-47F3-84AB-5F1FBC2BB24A}"; specifies a ClassWorkflowSubscription ClassDescription.

See Also:
Constant Field Values

PUBLISH_STYLE_TEMPLATE

public static final java.lang.String PUBLISH_STYLE_TEMPLATE
Value of "{468E5D1F-DBB2-485A-A96B-8E4781D5EAB5}"; specifies a PublishStyleTemplate ClassDescription.

See Also:
Constant Field Values

STYLE_TEMPLATE

public static final java.lang.String STYLE_TEMPLATE
An alias for PUBLISH_STYLE_TEMPLATE; specifies a StyleTemplate ClassDescription.

See Also:
Constant Field Values

DOCUMENT_CLASSIFICATION_ACTION

public static final java.lang.String DOCUMENT_CLASSIFICATION_ACTION
Value of "{BF416C8B-FD3D-4998-97D1-EB110F912FBE}"; specifies a DocumentClassificationAction ClassDescription.

See Also:
Constant Field Values

DOCUMENT_LIFECYCLE_ACTION

public static final java.lang.String DOCUMENT_LIFECYCLE_ACTION
Value of "{9C1E8B0B-4490-4B06-85E5-C686502733C8}"; specifies a DocumentLifecycleAction ClassDescription.

See Also:
Constant Field Values

DOCUMENT_LIFECYCLE_POLICY

public static final java.lang.String DOCUMENT_LIFECYCLE_POLICY
Value of "{FD923C38-5C1B-442C-956B-8A0585FAA1F2}"; specifies a DocumentLifecyclePolicy ClassDescription.

See Also:
Constant Field Values

EVENT_ACTION

public static final java.lang.String EVENT_ACTION
Value of "{A21F7DA0-012A-4AEE-8894-F9CB1389D061}"; specifies an EventAction ClassDescription.

See Also:
Constant Field Values

WORKFLOW_EVENT_ACTION

public static final java.lang.String WORKFLOW_EVENT_ACTION
Value of "{A8A9A512-F479-43E1-BCDC-9EB395C54F3B}"; specifies a WorkflowEventAction ClassDescription.

See Also:
Constant Field Values

INSTANCE_SUBSCRIPTION

public static final java.lang.String INSTANCE_SUBSCRIPTION
Value of "{B504B8D1-BD9D-44BD-BF53-D6221EFF203C}"; specifies an InstanceSubscription ClassDescription.

See Also:
Constant Field Values

INSTANCE_WORKFLOW_SUBSCRIPTION

public static final java.lang.String INSTANCE_WORKFLOW_SUBSCRIPTION
Value of "{C4984168-0059-4FDD-9826-979D44C7E3D2}"; specifies an InstanceWorkflowSubscription ClassDescription.

See Also:
Constant Field Values

LINK

public static final java.lang.String LINK
Value of "{21036306-574C-4917-B0F3-F181E215A536}"; specifies a Link ClassDescription.

See Also:
Constant Field Values

GLOBAL_PROPERTY_DEFINITION

public static final java.lang.String GLOBAL_PROPERTY_DEFINITION
Value of "{D32E4F64-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinition ClassDescription.

See Also:
Constant Field Values

GLOBAL_PROPERTY_DEFINITION_BINARY

public static final java.lang.String GLOBAL_PROPERTY_DEFINITION_BINARY
Value of "{D32E4F66-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionBinary ClassDescription.

See Also:
Constant Field Values

GLOBAL_PROPERTY_DEFINITION_BOOLEAN

public static final java.lang.String GLOBAL_PROPERTY_DEFINITION_BOOLEAN
Value of "{D32E4F65-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionBoolean ClassDescription.

See Also:
Constant Field Values

GLOBAL_PROPERTY_DEFINITION_DATETIME

public static final java.lang.String GLOBAL_PROPERTY_DEFINITION_DATETIME
Value of "{D32E4F67-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionDateTime ClassDescription.

See Also:
Constant Field Values

GLOBAL_PROPERTY_DEFINITION_FLOAT64

public static final java.lang.String GLOBAL_PROPERTY_DEFINITION_FLOAT64
Value of "{D32E4F68-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionFloat64 ClassDescription.

See Also:
Constant Field Values

GLOBAL_PROPERTY_DEFINITION_ID

public static final java.lang.String GLOBAL_PROPERTY_DEFINITION_ID
Value of "{D32E4F69-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionId ClassDescription.

See Also:
Constant Field Values

GLOBAL_PROPERTY_DEFINITION_INTEGER32

public static final java.lang.String GLOBAL_PROPERTY_DEFINITION_INTEGER32
Value of "{D32E4F6A-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionInteger32 ClassDescription.

See Also:
Constant Field Values

GLOBAL_PROPERTY_DEFINITION_OBJECT

public static final java.lang.String GLOBAL_PROPERTY_DEFINITION_OBJECT
Value of "{D32E4F6B-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinition ClassDescription.

See Also:
Constant Field Values

GLOBAL_PROPERTY_DEFINITION_STRING

public static final java.lang.String GLOBAL_PROPERTY_DEFINITION_STRING
Value of "{D32E4F6C-AFB2-11D2-8BD6-00E0290F729A}"; specifies a GlobalPropertyDefinitionString ClassDescription.

See Also:
Constant Field Values

REFERENTIAL_CONTAINMENT_RELATIONSHIP

public static final java.lang.String REFERENTIAL_CONTAINMENT_RELATIONSHIP
Value of "{01A3A8CE-7AEC-11D1-A31B-0020AF9FBB1C}"; specifies a ReferentialContainmentRelationship ClassDescription.

See Also:
Constant Field Values

DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP

public static final java.lang.String DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP
Value of "{D32E4F77-AFB2-11D2-8BD6-00E0290F729A}"; specifies a DynamicReferentialContainmentRelationship ClassDescription.

See Also:
Constant Field Values

PUBLISH_SUBSIDIARY_FOLDER_OWNER

public static final java.lang.String PUBLISH_SUBSIDIARY_FOLDER_OWNER
Value of "{A1B237AD-0C25-4AFC-BE07-B3581DB20F11}"; specifies a PublishSubsidiaryFolderOwner ClassDescription.

See Also:
Constant Field Values

STRING_LOOKUP

public static final java.lang.String STRING_LOOKUP
Value of "{65CC2041-96D5-4FB9-88F1-8C568B29E4CD}"; specifies a StringLookup ClassDescription.

See Also:
Constant Field Values

SCENARIO_DEFINITION

public static final java.lang.String SCENARIO_DEFINITION
Value of "{902C0C1F-65DC-4925-B8FA-B4ECA4AD752A}"; specifies a ScenarioDefinition ClassDescription (for Process Engine scenario definition documents).

See Also:
Constant Field Values

SIMULATION

public static final java.lang.String SIMULATION
Value of "{193E5683-C724-4C3B-8D55-F4091B9B7222}"; specifies a Simulation ClassDescription (for Process Engine simulation documents).

See Also:
Constant Field Values

AUDIT_DEFINITION

public static final java.lang.String AUDIT_DEFINITION

Not Implemented in CS Java Connector v3.0.

Value of "{B834E360-DFE6-4D53-B029-1EFC3CCE1DB1}"; specifies an AuditDefinition ClassDescription.

See Also:
Constant Field Values

AUDIT_CONFIGURATION_EVENT

public static final java.lang.String AUDIT_CONFIGURATION_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{3A08ED68-73EB-4251-BBC3-1EF64BDF7D04}"; specifies an AuditConfigurationEvent ClassDescription.

See Also:
Constant Field Values

CANCEL_CHECKOUT_EVENT

public static final java.lang.String CANCEL_CHECKOUT_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{38B66F78-35E1-441C-8095-D91F11DFCA59}"; specifies a CancelCheckoutEvent ClassDescription.

See Also:
Constant Field Values

CHANGE_CLASS_EVENT

public static final java.lang.String CHANGE_CLASS_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{B3E5C65E-A01E-4BBD-ABCA-99D481677016}"; specifies a ChangeClassEvent ClassDescription.

See Also:
Constant Field Values

CHANGE_STATE_EVENT

public static final java.lang.String CHANGE_STATE_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{980A014B-5DFB-4D07-AD3B-D504C04AD469}"; specifies a ChangeStateEvent ClassDescription.

See Also:
Constant Field Values

CHECKIN_EVENT

public static final java.lang.String CHECKIN_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{C2CE40E5-2033-444E-BD76-3D523964D520}"; specifies a CheckinEvent ClassDescription.

See Also:
Constant Field Values

CHECKOUT_EVENT

public static final java.lang.String CHECKOUT_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{BD3EA56E-02D1-4B5F-AA44-5FBE549FD9D5}"; specifies a CheckoutEvent ClassDescription.

See Also:
Constant Field Values

CLASSIFY_COMPLETE_EVENT

public static final java.lang.String CLASSIFY_COMPLETE_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{DBDF9C0E-F870-4BE9-9D51-60B33C7AD3E8}"; specifies a ClassifyCompleteEvent ClassDescription.

See Also:
Constant Field Values

CREATION_EVENT

public static final java.lang.String CREATION_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{01231877-2806-4B03-AC08-E14AF1A638AC}"; specifies a CreationEvent ClassDescription.

See Also:
Constant Field Values

CUSTOM_EVENT

public static final java.lang.String CUSTOM_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{05C3A286-B4AD-4E39-87E3-978901E29FE8}"; specifies a CustomEvent ClassDescription.

See Also:
Constant Field Values

DELETION_EVENT

public static final java.lang.String DELETION_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{0DA61E9D-106C-42A8-A2A1-2531EFC233D3}"; specifies a DeletionEvent ClassDescription.

See Also:
Constant Field Values

DEMOTE_VERSION_EVENT

public static final java.lang.String DEMOTE_VERSION_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{00185CB3-5661-420A-BFB0-08B6D1B20B56}"; specifies a DemoteVersionEvent ClassDescription.

See Also:
Constant Field Values

EVENT

public static final java.lang.String EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{63A15878-F36A-4902-A6EA-E31C1721C1F2}"; specifies an Event ClassDescription.

See Also:
Constant Field Values

FILE_EVENT

public static final java.lang.String FILE_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{FD9E4663-4EA5-4086-A4A1-8D545F1031A3}"; specifies a FileEvent ClassDescription.

See Also:
Constant Field Values

GET_CONTENT_EVENT

public static final java.lang.String GET_CONTENT_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{4C533A99-F11D-474B-839C-E0C4751AD05C}"; specifies a GetContentEvent ClassDescription.

See Also:
Constant Field Values

GET_OBJECT_EVENT

public static final java.lang.String GET_OBJECT_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{1382A379-824B-4D44-8F30-DBE11491E504}"; specifies a GetObjectEvent ClassDescription.

See Also:
Constant Field Values

OBJECT_CHANGE_EVENT

public static final java.lang.String OBJECT_CHANGE_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{FF430BE3-6019-4464-B87C-53CDD9F01BBB}"; specifies an ObjectChangeEvent ClassDescription.

See Also:
Constant Field Values

PROMOTE_VERSION_EVENT

public static final java.lang.String PROMOTE_VERSION_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{54768F83-D902-4C22-9DD5-55AA3279772E}"; specifies a PromoteVersionEvent ClassDescription.

See Also:
Constant Field Values

QUERY_EVENT

public static final java.lang.String QUERY_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{6F9D0E77-9185-4A6C-ADE9-808DF5E0ED10}"; specifies a QueryEvent ClassDescription.

See Also:
Constant Field Values

RETRIEVAL_EVENT

public static final java.lang.String RETRIEVAL_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{FB0D700B-3723-44B0-B2E8-A511410C643C}"; specifies a RetrievalEvent ClassDescription.

See Also:
Constant Field Values

UNFILE_EVENT

public static final java.lang.String UNFILE_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{5F226A05-E9EB-44E7-B86C-25786AA7C1A5}"; specifies an UnfileEvent ClassDescription.

See Also:
Constant Field Values

UPDATE_EVENT

public static final java.lang.String UPDATE_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{A10C9B4E-1917-45A9-91E9-29D346637273}"; specifies an UpdateEvent ClassDescription.

See Also:
Constant Field Values

UPDATE_SECURITY_EVENT

public static final java.lang.String UPDATE_SECURITY_EVENT

Not Implemented in CS Java Connector v3.0.

Value of "{4D8B6222-E3A6-4301-AD2B-639B1C8FDA9B}"; specifies an UpdateSecurityEvent ClassDescription.

See Also:
Constant Field Values

MARKING

public static final java.lang.String MARKING

Not Implemented in CS Java Connector v3.0.

Value of "{393EE9AC-9A7F-43A9-BB15-37125F096A7C}"; specifies a Marking ClassDescription.

See Also:
Constant Field Values

MARKING_SET

public static final java.lang.String MARKING_SET

Not Implemented in CS Java Connector v3.0.

Value of "{82ACC971-7A17-4E8C-9A90-4DDCAF7D7C30}"; specifies a MarkingSet ClassDescription.

See Also:
Constant Field Values
Method Detail

getPropertyDescriptions

public PropertyDescriptions getPropertyDescriptions()
Returns all property descriptions for this ClassDescription object. (This method is a shortcut to the ObjectStore interface's getPropertyDescriptions method with this ClassDescription object as an argument.)

Note that a particular Property Description may exhibit property value differences depending on the ClassDescription or ObjectStore object from which the Property Description was obtained. Such programmatic discrepancies can occur because of the override rules inherent in Content Services' administration of property descriptions and classes. For further explanation, see the "Properties" section in the CS Java Connector Developer's Guide.

Returns:
A PropertyDescriptions collection that contains all the property descriptions for this ClassDescription object.


getPropertyDescriptions

public PropertyDescriptions getPropertyDescriptions(boolean getAll)
Returns all property descriptions for this ClassDescription object.

Parameters:
getAll - Requires a boolean value; however, the value is ignored by the CS Java Connector.

Returns:
A PropertyDescriptions collection that contains the requested property descriptions for this ClassDescription object.


getPropertyDescriptionsXML

public java.lang.String getPropertyDescriptionsXML(java.lang.String[] propNames)
Returns a string in XML that represents the requested property descriptions for this ClassDescription object. If the propNames parameter is null or the array is empty, this method returns all property descriptions for this ClassDescription object. If the array includes property descriptions that do not exist for this ClassDescription object, those property descriptions are ignored (no exception is thrown).

Parameters:
propNames - A String array whose elements specify the symbolic names of the property descriptions to retrieve. If null or an empty array, retrieves all property descriptions. However, if you pass in a null, you must first explicitly cast it to a String[] to avoid a compilation error.

Returns:
A String containing an XML representation of the requested property descriptions for this ClassDescription object.

getPropertyDescriptionsXML

public java.lang.String getPropertyDescriptionsXML(java.lang.String[] propNames,
                                                   boolean getAll)
Returns a string in XML that represents the requested property descriptions for this ClassDescription object.

If the propNames parameter is null or the array is empty, this method returns all property descriptions for this ClassDescription object. If the array includes property descriptions that do not exist for this ClassDescription object, those property descriptions are ignored (no exception is thrown).

Parameters:
propNames - A String array whose elements specify the symbolic names of the property descriptions to retrieve. If null or an empty array, retrieves all property descriptions. However, if you pass in a null, you must first explicitly cast it to a String[] to avoid a compilation error.

getAll - Requires a boolean value; however, the value is ignored by the CS Java Connector.

Returns:
A String containing an XML representation of the requested property descriptions for this ClassDescription object.

getDefaultPermissions

public Permissions getDefaultPermissions()
Retrieves the default permissions for an object of this class. Use this method when creating an object to determine if the default permissions are appropriate for your application.

Returns:
A Permissions collection, the elements of which specify the default basic object permissions for objects of this ClassDescription.


getDefaultPermissions

public Permissions getDefaultPermissions(java.lang.String collectionType)

Not Implemented in CS Java Connector v3.0.

Retrieves the default permissions of the specified type for an object of this class. Use this method when creating an object to determine if the default permissions are appropriate for your application. Specify the type of permissions (either basic object or audit) to return in collectionType. *

Parameters:
collectionType - A String that is the name of a property whose value is a collection of Content Services Permission objects. Use Property.PERMISSIONS or Property.AUDIT_PERMISSIONS for basic object or audit permissions.

Returns:
A Permissions collection, the elements of which specify the default permissions of the specified type for objects of this ClassDescription.


getDefaultPermissionsXML

public java.lang.String getDefaultPermissionsXML()
Retrieves a string that represents the default permissions for an object of this class. Use this method when creating an object to determine if the default permissions are appropriate for your application. Note that the returned string represents basic object permissions (i.e., an object's Permissions property).

Returns:
A String in XML containing a representation of a Permissions collection, the elements of which specify the default basic object permissions for objects of this ClassDescription.


isInstantiableByUser

public boolean isInstantiableByUser()
Specifies whether the current user has the appropriate access rights to create a new object of this class.

Returns:
true if the user can create an instance of this class, otherwise false.

isSubclassOf

public boolean isSubclassOf(java.lang.String className)

Not Implemented in CS Java Connector v3.0.

Returns true if this ClassDescription object is the specified class or is a subclass of the specified class.

Parameters:
className - A String that specifies the class to compare; can be either the symbolic name for the class or its class ID.
Returns:
true if this ClassDescription object is className or is a subclass of className, otherwise false.

getAuditDefinitions

public AuditDefinitions getAuditDefinitions()
Deprecated. Use getAuditDefinitions(boolean incInherited).

Not Implemented in CS Java Connector v3.0.


getAuditDefinitions

public AuditDefinitions getAuditDefinitions(boolean incInherited)

Not Implemented in CS Java Connector v3.0.

Returns a collection of AuditDefinition objects defined for this ClassDescription object. If this class does not support auditing or if the class has no audit definitions defined, this method returns an empty collection. (Note that if an object has an AuditedEvents property, it belongs to a class that supports auditing.)

To return all audit definitions defined for the class, including those inherited from its superclass, set the incInherited parameter to true; otherwise, only those audit definitions that are defined directly for the class will be returned. (Note that if the returned collection includes inherited audit definitions, there can more than one audit definition for a specific audit event type returned. For example, if both the class and its superclass have an audit definition defined for the CheckinEvent and the one for the superclass is set to include subclasses, both audit definitions will be returned.)

Parameters:
incInherited - A boolean that specifies whether the returned collection should include audit definitions inherited from this ClassDescription object's superclass (true) or not (false).
Returns:
An AuditDefinitions collection containing any AuditDefinition objects defined for this ClassDescription object.

getRegisteredEventsXML

public java.lang.String getRegisteredEventsXML()

Not Implemented in CS Java Connector v3.0.

Returns a string in XML that provides information on any audit definitions that are defined for this ClassDescription object, including inherited audit definitions. If this class does not support auditing, there will be no audit definitions in the returned XML. (Note that if an object has an AuditedEvents property, it belongs to a class that supports auditing.)

If the returned string includes inherited audit definitions, note that there can more than one audit definition for a specific audit event type returned. For example, if both the class and its superclass have an audit definition defined for the CheckinEvent and the one for the superclass is set to include subclasses, both audit definitions will be returned.

Returns:
A String in XML that provides information on any audit definitions that are defined for this ClassDescription object. For documentation that describes the XML schema used to generate the string, refer to Schemas in the FileNet P8 Developer's Roadmap.

FileNet Content Services
Java Connector v3.0