Interface RecordsManagementAction
- All Known Implementing Classes:
AddRecordTypeAction
,ApplyCustomTypeAction
,BroadcastDispositionActionDefinitionUpdateAction
,BroadcastVitalRecordDefinitionAction
,CloseRecordFolderAction
,CompleteEventAction
,CopyMoveLinkFileToBaseAction
,CopyToAction
,CreateDispositionScheduleAction
,CutOffAction
,DeclareRecordAction
,DelegateAction
,DeleteHoldAction
,DestroyAction
,EditDispositionActionAsOfDateAction
,EditHoldReasonAction
,EditReviewAsOfDateAction
,FileReportAction
,FileToAction
,FreezeAction
,LinkToAction
,MoveToAction
,OpenRecordFolderAction
,RejectAction
,RelinquishHoldAction
,RequestInfoAction
,RetainAction
,ReviewedAction
,RMActionExecuterAbstractBase
,RMDispositionActionExecuterAbstractBase
,SplitEmailAction
,TransferAction
,TransferCompleteAction
,UnCutoffAction
,UndeclareRecordAction
,UndoEventAction
,UnfreezeAction
,UnlinkFromAction
@AlfrescoPublicApi
public interface RecordsManagementAction
Record Management Action
- Author:
- Roy Wetherall
-
Method Summary
Modifier and TypeMethodDescriptionexecute
(NodeRef filePlanComponent, Map<String, Serializable> parameters) Execution of the actionGet the description of the actionSome admin-related rmActions execute against a target nodeRef which is not provided by the calling code, but is instead an implementation detail of the action.getLabel()
Get the label of the actiongetName()
Get the name of the actionGet the records management action definition.boolean
Indicates whether this is a disposition action or notboolean
Indicates whether the action is public or not
-
Method Details
-
getName
String getName()Get the name of the action- Returns:
- String action name
-
getLabel
String getLabel()Get the label of the action- Returns:
- String action label
-
getDescription
String getDescription()Get the description of the action- Returns:
- String action description
-
isDispositionAction
boolean isDispositionAction()Indicates whether this is a disposition action or not- Returns:
- boolean true if a disposition action, false otherwise
-
execute
RecordsManagementActionResult execute(NodeRef filePlanComponent, Map<String, Serializable> parameters) Execution of the action- Parameters:
filePlanComponent
- file plan component the action is executed uponparameters
- action parameters- Returns:
- The result of the executed action
-
getImplicitTargetNodeRef
NodeRef getImplicitTargetNodeRef()Some admin-related rmActions execute against a target nodeRef which is not provided by the calling code, but is instead an implementation detail of the action.- Returns:
- the target nodeRef
-
getRecordsManagementActionDefinition
RecordsManagementActionDefinition getRecordsManagementActionDefinition()Get the records management action definition.- Returns:
- The records management action definition.
- Since:
- 2.1
-
isPublicAction
boolean isPublicAction()Indicates whether the action is public or not- Returns:
true
if the action is public,false
otherwise- Since:
- 2.1
-