com.filenet.rm.api

Interface DispositionAllocatableObject

All Superinterfaces:
com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.ReadableMetadataObject, RMObject, java.io.Serializable, com.filenet.wcm.api.ValueObject, com.filenet.wcm.api.WriteableMetadataObject
All known subinterfaces:
RecordCategory, RecordFolder, RecordType

  1. public interface DispositionAllocatableObject
  2. extends RMObject, com.filenet.wcm.api.WriteableMetadataObject
Defines the behavior of a Records Manager object that can be be associated with a DispositionSchedule object to define the disposition process for the Records Manager object and its children. A DispositionAllocatableObject can be a RecordCategory, RecordFolder, or RecordType 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
  1. void
allocateDisposalSchedule(DispositionSchedule aoDispositionSchedule)
Associates the specified DispositionSchedule object with this object.
  1. void
applyDisposalScheduleInheritance(DispositionSchedule aoDispSchedule,int aiApplyInheritTo)
Associates a specified disposition schedule with the children of this object as indicated by the aiApplyInheritTo parameter.
  1. DispositionSchedule
getAssociatedDisposalSchedule()
Returns the DispositionSchedule object that is associated with this object.
  1. void
registerExternalEvent(java.lang.String[] asArrEventIDs,java.util.Date aoExtEventOccuranceDate)
Deprecated. Use RMBulkOperationsUtil.registerExternalEvent(RMObjectStore, String[], Date)
Methods inherited from interface com.filenet.rm.api.RMObject
getObjectStore, getRMDeclassificationOffset, getRMEntityType, getRMImplementationType, setState
Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject
setProperties, setProperties
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

Method Detail

allocateDisposalSchedule

  1. void allocateDisposalSchedule(DispositionSchedule aoDispositionSchedule)
  2. throws RMException
Associates the specified DispositionSchedule object with this object.
Parameters:
aoDispositionSchedule - The DispositionSchedule object that is to be associated wit this object.
Throws:
RMException - If a Records Manager error occurs.

getAssociatedDisposalSchedule

  1. DispositionSchedule getAssociatedDisposalSchedule( )
  2. throws RMException
Returns the DispositionSchedule object that is associated with this object.
Returns:
The associated DispositionSchedule object or null if no schedule is associated with this object.
Throws:
RMException - If a Records Manager error occurs.

registerExternalEvent

  1. void registerExternalEvent(java.lang.String[] asArrEventIDs,
  2. java.util.Date aoExtEventOccuranceDate)
  3. throws RMException
Deprecated. Use RMBulkOperationsUtil.registerExternalEvent(RMObjectStore, String[], Date)
Updates the ExternalEventOccuranceDate property for this object and any children except child objects that are volumes, if the allocated DisposalSchedule has a disposal trigger provided in the input parameter.
Specified by:
Parameters:
asArrEventIDs - A String array that contains the GUIDs of the disposal triggers.
aoExtEventOccuranceDate - A Date value that represents the external event occurrence date to be set.
Throws:
RMException - If a Records Manager error occurs.

applyDisposalScheduleInheritance

  1. void applyDisposalScheduleInheritance( DispositionSchedule aoDispSchedule,
  2. int aiApplyInheritTo)
  3. throws RMException
Associates a specified disposition schedule with the children of this object as indicated by the aiApplyInheritTo parameter.
Parameters:
aoDispSchedule - A DispositionSchedule object that represents the disposition schedule to be associated with the children of this object.
aiApplyInheritTo - A constant value to identify type of inheritance to be applied as follows:

  • If applyInheritTo is DispositionSchedule.INHERITED_CHILDREN, then disposition schedule is applied to all those entities which were inheriting the schedule from this entity.
  • If passed value for applyInheritTo is DispositionSchedule.NON_INHERITED_CHILDREN, then disposition schedule is applied to all those entities which are not inheriting the schedule from this entity from this entity
  • if passed value for applyInheritTo DispositionSchedule.NON_INHERITED_CHILDREN + DispositionSchedule.INHERITED_CHILDREN` schedule is associated to all the children (inheriting and non inheriting).
  • If passed value for applyInheritTo CLEAR_INHERITED_CHILDREN then schedule on all the child that were inheriting the previous schedule is cleared.
Throws:
RMException - If a Records Manager error occurs.