public interface DisposableObject extends 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
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 |
---|---|
void |
clearDispositionData()
Clears the disposition data from this object.
|
void |
clearVitalData()
Clears the vital data from this object.
|
void |
completePhaseExecution(java.util.Date aoProposedCutoffDate,
boolean abTriggerNextPhase)
Completes the currently executing phase for this object by updating the current
phase execution date metadata and cutoff metadata.
|
void |
completePhaseExecution(java.util.Date aoProposedCutoffDate,
boolean abTriggerNextPhase,
boolean abHasCutOfAction)
Completes the currently executing phase for this object by updating the current
phase execution date and cutoff properties.
|
void |
destroy(boolean abSave)
Deletes this object either logically or physically from the object store.
|
void |
destroy(boolean abSave,
boolean abUnfileRecordWithRType)
Deletes this object either logically or physically from the object store.
|
void |
destroyWithoutSchedule(boolean abSave)
Deletes this object either logically or physically from the object store without disposition schedule.
|
void |
executeInterimTransfer(RMCustomObject aoIntTransLoc)
Performs an interim transfer action on this object.
|
void |
executeInterimTransferWithTransferAPI(RMCustomObject aoIntTransLoc,
java.util.Map transferSourceContext,
java.lang.String mappingGUID,
boolean bSkipDisp)
This method performs interim transfer action on the current instance of DisposableObject.
|
void |
executeInterimTransferWithTransferAPI(RMCustomObject aoIntTransLoc,
java.lang.String mappingGUID,
boolean bSkipDisp)
This method performs interim transfer action on the current instance of DisposableObject.
|
void |
export()
Exports this object and its children to XML files that, by default, are structured according
to the Content Engine export schema.
|
void |
exportWithTransferAPI(java.util.Map transferSourceContext,
java.lang.String mappingGUID,
boolean bSkipDisp)
This method exports the given object as an XML with RM Transfer API, with the given Transfer Source Context.
|
void |
exportWithTransferAPI(java.lang.String mappingGUID,
boolean bSkipDisp)
This method exports the given object as an XML with the RM Transfer API.
|
java.util.HashMap |
initiateDisposition(filenet.vw.api.VWSession aoVWSession)
Verifies the state of this object and its available
children to launch the associated phase workflow with corresponding
entities
|
RMBulkOperationResults |
initiateDisposition(filenet.vw.api.VWSession aoVWSession,
boolean abFailOnException)
Verifies the state of this object and its available
children to launch the associated phase workflow with corresponding
entities
|
void |
recalculateCuttOff()
Recalculates the pre-cutoff data based on the schedule associated with this object
or its parent to update the entity with pre-cutoff data.
|
void |
review(com.filenet.wcm.api.Properties asProperties)
Reviews this object and updates the specified properties.
|
void |
setIsExportedBeforeDestroy(boolean abIsExported)
Sets a flag that indicates whether an export has been done on this object prior to calling destroy.
|
void |
transfer(boolean abSave)
Transfers the metadata and content for this object to the physical drive specified
by export destination metadata for the object.
|
void |
updatePhaseDataOnEntity()
Recalculates the currently executing phase data based on the schedule for this object or
its parent, and updates the metadata for this object.
|
void |
updatePhaseDataOnEntity(boolean abWithoutValidation)
Updates the current phase execution data for this object without validating the
associated schedule.
|
getObjectStore, getRMDeclassificationOffset, getRMEntityType, getRMImplementationType, registerExternalEvent, setState
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
void setIsExportedBeforeDestroy(boolean abIsExported)
destroy
method, which is called separately, is part of a
larger two-step transfer operation.abIsExported
- A boolean
value set to true
if this disposable object has been exported.void updatePhaseDataOnEntity() throws RMException
RMException
- If a Records Manager error occurs.void updatePhaseDataOnEntity(boolean abWithoutValidation) throws RMException
abWithoutValidation
- A boolean
value set to true
to update the phase execution data for
this object without validating the associated schedule.RMException
- If a Records Manager error occurs.void completePhaseExecution(java.util.Date aoProposedCutoffDate, boolean abTriggerNextPhase) throws RMException
aoProposedCutoffDate
parameter
specifies a date later than the current date, then the new date becomes the current phase execution date
to increase the span for the current phase in execution. Otherwise, this method calculates
the next phase date based on the subsequent phase to be executed and updates the
object with next phase data.aoProposedCutoffDate
- A Date
value that specifies the phase execution date.abTriggerNextPhase
- A boolean
value set to true
if the method is to
trigger the next phase.RMException
- If the aoDate
parameter is null
or if a Records Manager error occurs.void completePhaseExecution(java.util.Date aoProposedCutoffDate, boolean abTriggerNextPhase, boolean abHasCutOfAction) throws RMException
aoProposedCutoffDate
parameter
specifies a date later than the current date, then the new date becomes the current phase execution date
to increase the span for the current phase in execution. Otherwise, this method calculates
the next phase date based on the subsequent phase to be executed and updates the
object with next phase data.aoProposedCutoffDate
- A Date
value that specifies the phase execution date.abTriggerNextPhase
- A boolean
value set to true
if the method is to
trigger the next phase.abHasCutOfAction
- A boolean
value set to true
if
a cut of action is in the schedule.RMException
- If the aoDate
parameter is null
or if a Records Manager error occurs.void executeInterimTransfer(RMCustomObject aoIntTransLoc)
aoIntTransLoc
parameter.aoIntTransLoc
- An RMCustomObject
that identifies the location to which the content is
to be transferred.RMException
- If the asLocation
parameter is null
, if an
error occurs in retrieving record properties, or if a Records Manager error occurs.
This method uses RM API to do the export.void executeInterimTransferWithTransferAPI(RMCustomObject aoIntTransLoc, java.lang.String mappingGUID, boolean bSkipDisp)
aoIntTransLoc
- A custom object that represents the location object where content is
to be interim transferred .mappingGUID
- A string that represents the GUID of the Transfer Mapping Object.bSkipDisp
- A boolean to indicate whether to skip disposition schedule validation, audit and phase rollback at error.
This flag is set to true when launching workflows from UI, instead of by disposition schedules.RMException
- If asLocation is null, an RMException is thrown.RMException
- If an error occurs during retrieval of Record properties, an RMException is thrown.RMException
- If any error occurs, an RMException is thrown.void executeInterimTransferWithTransferAPI(RMCustomObject aoIntTransLoc, java.util.Map transferSourceContext, java.lang.String mappingGUID, boolean bSkipDisp)
aoIntTransLoc
- A custom object that represents the location object where content is
to be interim transferred .transferSourceContext
- A transfer source context map. The map can be created by calling
RMTransferSupport.getTransferSourceContext() API.mappingGUID
- A string that represents the GUID of the Transfer Mapping Object.bSkipDisp
- A boolean to indicate whether to skip disposition schedule validation, audit and phase rollback at error.
This flag is set to true when launching workflows from UI, instead of by disposition schedules.RMException
- If asLocation is null, an RMException is thrown.RMException
- If an error occurs during retrieval of Record properties, an RMException is thrown.RMException
- If any error occurs, an RMException is thrown.void destroy(boolean abSave) throws RMException
The isMinimumMetadataRetain property on the file plan determines whether this object and its associated metadata are deleted permanently from the object store. If the isMinimumMetadataRetained property is set to 0, this object is logically deleted. That is, the object is no longer visible in the user interface but continues to persist in the object store. If the isMinimumMetadataRetained property is set to 1, this object is completely erased from the system with only a minimum set of metadata pertaining it retained.
abSave
- This parameter is no longer used.RMException
- If a Records Manager error occurs.void destroyWithoutSchedule(boolean abSave) throws RMException
The isMinimumMetadataRetain property on the file plan determines whether this object and its associated metadata are deleted permanently from the object store. If the isMinimumMetadataRetained property is set to 0, this object is logically deleted. That is, the object is no longer visible in the user interface but continues to persist in the object store. If the isMinimumMetadataRetained property is set to 1, this object is completely erased from the system with only a minimum set of metadata pertaining it retained.
abSave
- This parameter is no longer used.RMException
- If a Records Manager error occurs.void destroy(boolean abSave, boolean abUnfileRecordWithRType) throws RMException
The isMinimumMetadataRetain property on the file plan determines whether this object and its associated metadata are deleted permanently from the object store. If the isMinimumMetadataRetained property is set to 0, this object is logically deleted. That is, the object is no longer visible in the user interface but continues to persist in the object store. If the isMinimumMetadataRetained property is set to 1, this object is completely erased from the system with only a minimum set of metadata pertaining it retained.
abSave
- This parameter is no longer used.abUnfileRecordWithRType
- A boolean
value set to true
if the RecordInfo, in the hierarchy of
current instance of RMRecordContainer, associated with a RecordType and filed elsewhere , is unfiled
from this RMRecordContainer. If the Record is filed only in this RMRecordContainer, a
DispositionConflictException exception is thrown.
If false
, the behavior is same as the destroy method
with single boolean parameter. That is,a DispositionConflictException exception
is always be thrown, for any RecordInfo in the hierarchy of this RMRecordContainer
and associated with a RecordType.RMException
- If a Records Manager error occurs.RMBulkOperationResults initiateDisposition(filenet.vw.api.VWSession aoVWSession, boolean abFailOnException) throws RMException
aoVWSession
- A VWSession
object that is used to establish a session
and log onto a Process Engine in order to launch a workflow.abFailOnException
- A boolean
value that indicates whether this method
is to stop executing if an error occurs. Set to true
if the method is to stop
executing if an error occurs. Set to false
on if the method is to continue
executing if an error occurs.RMBulkOperationResults
object that contains the IDs and
descriptions for which disposition initiation failed.RMException
- If this object or one of its children is either on hold or
not ready for disposition.java.util.HashMap initiateDisposition(filenet.vw.api.VWSession aoVWSession) throws RMException
aoVWSession
- A VWSession
object that is used to establish a session
and log onto a Process Engine in order to launch a workflow.HashMap
object that contains the IDs and
descriptions for which disposition initiation failed.RMException
- If this object or one of its children is either on hold or
not ready for disposition.void export()
To export this object to XML files that are structured according to a custom XML schema, you must specify that schema as the export format metadata for this object.
There are two types of exported files:
RMException
- If this object is not ready to be exported or if a Records Manager
error occurs.void exportWithTransferAPI(java.lang.String mappingGUID, boolean bSkipDisp)
mappingGUID
- A string that represents the GUID of the Transfer Mapping Object.bSkipDisp
- A boolean to indicate whether to skip disposition schedule validation, audit and phase rollback at error.
This flag is set to true when launching workflows from UI, instead of by disposition schedules.void exportWithTransferAPI(java.util.Map transferSourceContext, java.lang.String mappingGUID, boolean bSkipDisp)
transferSourceContext
- A transfer source context map as specified in RM Transfer API. The map
can be created by calling RMTransferSupport.getTransferSourceContext() API.mappingGUID
- A string that represents the GUID of the Transfer Mapping Object.bSkipDisp
- A boolean to indicate whether to skip disposition schedule validation, audit and phase rollback at error.
This flag is set to true when launching workflows from UI, instead of by disposition schedules.void transfer(boolean abSave)
abSave
- This parameter is no longer used.void review(com.filenet.wcm.api.Properties asProperties) throws RMException
asProperties
- A Property
collection that contains the properties to be updated.RMException
- If a Records Manager error occurs.void recalculateCuttOff()
void clearDispositionData() throws RMException
RMException
- If a Records Manager error occurs.void clearVitalData() throws RMException
RMException
- If a Records Manager error occurs.© Copyright IBM Corp. 2003, 2013. All Rights Reserved.