public interface RecordFolder extends RMRecordContainer, RMRecordFolderContainer, HoldableObject, ActivableObject, ClosableObject, VitalableObject, DispositionAllocatableObject, DisposableObject
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
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
Modifier and Type | Method and Description |
---|---|
Volume |
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. |
Volume |
addVolumeWithName(com.filenet.wcm.api.Properties aVolumeProps,
com.filenet.wcm.api.Permissions aVolumeACLs)
Adds the Volume object within this instance of a RecordFolder object.
|
Volume |
getActiveVolume()
Returns the
Volume object that is currently active in this RecordFolder
object. |
Volume |
getLastCreatedVolume()
Returns the
Volume object that was most recently created within this
RecordFolder object. |
void |
move(RMFolder aoDestinationFolder,
java.lang.String asReasonForRelocation,
DispositionSchedule aoDispositionSchedule)
Moves this
RecordFolder object to a specified record category or a record folder. |
canDeclare, clearDispositionSchedule, declare, declare, declare, declare, declareAllVersions, declareAllVersions, declareAllVersions, declareAllVersions, declareAndClassify, declareAndClassify, delete, getPatternBaseName, getPatternBaseName, getPatternBaseName, getPatternBaseName, setProperties, validateCloseProperty, validateInactiveProperty
addRecordFolder, addRecordFolder, getPatternBaseName, getPatternBaseName, getPatternBaseName, getPatternBaseName
getAllChildsOnHold, getAssociatedHolds, getParentsOnHold, hold, isAnyChildonHold, isAnyParentOnHold, isOnHold, unHold
getInActiveParents, inActivate, isAnyParentInActive, isInActive
close, getClosedParents, isAnyParentClosed, isClosed, isReOpened, reOpen
getAllAllowedContaineeType, getAllAllowedContaineeType, getAllowedContainee, getAllowedContaineeType, getContainees, getContaineesXML, getDeletedObjects, getDeletedObjectsIds, getFolderType, getLevel, getPattern, isMinimumMetadataRetained
getObjectStore, getRMDeclassificationOffset, getRMEntityType, getRMImplementationType, registerExternalEvent, setState
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
getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML
setPermissions, setPermissions
getAccessMask, getPermissions, getPermissions
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
extendLock, extendLock, isLocked, lock, unlock, unlock
executeVital, isVital, setVital, updateVitalStatus
allocateDisposalSchedule, applyDisposalScheduleInheritance, getAssociatedDisposalSchedule, registerExternalEvent
clearDispositionData, clearVitalData, completePhaseExecution, completePhaseExecution, destroy, destroy, destroyWithoutSchedule, executeInterimTransfer, executeInterimTransferWithTransferAPI, executeInterimTransferWithTransferAPI, export, exportWithTransferAPI, exportWithTransferAPI, initiateDisposition, initiateDisposition, recalculateCuttOff, review, setIsExportedBeforeDestroy, transfer, updatePhaseDataOnEntity, updatePhaseDataOnEntity
Volume addVolume(com.filenet.wcm.api.Properties volumeProps, com.filenet.wcm.api.Permissions volumeACLs) throws RMException
Volume
object within this RecordFolder
object using the
specified property and permission values.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.RMException
- If a Records Manager error occurs.Volume addVolumeWithName(com.filenet.wcm.api.Properties aVolumeProps, com.filenet.wcm.api.Permissions aVolumeACLs) throws RMException
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.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.Volume getActiveVolume() throws RMException
Volume
object that is currently active in this RecordFolder
object.Volume
object. If no active volume is found, this method returns null.RMException
- If a Records Manager error occurs.void move(RMFolder aoDestinationFolder, java.lang.String asReasonForRelocation, DispositionSchedule aoDispositionSchedule) throws RMException
RecordFolder
object to a specified record category or a record folder.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.RMException
- If a Records Manager error occurs.Volume getLastCreatedVolume() throws RMException
Volume
object that was most recently created within this
RecordFolder
object.Volume
object representing the newest volume within this object.RMException
- If a Records Manager error occurs.© Copyright IBM Corp. 2003, 2013. All Rights Reserved.