public interface Dispositionable
Modifier and Type | Method and Description |
---|---|
void |
completePhaseExecution(java.util.Date proposedPhaseExecutionDate,
boolean transitionToNextPhase)
Attempts to complete the currently executing phase for this entity.
|
void |
destroy()
Performs destruction of the associated entity and any hierarchical children.
|
void |
destroy(boolean doValidation)
Performs destruction of the associated entity and any hierarchical children.
|
void |
executeInterimTransferUsingExternalExport(Location newLocation,
ExternalExport externalExport,
boolean doValidation)
The entity and all it its hierarchical children are exported using the given external export interface
instance and then all electronic content is then deleted from the record manager repositories.
|
void |
executeInterimTransferUsingP8_XML(Location newLocation)
The metadata and content associated with this entity and all of it hierarchical children are
exported as XML files to the local file system and then all electronic content is then deleted
from the record manager repositories.
|
void |
exportUsingExternalExport(ExternalExport externalExport,
boolean doValidation)
Exports the metadata and any content of this entity and of its hierarchical children
Using the provided external export mechanism.
|
void |
exportUsingP8_XML()
Exports the metadata and any content of this entity and of its hierarchical children as external XML files based on the
legacy P8 Content Engine-3.x export XML schema.
|
java.util.List<BulkItemResult> |
initiateDisposition(java.lang.Object vwSession)
Initiates disposition on this entity and its applicable hierarchical children
by attempting to launch the appropriate phase workflow(s).
|
boolean |
isReadyForInitiateDisposition()
Indicates whether or not this
Dispositionable
instance is ready for initiation of its next
disposition step. |
void |
resetDispositionData()
Re-initializes any disposition-related state
on the associated entity.
|
void |
resetVitalData()
Re-initializes any vital review-related state
on the associated entity.
|
void |
review(RMProperties reviewProps)
Updates the review state of this entity based on the contents of the given
RMProperties collection. |
void |
transferUsingExternalExport(ExternalExport externalExport,
boolean doValidation)
Exports the metadata and any content of this entity and of its hierarchical children
using the given external export interface instance.
|
void |
transferUsingP8_XML()
Exports the metadata and any content of this entity and of its hierarchical children as external XML files based on the
legacy P8 Content Engine-3.x export schema.
|
void |
updatePhaseDataOnEntity()
Recalculates the currently executing phase data for this entity and updates
the entity accordingly.
|
void |
validateForDispositionExport()
Performs necessary disposition-related state validation for
export and transfer purposes.
|
void resetDispositionData()
void resetVitalData()
boolean isReadyForInitiateDisposition()
Dispositionable
instance is ready for initiation of its next
disposition step.true
if this instance is ready;
false
otherwise.void completePhaseExecution(java.util.Date proposedPhaseExecutionDate, boolean transitionToNextPhase)
proposedPhaseExecutionDate
- a user-specified execution date/time for
the current phase.transitionToNextPhase
- true
to transition the
entity to the next phase of its
effective disposition schedule.API_CANNOT_COMPLETE_DISPPHASE_ON_REOPENED_CONTAINER
- if container has been reopened.API_CANNOT_COMPLETE_DISPPHASE_CPED_NOT_READY
- due to in-eligible CurrentPhaseExecutionDate or CurrentPhaseExecutionStatus values.API_CANNOT_COMPLETE_DISPPHASE_INVALID_PROPOSED_CPED
- for a null or in-eligible proposed phase execution date.void destroy()
Either a "hard" or "logical" deletion is performed on the entity (and its
hierarchical children) based on
the current state of its containing FilePlan
's RetainMetadata
property.
API_DESTROY_FAILURE_CHILD_WITH_DIFF_RETENTION
- if any hierarchical child is currently involved in an active disposition phase.API_DISPOSITION_SCHEDULE_HAS_CHANGED
- if the entity's schedule or current phase has been modified.API_DISPOSITION_ERROR_WORKFLOW_NOT_STARTED
- if the corresponding workflow step has not yet started.API_DISPOSITION_ERROR_PHASE_HAS_CHANGED
- if the entity's current phase is not associated with a destroy action.API_DISPOSITION_ERROR_BAD_CURRENT_PHASE_EXEC_DATE
- if the entity current phase has an ineligible "Current Phase Execution Date" property value.API_DISPOSITION_ERROR_INVALID_ACTION_TYPE
- if the entity's current action type mis-matches with that of its current phase.API_DISPOSITION_ERROR_DUE_TO_HOLD
- if the entity or any hierarchical child is currently on hold.API_DISPOSITION_ERROR_IMPROPER_CUTOFFINHERIT_VALUE
- if a problem occurs during destroy processing of a multi-filed record.void destroy(boolean doValidation)
FOR IBM INTERNAL USE ONLY!
Either a "hard" or "logical" deletion is performed on the entity (and its
hierarchical children) based on
the current state of its containing FilePlan
's RetainMetadata
property.
doValidation
- true
to perform disposition validation.void exportUsingP8_XML()
API_DISPOSITION_SCHEDULE_HAS_CHANGED
- if the entity's schedule or current phase has been modified.API_DISPOSITION_ERROR_WORKFLOW_NOT_STARTED
- if the corresponding workflow step has not yet started.API_DISPOSITION_ERROR_PHASE_HAS_CHANGED
- if the entity's current phase is not associated with an export action.API_DISPOSITION_ERROR_BAD_CURRENT_PHASE_EXEC_DATE
- if the entity current phase has an ineligible "Current Phase Execution Date" property value.API_DISPOSITION_ERROR_INVALID_ACTION_TYPE
- if the entity's current action type mis-matches with that of its current phase.API_DISPOSITION_ERROR_DUE_TO_HOLD
- if the entity or any hierarchical child is currently on hold.API_DISPOSITION_ERROR_DUE_TO_REOPENED_CONTAINER
- if the entity has been reopened.API_EXPORT_FILESYSTEM_DESTINATION_PATH_INVALID
- if the entity's CurrentPhaseExportDestination property is null or blank.void exportUsingExternalExport(ExternalExport externalExport, boolean doValidation)
FOR IBM INTERNAL USE ONLY!
externalExport
- an ExternalExport
instance that the JARM export
logic can call upon to perform any necessary export of the
Dispositionable
item.doValidation
- true
to perform disposition validation.void executeInterimTransferUsingP8_XML(Location newLocation)
For any physical entity involved in this interim transfer process, its "Location" and "Home Location"
properties are updated to the newLocation
input parameter.
newLocation
- a Location
instance that defines the location where content
is interim transferred.API_DISPOSITION_SCHEDULE_HAS_CHANGED
- if the entity's schedule or current phase has been modified.API_DISPOSITION_ERROR_WORKFLOW_NOT_STARTED
- if the corresponding workflow step has not yet started.API_DISPOSITION_ERROR_PHASE_HAS_CHANGED
- if the entity's current phase is not associated with an interim transfer action.API_DISPOSITION_ERROR_BAD_CURRENT_PHASE_EXEC_DATE
- if the entity current phase has an ineligible "Current Phase Execution Date" property value.API_DISPOSITION_ERROR_INVALID_ACTION_TYPE
- if the entity's current action type mis-matches with that of its current phase.API_DISPOSITION_ERROR_DUE_TO_HOLD
- if the entity or any hierarchical child is currently on hold.API_DISPOSITION_ERROR_DUE_TO_REOPENED_CONTAINER
- if the entity has been reopened.API_EXPORT_FILESYSTEM_DESTINATION_PATH_INVALID
- if the entity's CurrentPhaseExportDestination property is null or blank.void executeInterimTransferUsingExternalExport(Location newLocation, ExternalExport externalExport, boolean doValidation)
FOR IBM INTERNAL USE ONLY!
For any physical entity involved in this interim transfer process, its "Location" and "Home Location"
properties are updated to the newLocation
input parameter.
newLocation
- a Location
instance that defines the location where content
is interim transferred.externalExport
- an ExternalExport
instance that the JARM interim transfer
logic can call upon to perform any necessary export of the
Dispositionable
item.doValidation
- true
to perform disposition validation.void transferUsingP8_XML()
FilePlan
's RetainMetadata
property.API_DISPOSITION_SCHEDULE_HAS_CHANGED
- if the entity's schedule or current phase has been modified.API_DISPOSITION_ERROR_WORKFLOW_NOT_STARTED
- if the corresponding workflow step has not yet started.API_DISPOSITION_ERROR_PHASE_HAS_CHANGED
- if the entity's current phase is not associated with an interim transfer action.API_DISPOSITION_ERROR_BAD_CURRENT_PHASE_EXEC_DATE
- if the entity current phase has an ineligible "Current Phase Execution Date" property value.API_DISPOSITION_ERROR_INVALID_ACTION_TYPE
- if the entity's current action type mis-matches with that of its current phase.API_DISPOSITION_ERROR_DUE_TO_HOLD
- if the entity or any hierarchical child is currently on hold.API_DISPOSITION_ERROR_DUE_TO_REOPENED_CONTAINER
- if the entity has been reopened.void transferUsingExternalExport(ExternalExport externalExport, boolean doValidation)
FilePlan
's RetainMetadata
property.externalExport
- an ExternalExport
instance that the JARM transfer
logic can call upon to perform any necessary export of the
Dispositionable
item.doValidation
- true
to perform disposition validation.void review(RMProperties reviewProps)
RMProperties
collection.
This RMProperties
collection typically contains values for the following
review-related disposition properties:
reviewProps
- a RMProperties
collection containing
review-related property values to apply to this entity.API_DISPOSITION_SCHEDULE_HAS_CHANGED
- if the entity's schedule or current phase has been modified.API_DISPOSITION_ERROR_WORKFLOW_NOT_STARTED
- if the corresponding workflow step has not yet started.API_DISPOSITION_ERROR_PHASE_HAS_CHANGED
- if the entity's current phase is not associated with an interim transfer action.API_DISPOSITION_ERROR_BAD_CURRENT_PHASE_EXEC_DATE
- if the entity current phase has an ineligible "Current Phase Execution Date" property value.API_DISPOSITION_ERROR_INVALID_ACTION_TYPE
- if the entity's current action type mis-matches with that of its current phase.API_DISPOSITION_ERROR_DUE_TO_HOLD
- if the entity or any hierarchical child is currently on hold.java.util.List<BulkItemResult> initiateDisposition(java.lang.Object vwSession)
vwSession
- the P8 Process Engine API filenet.vw.api.VWSession
object to use.BulkItemResult
instances representing the
success/failure of any entities for which initiate disposition
was attempted.void updatePhaseDataOnEntity()
void validateForDispositionExport()
© Copyright IBM Corp. 2010, 2013. All Rights Reserved.