com.filenet.rm.api

Interface RMRecordCategoryContainer

All Superinterfaces:
com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.Folder, com.filenet.wcm.api.GettableObject, com.filenet.wcm.api.LockableObject, com.filenet.wcm.api.ReadableMetadataObject, com.filenet.wcm.api.ReadableSecurityObject, RMFolder, RMObject, java.io.Serializable, com.filenet.wcm.api.ValueObject, com.filenet.wcm.api.WorkflowTarget, com.filenet.wcm.api.WriteableMetadataObject, com.filenet.wcm.api.WriteableSecurityObject
All known subinterfaces:
ClassificationScheme, RecordCategory

  1. public interface RMRecordCategoryContainer
  2. extends RMFolder
Defines the behavior of any RMFolder object that can contain a record category in the file plan hierarchy. An instance of the RMRecordCategoryContainer interface can be

Field Summary

Fields inherited from interface com.filenet.rm.api.RMObject
AGGREGATION_RECORD, AGGREGATION_RECORD_CATEGORY, AGGREGATION_RECORD_FOLDER, AGGREGATION_VOLUME, CLEAR_INHERITED_CHILDREN, INHERIT_IMMEDIATE_CHILDREN, INHERITED_CHILDREN, NON_INHERITED_CHILDREN, WORK_FLOW_STATUS_COMPLETED, WORK_FLOW_STATUS_NOT_STARTED, WORK_FLOW_STATUS_STARTED
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_AUDIT_DEFINITION, 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_SUBSCRIBED_EVENT, 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

Modifier and Type Method and Description
  1. RecordCategory
addRecordCategory(java.lang.String asRecordCategoryName,com.filenet.wcm.api.Properties aoRecordCategoryProps,com.filenet.wcm.api.Permissions aoRecordCategoryACLs)
Adds a RecordCategory object to this container object and validates the properties and permissions provided in the input parameters.
  1. java.lang.String
getPatternBaseName(int aiEntityType)
Generates a name for an entity of the specified RMType based on the naming pattern applied to that entity type.
  1. java.lang.String
getPatternBaseName(int aiEntityType,com.filenet.wcm.api.Properties aoProperties)
Generates a name for an entity of the specified RMType based on the naming pattern applied to that entity type.
  1. java.lang.String
getPatternBaseName(int aiEntityType,com.filenet.wcm.api.Properties aoProperties,java.lang.StringBuffer moEntityNameOrId)
Generates a name for an entity of the specified RMType based on the naming pattern applied to that entity type.
  1. java.lang.String
getPatternBaseName(int aiEntityType,java.lang.StringBuffer moEntityNameOrId)
Generates a name for an entity of the specified RMType based on the naming pattern applied to that entity type.
Methods inherited from interface com.filenet.rm.api.RMFolder
getAllAllowedContaineeType, getAllAllowedContaineeType, getAllowedContainee, getAllowedContaineeType, getContainees, getContaineesXML, getDeletedObjects, getDeletedObjectsIds, getFolderType, getLevel, getPattern, isMinimumMetadataRetained
Methods inherited from interface com.filenet.rm.api.RMObject
getObjectStore, getRMDeclassificationOffset, getRMEntityType, getRMImplementationType, registerExternalEvent, setState
Methods inherited from interface com.filenet.wcm.api.Folder
addSubFolder, addSubFolder, applySecurityTemplate, changeClass, delete, getContainees, getContainees, getContainees, getContainees, getContainees, getContainees, getContaineesXML, getContaineesXML, getHeadLinks, getHeadLinksXML, getParentFolder, getParentFolderXML, getPermissionsXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, move, raiseEvent
Methods inherited from interface com.filenet.wcm.api.WorkflowTarget
getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML
Methods inherited from interface com.filenet.wcm.api.WriteableSecurityObject
setPermissions, setPermissions
Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject
setProperties, setProperties
Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject
getAccessMask, getPermissions, getPermissions
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
Methods inherited from interface com.filenet.wcm.api.LockableObject
extendLock, extendLock, isLocked, lock, unlock, unlock

Method Detail

addRecordCategory

  1. RecordCategory addRecordCategory( java.lang.String asRecordCategoryName,
  2. com.filenet.wcm.api.Properties aoRecordCategoryProps,
  3. com.filenet.wcm.api.Permissions aoRecordCategoryACLs)
  4. throws RMException
Adds a RecordCategory object to this container object and validates the properties and permissions provided in the input parameters.
Parameters:
asRecordCategoryName - A String that specifies the name for the new record category.
aoRecordCategoryProps - A Properties collection that contains the properties for the new record category.
aoRecordCategoryACLs - A Permissions collection that contains the permissions for the new record category.
Returns:
The new RecordCategory object.
Throws:
RMException - If a record category cannot be added to this container object.

getPatternBaseName

  1. java.lang.String getPatternBaseName( int aiEntityType)
Generates a name for an entity of the specified RMType based on the naming pattern applied to that entity type.
Parameters:
aiEntityType - An int value that represents the RMType value of the entity for which a name is to be generated. The RMType value must represent an entity that can be a child of this container object.
Returns:
A String that represents the entity name according to the applied naming pattern. If no naming pattern is applied to the specified entity type, the method returns an empty String.

getPatternBaseName

  1. java.lang.String getPatternBaseName( int aiEntityType,
  2. java.lang.StringBuffer moEntityNameOrId)
Generates a name for an entity of the specified RMType based on the naming pattern applied to that entity type.
Parameters:
aiEntityType - An int value that represents the RMType value of the entity for which a name is to be generated. The RMType value must represent an entity that can be a child of this container object.
moEntityNameOrId - A StringBuffer whose value is to be updated by this method to indicate whether the naming pattern applies to a name or an identifier, if applicable.
Returns:
A String that represents the entity name according to the applied naming pattern. If no naming pattern is applied to the specified entity type, the method returns an empty String.

getPatternBaseName

  1. java.lang.String getPatternBaseName( int aiEntityType,
  2. com.filenet.wcm.api.Properties aoProperties)
Generates a name for an entity of the specified RMType based on the naming pattern applied to that entity type.
Parameters:
aiEntityType - An int value that represents the RMType value of the entity for which a name is to be generated. The RMType value must represent an entity that can be a child of this container object.
aoProperties - A Properties collection that the method is to use to obtain any metadata value that the must be replaced in the pattern definition String.
Returns:
A String that represents the entity name according to the applied naming pattern. If no naming pattern is applied to the specified entity type, the method returns an empty String.

getPatternBaseName

  1. java.lang.String getPatternBaseName( int aiEntityType,
  2. com.filenet.wcm.api.Properties aoProperties,
  3. java.lang.StringBuffer moEntityNameOrId)
Generates a name for an entity of the specified RMType based on the naming pattern applied to that entity type.
Parameters:
aiEntityType - An int value that represents the RMType value of the entity for which a name is to be generated. The RMType value must represent an entity that can be a child of this container object.
moEntityNameOrId - A StringBuffer whose value is to be updated by this method to indicate whether the naming pattern applies to a name or an identifier, if applicable.
aoProperties - A Properties collection that the method is to use to obtain any metadata value that the must be replaced in the pattern definition String.
Returns:
A String that represents the entity name according to the applied naming pattern. If no naming pattern is applied to the specified entity type, the method returns an empty String.