Class RMActionExecuterAbstractBase
java.lang.Object
org.alfresco.repo.action.CommonResourceAbstractBase
org.alfresco.repo.action.ParameterizedItemAbstractBase
org.alfresco.repo.action.executer.ActionExecuterAbstractBase
org.alfresco.module.org_alfresco_module_rm.action.AuditableActionExecuterAbstractBase
org.alfresco.module.org_alfresco_module_rm.action.PropertySubActionExecuterAbstractBase
org.alfresco.module.org_alfresco_module_rm.action.RMActionExecuterAbstractBase
- All Implemented Interfaces:
RecordsManagementAction
,RecordsManagementCustomModel
,RecordsManagementModel
,ActionExecuter
,LoggingAwareExecuter
,org.springframework.beans.factory.Aware
,org.springframework.beans.factory.BeanNameAware
,org.springframework.context.ApplicationContextAware
- Direct Known Subclasses:
AddRecordTypeAction
,ApplyCustomTypeAction
,BroadcastDispositionActionDefinitionUpdateAction
,BroadcastVitalRecordDefinitionAction
,CloseRecordFolderAction
,CompleteEventAction
,CopyMoveLinkFileToBaseAction
,CreateDispositionScheduleAction
,DeclareRecordAction
,DelegateAction
,DeleteHoldAction
,EditDispositionActionAsOfDateAction
,EditHoldReasonAction
,EditReviewAsOfDateAction
,FileReportAction
,FreezeAction
,OpenRecordFolderAction
,RejectAction
,RelinquishHoldAction
,RequestInfoAction
,ReviewedAction
,RMDispositionActionExecuterAbstractBase
,SplitEmailAction
,TransferCompleteAction
,UnCutoffAction
,UndeclareRecordAction
,UndoEventAction
,UnfreezeAction
,UnlinkFromAction
public abstract class RMActionExecuterAbstractBase
extends PropertySubActionExecuterAbstractBase
implements RecordsManagementAction, RecordsManagementModel, org.springframework.beans.factory.BeanNameAware
Records management action executer base class
- Author:
- Roy Wetherall
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Set<FilePlanComponentKind>
List of kinds for which this action is applicableFields inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase
actionAccessRestrictions, actionDefinition, applicableTypes, publicAction
Fields inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase
adhocPropertiesAllowed, DISPLAY_LABEL, runtimeActionService
Fields inherited from class org.alfresco.repo.action.CommonResourceAbstractBase
name
Fields inherited from interface org.alfresco.repo.action.executer.ActionExecuter
PARAM_RESULT
Fields inherited from interface org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementCustomModel
ASPECT_CUSTOM_ASSOCIATIONS, ASPECT_SUPPLEMENTAL_MARKING_LIST, CONSTRAINT_CUSTOM_SMLIST, CUSTOM_REF_CROSSREFERENCE, CUSTOM_REF_OBSOLETES, CUSTOM_REF_RENDITION, CUSTOM_REF_SUPERSEDES, CUSTOM_REF_SUPPORTS, CUSTOM_REF_VERSIONS, PROP_SUPPLEMENTAL_MARKING_LIST, RM_CUSTOM_MODEL, RM_CUSTOM_PREFIX, RM_CUSTOM_URI
Fields inherited from interface org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel
ASPECT_ARCHIVED, ASPECT_ASCENDED, ASPECT_CAVEAT_CONFIG_ROOT, ASPECT_COMMON_RECORD_DETAILS, ASPECT_COUNTABLE, ASPECT_CUSTOM_RM_DATA, ASPECT_CUT_OFF, ASPECT_DECLARED_RECORD, ASPECT_DISPOSITION_LIFECYCLE, ASPECT_DISPOSITION_PROCESSED, ASPECT_EMAIL_CONFIG_ROOT, ASPECT_EXTENDED_SECURITY, ASPECT_FILABLE, ASPECT_FILE_PLAN_COMPONENT, ASPECT_FROZEN, ASPECT_GHOSTED, ASPECT_HELD_CHILDREN, ASPECT_LOADED_DATA_SET_ID, ASPECT_RECORD, ASPECT_RECORD_COMPONENT_ID, ASPECT_RECORD_META_DATA, ASPECT_RECORD_ORIGINATING_DETAILS, ASPECT_RECORD_REJECTION_DETAILS, ASPECT_RECORDS_MANAGEMENT_ROOT, ASPECT_RM_SEARCH, ASPECT_SAVED_SEARCH, ASPECT_SCHEDULED, ASPECT_TRANSFERRED, ASPECT_TRANSFERRING, ASPECT_UNCUT_OFF, ASPECT_UNPUBLISHED_UPDATE, ASPECT_VERSIONED_RECORD, ASPECT_VITAL_RECORD, ASPECT_VITAL_RECORD_DEFINITION, ASSOC_CAVEAT_CONFIG, ASSOC_DISPOSITION_ACTION_DEFINITIONS, ASSOC_DISPOSITION_ACTION_HISTORY, ASSOC_DISPOSITION_SCHEDULE, ASSOC_EMAIL_CONFIG, ASSOC_EVENT_EXECUTIONS, ASSOC_FROZEN_CONTENT, ASSOC_FROZEN_RECORDS, ASSOC_HOLDS, ASSOC_NEXT_DISPOSITION_ACTION, ASSOC_TRANSFERRED, ASSOC_TRANSFERS, GL_URI, PROP_COMBINE_DISPOSITION_STEP_CONDITIONS, PROP_COUNT, PROP_CUT_OFF_DATE, PROP_DATE_FILED, PROP_DB_UNIQUENESS_ID, PROP_DECLARED_AT, PROP_DECLARED_BY, PROP_DISPOSITION_ACTION, PROP_DISPOSITION_ACTION_COMPLETED_AT, PROP_DISPOSITION_ACTION_COMPLETED_BY, PROP_DISPOSITION_ACTION_GHOST_ON_DESTROY, PROP_DISPOSITION_ACTION_ID, PROP_DISPOSITION_ACTION_NAME, PROP_DISPOSITION_ACTION_STARTED_AT, PROP_DISPOSITION_ACTION_STARTED_BY, PROP_DISPOSITION_AS_OF, PROP_DISPOSITION_AUTHORITY, PROP_DISPOSITION_DESCRIPTION, PROP_DISPOSITION_EVENT, PROP_DISPOSITION_EVENT_COMBINATION, PROP_DISPOSITION_EVENTS_ELIGIBLE, PROP_DISPOSITION_INSTRUCTIONS, PROP_DISPOSITION_LOCATION, PROP_DISPOSITION_PERIOD, PROP_DISPOSITION_PERIOD_PROPERTY, PROP_EVENT_EXECUTION_AUTOMATIC, PROP_EVENT_EXECUTION_COMPLETE, PROP_EVENT_EXECUTION_COMPLETED_AT, PROP_EVENT_EXECUTION_COMPLETED_BY, PROP_EVENT_EXECUTION_NAME, PROP_FROZEN_AT, PROP_FROZEN_BY, PROP_HELD_CHILDREN_COUNT, PROP_HOLD_REASON, PROP_IDENTIFIER, PROP_IS_CLOSED, PROP_LOADED_DATA_SET_IDS, PROP_LOCATION, PROP_MANUALLY_SET_AS_OF, PROP_ORIGIONAL_NAME, PROP_PUBLISH_IN_PROGRESS, PROP_READERS, PROP_RECORD_LEVEL_DISPOSITION, PROP_RECORD_ORIGINATING_CREATION_DATE, PROP_RECORD_ORIGINATING_LOCATION, PROP_RECORD_ORIGINATING_USER_ID, PROP_RECORD_REJECTION_DATE, PROP_RECORD_REJECTION_REASON, PROP_RECORD_REJECTION_USER_ID, PROP_REVIEW_AS_OF, PROP_REVIEW_PERIOD, PROP_ROOT_NODEREF, PROP_RS_DECLASSIFICATION_REVIEW_COMPLETED_AT, PROP_RS_DECLASSIFICATION_REVIEW_COMPLETED_BY, PROP_RS_DISPOITION_AUTHORITY, PROP_RS_DISPOITION_INSTRUCTIONS, PROP_RS_DISPOSITION_ACTION_AS_OF, PROP_RS_DISPOSITION_ACTION_NAME, PROP_RS_DISPOSITION_EVENTS, PROP_RS_DISPOSITION_EVENTS_ELIGIBLE, PROP_RS_DISPOSITION_PERIOD, PROP_RS_DISPOSITION_PERIOD_EXPRESSION, PROP_RS_HAS_DISPOITION_SCHEDULE, PROP_RS_HOLD_REASON, PROP_RS_VITAL_RECORD_REVIEW_PERIOD, PROP_RS_VITAL_RECORD_REVIEW_PERIOD_EXPRESSION, PROP_TRANSFER_ACCESSION_INDICATOR, PROP_TRANSFER_LOCATION, PROP_TRANSFER_PDF_INDICATOR, PROP_UNPUBLISHED_UPDATE, PROP_UPDATE_TO, PROP_UPDATED_PROPERTIES, PROP_VITAL_RECORD_INDICATOR, PROP_WRITERS, RM_MODEL, RM_PREFIX, RM_URI, TYPE_CAVEAT_CONFIG, TYPE_DISPOSITION_ACTION, TYPE_DISPOSITION_ACTION_DEFINITION, TYPE_DISPOSITION_SCHEDULE, TYPE_EMAIL_CONFIG, TYPE_EVENT_EXECUTION, TYPE_FILE_PLAN, TYPE_HOLD, TYPE_HOLD_CONTAINER, TYPE_NON_ELECTRONIC_DOCUMENT, TYPE_RECORD_CATEGORY, TYPE_RECORD_FOLDER, TYPE_RECORDS_MANAGEMENT_CONTAINER, TYPE_RM_SITE, TYPE_TRANSFER, TYPE_TRANSFER_CONTAINER, TYPE_UNFILED_RECORD_CONTAINER, TYPE_UNFILED_RECORD_FOLDER, UPDATE_TO_DISPOSITION_ACTION_DEFINITION
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addParameterDefinitions
(List<ParameterDefinition> paramList) By default there are no parameters.protected ActionDefinition
createActionDefinition
(String name) execute
(NodeRef filePlanComponent, Map<String, Serializable> parameters) Execution of the actionprotected ActionService
Gets the action serviceprotected ContentService
Gets the content serviceGet the description of the actionprotected DictionaryService
Gets the dictionary serviceprotected DispositionService
Gets the disposition serviceprotected FreezeService
Gets the freeze serviceprotected HoldService
Gets the hold serviceGets the identifier serviceBy default, rmActions do not provide an implicit target nodeRef.getLabel()
Get the label of the actionprotected ModelSecurityService
Gets the model security servicegetName()
Get the name of the actionprotected NamespaceService
Gets the namespace serviceprotected NodeService
Gets the node serviceprotected OwnableService
Gets the ownable serviceprotected RecordFolderService
Gets the record folder serviceprotected RecordService
Gets the record serviceGet the records management action definition.protected RecordsManagementActionService
Gets the records management action serviceprotected RecordsManagementAdminService
Gets the records management admin serviceprotected RecordsManagementAuditService
Gets the records management audit serviceprotected RecordsManagementEventService
Gets the records management event serviceprotected TransactionService
Get the transaction serviceprotected VitalRecordService
Gets the vital record servicevoid
init()
Init methodboolean
By default an action is not a disposition actionboolean
Indicates whether this records management action is public or notprotected String
Deprecated.void
setActionService
(ActionService actionService) Set action servicevoid
setApplicableKinds
(String[] applicableKinds) Sets the applicable kindsvoid
setBeanName
(String name) void
setContentService
(ContentService contentService) Set the content servicevoid
setDictionaryService
(DictionaryService dictionaryService) Set the dictionary servicevoid
setDispositionService
(DispositionService dispositionService) Set the disposition servicevoid
setFreezeService
(FreezeService freezeService) Set freeze servicevoid
setHoldService
(HoldService holdService) Sets the hold servicevoid
setIdentifierService
(IdentifierService identifierService) Sets the identifier servicevoid
setModelSecurityService
(ModelSecurityService modelSecurityService) Sets the model security servicevoid
setNamespaceService
(NamespaceService namespaceService) Set the namespace servicevoid
setNodeService
(NodeService nodeService) Set the node servicevoid
setOwnableService
(OwnableService ownableService) Set the ownable servicevoid
setRecordFolderService
(RecordFolderService recordFolderService) Sets the record folder servicevoid
setRecordService
(RecordService recordService) Set record servicevoid
setRecordsManagementActionService
(RecordsManagementActionService recordsManagementActionService) Set records management servicevoid
setRecordsManagementAdminService
(RecordsManagementAdminService recordsManagementAdminService) Sets the records management admin servicevoid
setRecordsManagementAuditService
(RecordsManagementAuditService recordsManagementAuditService) Set the audit service that action details will be sent tovoid
setRecordsManagementEventService
(RecordsManagementEventService recordsManagementEventService) Set the records management event servicevoid
setTransactionService
(TransactionService transactionService) Set the transaction servicevoid
setVitalRecordService
(VitalRecordService vitalRecordService) Sets the vital record serviceMethods inherited from class org.alfresco.module.org_alfresco_module_rm.action.PropertySubActionExecuterAbstractBase
execute, getParameterProcessorComponent, isAllowParameterSubstitutions, setAllowParameterSubstitutions, setParameterProcessorComponent
Methods inherited from class org.alfresco.module.org_alfresco_module_rm.action.AuditableActionExecuterAbstractBase
getApplicationContext, isAuditable, isAuditedImmediately, setApplicationContext, setAuditable, setAuditedImmediately
Methods inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase
executeImpl, getActionAccessRestrictions, getIgnoreLock, getQueueName, getTrackStatus, isApplicableType, onLogException, setActionAccessRestrictions, setApplicableTypes, setBaseNodeService, setIgnoreLock, setLockService, setMlAwareNodeService, setPublicAction, setQueueName, setTrackStatus, verifyActionAccessRestrictions
Methods inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase
checkMandatoryProperties, getAdhocPropertiesAllowed, getDescriptionKey, getLocalizedParameterDefinitions, getParamDisplayLabel, getParamDisplayLabel, getParameterDefintions, getTitleKey, setAdhocPropertiesAllowed, setLocales, setRuntimeActionService, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.alfresco.repo.action.executer.ActionExecuter
isExecuteAsynchronously
-
Field Details
-
applicableKinds
List of kinds for which this action is applicable
-
-
Constructor Details
-
RMActionExecuterAbstractBase
public RMActionExecuterAbstractBase()
-
-
Method Details
-
getTransactionService
Get the transaction service- Returns:
- The transaction service
-
setTransactionService
Set the transaction service- Parameters:
transactionService
- The transaction service
-
getNamespaceService
Gets the namespace service- Returns:
- The namespace service
-
setNamespaceService
Set the namespace service- Parameters:
namespaceService
- The namespace service
-
getNodeService
Gets the node service- Returns:
- The node service
-
setNodeService
Set the node service- Parameters:
nodeService
- The node service
-
getDictionaryService
Gets the dictionary service- Returns:
- The dictionary service
-
setDictionaryService
Set the dictionary service- Overrides:
setDictionaryService
in classActionExecuterAbstractBase
- Parameters:
dictionaryService
- The dictionary service
-
getContentService
Gets the content service- Returns:
- The content service
-
setContentService
Set the content service- Parameters:
contentService
- The content service
-
getActionService
Gets the action service- Returns:
- The action service
-
setActionService
Set action service- Parameters:
actionService
- The action service
-
getRecordsManagementAuditService
Gets the records management audit service- Returns:
- The records management audit service
-
setRecordsManagementAuditService
public void setRecordsManagementAuditService(RecordsManagementAuditService recordsManagementAuditService) Set the audit service that action details will be sent to- Parameters:
recordsManagementAuditService
- The audit service that action details will be sent to
-
getRecordsManagementActionService
Gets the records management action service- Returns:
- The records management action service
-
setRecordsManagementActionService
public void setRecordsManagementActionService(RecordsManagementActionService recordsManagementActionService) Set records management service- Parameters:
recordsManagementActionService
- The records management service
-
getDispositionService
Gets the disposition service- Returns:
- The disposition service
-
setDispositionService
Set the disposition service- Parameters:
dispositionService
- The disposition service
-
getVitalRecordService
Gets the vital record service- Returns:
- The vital record service
-
setVitalRecordService
Sets the vital record service- Parameters:
vitalRecordService
- vital record service
-
getRecordsManagementEventService
Gets the records management event service- Returns:
- The records management event service
-
setRecordsManagementEventService
public void setRecordsManagementEventService(RecordsManagementEventService recordsManagementEventService) Set the records management event service- Parameters:
recordsManagementEventService
- The records management event service
-
getOwnableService
Gets the ownable service- Returns:
- The ownable service
-
setOwnableService
Set the ownable service- Parameters:
ownableService
- The ownable service
-
getFreezeService
Gets the freeze service- Returns:
- The freeze service
-
setFreezeService
Set freeze service- Parameters:
freezeService
- freeze service
-
getRecordService
Gets the record service- Returns:
- The record service
-
setRecordService
Set record service- Parameters:
recordService
- record service
-
getRecordsManagementAdminService
Gets the records management admin service- Returns:
- The records management admin service
-
setRecordsManagementAdminService
public void setRecordsManagementAdminService(RecordsManagementAdminService recordsManagementAdminService) Sets the records management admin service- Parameters:
recordsManagementAdminService
- records management admin service
-
getModelSecurityService
Gets the model security service- Returns:
- The model security service
-
setModelSecurityService
Sets the model security service- Parameters:
modelSecurityService
- model security service
-
getRecordFolderService
Gets the record folder service- Returns:
- The record folder service
-
setRecordFolderService
Sets the record folder service- Parameters:
recordFolderService
- record folder service
-
getHoldService
Gets the hold service- Returns:
- The hold service
-
setHoldService
Sets the hold service- Parameters:
holdService
- hold service
-
getIdentifierService
Gets the identifier service- Returns:
- the identifier service
-
setIdentifierService
Sets the identifier service- Parameters:
identifierService
- the identifier service
-
setApplicableKinds
Sets the applicable kinds- Parameters:
applicableKinds
- kinds that this action is applicable for
-
createActionDefinition
- Overrides:
createActionDefinition
in classActionExecuterAbstractBase
- See Also:
-
getActionDefinition
- Specified by:
getActionDefinition
in interfaceActionExecuter
- Overrides:
getActionDefinition
in classActionExecuterAbstractBase
- See Also:
-
getRecordsManagementActionDefinition
Description copied from interface:RecordsManagementAction
Get the records management action definition.- Specified by:
getRecordsManagementActionDefinition
in interfaceRecordsManagementAction
- Returns:
- The records management action definition.
- See Also:
-
init
public void init()Init method- Overrides:
init
in classAuditableActionExecuterAbstractBase
- See Also:
-
isPublicAction
public boolean isPublicAction()Indicates whether this records management action is public or not- Specified by:
isPublicAction
in interfaceRecordsManagementAction
- Returns:
- boolean true if public, false otherwise
-
setBeanName
- Specified by:
setBeanName
in interfaceorg.springframework.beans.factory.BeanNameAware
- Overrides:
setBeanName
in classCommonResourceAbstractBase
- See Also:
-
getName
Description copied from interface:RecordsManagementAction
Get the name of the action- Specified by:
getName
in interfaceRecordsManagementAction
- Returns:
- String action name
- See Also:
-
getLabel
Description copied from interface:RecordsManagementAction
Get the label of the action- Specified by:
getLabel
in interfaceRecordsManagementAction
- Returns:
- String action label
- See Also:
-
getDescription
Description copied from interface:RecordsManagementAction
Get the description of the action- Specified by:
getDescription
in interfaceRecordsManagementAction
- Returns:
- String action description
- See Also:
-
isDispositionAction
public boolean isDispositionAction()By default an action is not a disposition action- Specified by:
isDispositionAction
in interfaceRecordsManagementAction
- Returns:
- boolean true if a disposition action, false otherwise
- See Also:
-
execute
public RecordsManagementActionResult execute(NodeRef filePlanComponent, Map<String, Serializable> parameters) Description copied from interface:RecordsManagementAction
Execution of the action- Specified by:
execute
in interfaceRecordsManagementAction
- Parameters:
filePlanComponent
- file plan component the action is executed uponparameters
- action parameters- Returns:
- The result of the executed action
- See Also:
-
padString
Deprecated.As of 2.1, replaced byStringUtils.leftPad(String, int)
Function to pad a string with zero '0' characters to the required length- Parameters:
s
- String to pad with leading zero '0' characterslen
- Length to pad to- Returns:
- padded string or the original if already at >= len characters
-
addParameterDefinitions
By default there are no parameters.- Specified by:
addParameterDefinitions
in classParameterizedItemAbstractBase
- See Also:
-
getImplicitTargetNodeRef
By default, rmActions do not provide an implicit target nodeRef.- Specified by:
getImplicitTargetNodeRef
in interfaceRecordsManagementAction
- Returns:
- the target nodeRef
-
StringUtils.leftPad(String, int)