com.filenet.rm.api
Interface RMRecordFolderContainer
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:
- public interface RMRecordFolderContainer
- extends RMFolder
RecordFolder
objects.
The container can be either another RecordFolder
object or a
RecordCategory
object.
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 |
---|---|
addRecordFolder(java.lang.String asRecordFolderName,com.filenet.wcm.api.Properties aoRecordFolderProps,com.filenet.wcm.api.Permissions aoRecordFolderACLs)
Creates a new
RecordFolder object with the specified properties and permissions
in this container object.
|
|
addRecordFolder(java.lang.String asRecordFolderName,java.lang.String asFolderClass,com.filenet.wcm.api.Properties aoRecordFolderProps,com.filenet.wcm.api.Permissions aoRecordFolderACLs)
Creates a new
RecordFolder object with the specified properties and permissions
in this container object.
|
|
|
getPatternBaseName(int aiEntityType)
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
|
|
getPatternBaseName(int aiEntityType,com.filenet.wcm.api.Properties aoProperties)
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
|
|
getPatternBaseName(int aiEntityType,com.filenet.wcm.api.Properties aoProperties,java.lang.StringBuffer moEntityNameOrId)
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
|
|
getPatternBaseName(int aiEntityType,java.lang.StringBuffer aoEntityNameOrId)
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
|
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
addRecordFolder
- RecordFolder addRecordFolder(java.lang.String asRecordFolderName,
- com.filenet.wcm.api.Properties aoRecordFolderProps,
- com.filenet.wcm.api.Permissions aoRecordFolderACLs)
- throws RMException
Parameters:
asRecordFolderName
- A String
that contains the name for
the new RecordFolder
object. aoRecordFolderProps
- A Properties
collection that contains the property values for
the new RecordFolder
object. aoRecordFolderACLs
- A Permissions
collection that contains the permission values for
the new RecordFolder
object. Returns:
The new
RecordFolder
object that has been added to this container object. Throws:
RMException
- If a Records Manager error occurs. addRecordFolder
- RecordFolder addRecordFolder(java.lang.String asRecordFolderName,
- java.lang.String asFolderClass,
- com.filenet.wcm.api.Properties aoRecordFolderProps,
- com.filenet.wcm.api.Permissions aoRecordFolderACLs)
- throws RMException
Creates a new
RecordFolder
object with the specified properties and permissions
in this container object. The method names the new record folder
by applying the naming pattern for record folders to the name specified by the
asRecordFolderName
parameter.
NOTES
You can add a record folder to a
RecordFolder
object that is a physical record folder. You cannot add a record folder to aRecordFolder
object that is an electronic or hybrid record folder.You cannot add a record folder to a
RecordFolder
object that contains aRecordInfo
object.You cannot add a record folder to a
RecordCategory
object that contains aRecordCategory
object.
Parameters:
asRecordFolderName
- A String
that contains the name for
the new RecordFolder
object. asFolderClass
- A String
that specifies the class ID for the new
RecordFolder
object. This String
cannot be null
or empty. aoRecordFolderProps
- A Properties
collection that contains the property values for
the new RecordFolder
object. aoRecordFolderACLs
- A Permissions
collection that contains the permission values for
the new RecordFolder
object. Returns:
The new
RecordFolder
object that has been added to this container object. Throws:
RMException
- If a Records Manager error occurs. getPatternBaseName
- java.lang.String getPatternBaseName( int aiEntityType)
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
Parameters:
aiEntityType
- An int
value that specifies the type of entity
for which a name is to be generated. This parameter must specify an
RMType
value that represents a type of entity that can be
placed in this container object. Returns:
A
String
that represents the name generated according to
the naming pattern. If no pattern is defined for this container object, the
method returns an empty String
. getPatternBaseName
- java.lang.String getPatternBaseName( int aiEntityType,
- java.lang.StringBuffer aoEntityNameOrId)
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
Parameters:
aiEntityType
- An int
value that specifies the type of entity
for which a name is to be generated. This parameter must specify an
RMType
value that represents a type of entity that can be
placed in this container object. Returns:
A
String
that represents the name generated according to
the naming pattern. If no pattern is defined for this container object, the
method returns an empty String
. getPatternBaseName
- java.lang.String getPatternBaseName( int aiEntityType,
- com.filenet.wcm.api.Properties aoProperties)
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
Parameters:
aiEntityType
- An int
value that specifies the type of entity
for which a name is to be generated. This parameter must specify an
RMType
value that represents a type of entity that can be
placed in this container object. aoProperties
- A Properties
collection that contains any
metadata values that are required in the pattern definition string. Returns:
A
String
that represents the name generated according to
the naming pattern. If no pattern is defined for this container object, the
method returns an empty String
. getPatternBaseName
- java.lang.String getPatternBaseName( int aiEntityType,
- com.filenet.wcm.api.Properties aoProperties,
- java.lang.StringBuffer moEntityNameOrId)
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
Parameters:
aiEntityType
- An int
value that specifies the type of entity
for which a name is to be generated. This parameter must specify an
RMType
value that represents a type of entity that can be
placed in this container object. aoProperties
- A Properties
collection that contains any
metadata values that are required in the pattern definition string. moEntityNameOrId
- A StringBuffer
whose value this method is
to update to indicate whether the naming pattern applies to a name or an identifier. Returns:
A
String
that represents the name generated according to
the naming pattern. If no pattern is defined for this container object, the
method returns an empty String
.
RecordFolder
object with the specified properties and permissions in this container object.If this container object is a
RecordFolder
object, it must be a physical record folder. You cannot add a record folder to aRecordFolder
object that is an electronic or hybrid record folder. In addition, theRecordFolder
object cannot containRecordInfo
object.If this container object is a
RecordCategory
object, it cannot contain aRecordCategory
object.The method names the new record folder by applying the naming pattern for record folders to the name specified by the
asRecordFolderName
parameter.