public interface DispositionAction extends RMCustomObject
DispositionSchedule
and its child
DispositionPhase
instances.
A specific disposition action can be obtained using the
RMFactory.DispositionAction
factory class.
A new disposition action can be created using the factory class
method RMFactory.DispositionAction.createInstance
.
The resulting new DispositionAction
instance can then be further defined
followed by an eventual call to its save
method
in order to ensure that it is persisted to its associated file plan repository.
RMFactory.DispositionAction
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getActionName()
Returns the
ActionName property value assigned to this disposition action. |
DispositionActionType |
getActionType()
Returns the
DispositionActionType for this disposition action. |
java.util.List<DispositionSchedule> |
getAssociatedDispositionSchedules()
Returns all
DispositionSchedule instances that are associated with
this disposition action. |
RMWorkflowDefinition |
getAssociatedWorkflow()
Returns the workflow definition associated with this disposition action.
|
java.lang.String |
getDescription()
Returns the
RMEntityDescription property value assigned to this disposition action. |
void |
setActionName(java.lang.String name)
Sets the
ActionName property value for this disposition action. |
void |
setAssociatedWorkflow(RMWorkflowDefinition workflow)
Defines the
RMWorkflowDefinition instance that is associated
with this disposition action. |
void |
setDescription(java.lang.String value)
Sets the
RMEntityDescription property value for this disposition action. |
delete
getAccessAllowed, getClassDescription, getClassName, getClientIdentifier, getContainedBy, getDomainType, getEntityType, getName, getObjectIdentity, getPermissions, getProperties, getRepository, isCreationPending, isPlaceholder, refresh, refresh, refresh
save, setPermissions
getAuditedEvents
java.lang.String getActionName()
ActionName
property value assigned to this disposition action.String
value.void setActionName(java.lang.String name)
ActionName
property value for this disposition action.
This name value must be unique relative to all other disposition
actions defined on the same file plan repository. Validation of
such name uniqueness does not occur until the
save
method is called.
name
- a String
value. Cannot be null
or blank.java.lang.String getDescription()
RMEntityDescription
property value assigned to this disposition action.String
value; can be null
or empty.void setDescription(java.lang.String value)
RMEntityDescription
property value for this disposition action.value
- a String
value. Can be null
or blank.DispositionActionType getActionType()
DispositionActionType
for this disposition action.
Note that the DispositionActionType
value for a
disposition action is defined during its creation process
(i.e., RMFactory.DispositionAction.createInstance(FilePlanRepository, DispositionActionType)
).
DispositionActionType
instance.RMWorkflowDefinition getAssociatedWorkflow()
RMWorkflowDefinition
instance.void setAssociatedWorkflow(RMWorkflowDefinition workflow)
RMWorkflowDefinition
instance that is associated
with this disposition action.workflow
- a RMWorkflowDefinition
instance. Cannot be null
.java.util.List<DispositionSchedule> getAssociatedDispositionSchedules()
DispositionSchedule
instances that are associated with
this disposition action.DispositionSchedule
instances. Can be empty.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.