com.filenet.rm.api

Interface Volume

All Superinterfaces:
ActivableObject, com.filenet.wcm.api.BaseObject, ClosableObject, DisposableObject, 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, java.io.Serializable, com.filenet.wcm.api.ValueObject, VitalableObject, com.filenet.wcm.api.WorkflowTarget, com.filenet.wcm.api.WriteableMetadataObject, com.filenet.wcm.api.WriteableSecurityObject

  1. public interface Volume
  2. extends RMRecordContainer, ClosableObject, HoldableObject, DisposableObject, ActivableObject, VitalableObject
Represents a logical sub-division of a record folder into smaller, easier-to-manage units.

You can instantiate a Volume object as follows:


Field Summary

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. void
createVolume(RecordFolder aoParent,java.lang.String volumeName,java.lang.String folderUniqueIdentifier,java.lang.String asVolClassID,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLs)
Creates a Volume object with specified properties and permissions in a RecordFolder object.
  1. void
editVolumeProperties(com.filenet.wcm.api.Properties aoProperties,java.lang.String volumeName,java.lang.String folderUniqueIdentifier,RecordFolder aoParent)
Edits the properties of the new instance of a volume that is to be created.
  1. RecordFolder
getParentRecordFolder()
Returns a reference to the parent RecordFolder object for this object.
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.ClosableObject
close, getClosedParents, isAnyParentClosed, isClosed, isReOpened, reOpen
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.DisposableObject
clearDispositionData, clearVitalData, completePhaseExecution, completePhaseExecution, destroy, destroy, destroyWithoutSchedule, executeInterimTransfer, executeInterimTransferWithTransferAPI, executeInterimTransferWithTransferAPI, export, exportWithTransferAPI, exportWithTransferAPI, initiateDisposition, initiateDisposition, recalculateCuttOff, review, setIsExportedBeforeDestroy, transfer, updatePhaseDataOnEntity, updatePhaseDataOnEntity
Methods inherited from interface com.filenet.rm.api.ActivableObject
getInActiveParents, inActivate, isAnyParentInActive, isInActive
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.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

Method Detail

createVolume

  1. void createVolume(RecordFolder aoParent,
  2. java.lang.String volumeName,
  3. java.lang.String folderUniqueIdentifier,
  4. java.lang.String asVolClassID,
  5. com.filenet.wcm.api.Properties aoProps,
  6. com.filenet.wcm.api.Permissions aoACLs)
  7. throws RMException
Creates a Volume object with specified properties and permissions in a RecordFolder object. The name of the newly created volume is specified in the asVolumeName parameter. Properties that are not specified and have default values in the Content Engine object store take the defaults. The Permissions collection contains elements for permissions to be assigned; null implies default permissions will be inherited.
Parameters:
aoParent - A RecordFolder object in which a Volume object is to be created. A RecordFolder object is the logical parent of a Volume object.
volumeName - A String array identifying the customized name that you can change for volumes.
folderUniqueIdentifier - A String representing the default generated pattern-filled volume name that is stored internally. This property is used to generate additional volume names.
asVolClassID - A String containing the class for the Volume object.
aoProps - A Properties collection containing the property values to be used in creating the new volume object.
aoACLs - A Permissions collection that specifies the access permissions for the Volume. If null, the Volume object inherits from the default instance permissions of the class.
Throws:
RMException - If asClassificationSchemeName is null or empty, an RMException is thrown.
RMException - If aoClassificationSchemeProps is null, an RMException is thrown.
RMException - If any error occurs, an RMException is thrown.

editVolumeProperties

  1. void editVolumeProperties(com.filenet.wcm.api.Properties aoProperties,
  2. java.lang.String volumeName,
  3. java.lang.String folderUniqueIdentifier,
  4. RecordFolder aoParent)
  5. throws RMException
Edits the properties of the new instance of a volume that is to be created. Adds some system properties, such as location and home location to the properties collection passed to create a volume.
Parameters:
aoProperties - A Properties collection that contains the properties to be used to create a new instance of a volume.
volumeName - A String array identifying the customized name that you can change for volumes.
folderUniqueIdentifier - A String that is the name of a new instance of a volume that is to be created.
aoParent - A RecordFolder object that is the parent RecordFolder of this new instance of a volume.
Throws:
RMException - If any error occurs, an RMException is thrown.

getParentRecordFolder

  1. RecordFolder getParentRecordFolder( )
  2. throws RMException
Returns a reference to the parent RecordFolder object for this object.
Returns:
The parent RecordFolder object for this object.
Throws:
RMException - If an error occurs, an RMException is thrown.