com.filenet.rm.api
Interface RecordFolder
All Superinterfaces:
ActivableObject, com.filenet.wcm.api.BaseObject, ClosableObject, DisposableObject, DispositionAllocatableObject, com.filenet.wcm.api.Folder, com.filenet.wcm.api.GettableObject, HoldableObject, com.filenet.wcm.api.LockableObject, com.filenet.wcm.api.ReadableMetadataObject, com.filenet.wcm.api.ReadableSecurityObject, RMFolder, RMObject, RMRecordContainer, RMRecordFolderContainer, java.io.Serializable, com.filenet.wcm.api.ValueObject, VitalableObject, com.filenet.wcm.api.WorkflowTarget, com.filenet.wcm.api.WriteableMetadataObject, com.filenet.wcm.api.WriteableSecurityObject
- public interface RecordFolder
- extends RMRecordContainer, RMRecordFolderContainer, HoldableObject, ActivableObject, ClosableObject, VitalableObject, DispositionAllocatableObject, DisposableObject
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 |
---|---|
addVolume(com.filenet.wcm.api.Properties volumeProps,com.filenet.wcm.api.Permissions volumeACLs)
Creates a
Volume object within this RecordFolder object using the
specified property and permission values.
|
|
addVolumeWithName(com.filenet.wcm.api.Properties aVolumeProps,com.filenet.wcm.api.Permissions aVolumeACLs)
Adds the Volume object within this instance of a RecordFolder object.
|
|
getActiveVolume()
Returns the
Volume object that is currently active in this RecordFolder
object.
|
|
getLastCreatedVolume()
Returns the
Volume object that was most recently created within this
RecordFolder object.
|
|
|
move(RMFolder aoDestinationFolder,java.lang.String asReasonForRelocation,DispositionSchedule aoDispositionSchedule)
Moves this
RecordFolder object to a specified record category or a record folder.
|
Methods inherited from interface com.filenet.rm.api.RMRecordContainer |
---|
canDeclare, clearDispositionSchedule, declare, declare, declare, declare, declareAllVersions, declareAllVersions, declareAllVersions, declareAllVersions, declareAndClassify, declareAndClassify, delete, getPatternBaseName, getPatternBaseName, getPatternBaseName, getPatternBaseName, setProperties, validateCloseProperty, validateInactiveProperty |
Methods inherited from interface com.filenet.rm.api.RMRecordFolderContainer |
---|
addRecordFolder, addRecordFolder, getPatternBaseName, getPatternBaseName, getPatternBaseName, getPatternBaseName |
Methods inherited from interface com.filenet.rm.api.HoldableObject |
---|
getAllChildsOnHold, getAssociatedHolds, getParentsOnHold, hold, isAnyChildonHold, isAnyParentOnHold, isOnHold, unHold |
Methods inherited from interface com.filenet.rm.api.ActivableObject |
---|
getInActiveParents, inActivate, isAnyParentInActive, isInActive |
Methods inherited from interface com.filenet.rm.api.ClosableObject |
---|
close, getClosedParents, isAnyParentClosed, isClosed, isReOpened, reOpen |
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 |
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 |
Methods inherited from interface com.filenet.rm.api.VitalableObject |
---|
executeVital, isVital, setVital, updateVitalStatus |
Methods inherited from interface com.filenet.rm.api.DispositionAllocatableObject |
---|
allocateDisposalSchedule, applyDisposalScheduleInheritance, getAssociatedDisposalSchedule, registerExternalEvent |
Method Detail
addVolume
- Volume addVolume(com.filenet.wcm.api.Properties volumeProps,
- com.filenet.wcm.api.Permissions volumeACLs)
- throws RMException
Parameters:
volumeProps
- A Properties
collection containing the property values
to be used in creating the new volume. volumeACLs
- A Permissions
collection containing the permission values
to be used in creating the new volume. Throws:
RMException
- If a Records Manager error occurs. addVolumeWithName
- Volume addVolumeWithName(com.filenet.wcm.api.Properties aVolumeProps,
- com.filenet.wcm.api.Permissions aVolumeACLs)
- throws RMException
Adds the Volume object within this instance of a RecordFolder object. Specify the
properties and permissions as input parameters. The volume name can be specified
in the properties object, or it is generated by the RM API.
Parameters:
aVolumeProps
- A Properties
collection containing the property values
to be used in creating the new volume. aVolumeACLs
- A Permissions
collection containing the permission values
to be used in creating the new volume. Returns:
A Volume object that has been created.
Throws:
RMException
- If this instance of RecordFolder is a Physical
Container, a Volume object cannot be added to the Physical Container. RMException
- In case of any error, an RMException is thrown. getActiveVolume
- Volume getActiveVolume()
- throws RMException
Returns the
Volume
object that is currently active in this RecordFolder
object.
Returns:
A
Volume
object. If no active volume is found, this method returns null. Throws:
RMException
- If a Records Manager error occurs. move
- void move(RMFolder aoDestinationFolder,
- java.lang.String asReasonForRelocation,
- DispositionSchedule aoDispositionSchedule)
- throws RMException
Moves this
RecordFolder
object to a specified record category or a record folder.
Parameters:
aoDestinationFolder
- An RMFolder
object representing the record category or
folder to which this object is to be moved. asReasonForRelocation
- A String
specifying the reason
this object is being moved. aoDispositionSchedule
- The DispositionSchedule
object that represents the
disposition schedule to be associated with this object after it is moved. Throws:
RMException
- If a Records Manager error occurs. getLastCreatedVolume
- Volume getLastCreatedVolume()
- throws RMException
Returns the
Volume
object that was most recently created within this
RecordFolder
object.
Returns:
A
Volume
object representing the newest volume within this object. Throws:
RMException
- If a Records Manager error occurs.
Volume
object within thisRecordFolder
object using the specified property and permission values.