Package org.alfresco.module.org_alfresco_module_rm.action

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

Fields

Modifier and Type	Field	Description
protected Set<FilePlanComponentKind>	applicableKinds	List of kinds for which this action is applicable

Fields 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

Constructor	Description
RMActionExecuterAbstractBase()

Method Summary

Modifier and Type	Method	Description
protected void	addParameterDefinitions(List<ParameterDefinition> paramList)	By default there are no parameters.
protected ActionDefinition	createActionDefinition(String name)
RecordsManagementActionResult	execute(NodeRef filePlanComponent, Map<String,Serializable> parameters)	Execution of the action
ActionDefinition	getActionDefinition()
protected ActionService	getActionService()	Gets the action service
protected ContentService	getContentService()	Gets the content service
String	getDescription()	Get the description of the action
protected DictionaryService	getDictionaryService()	Gets the dictionary service
protected DispositionService	getDispositionService()	Gets the disposition service
protected FreezeService	getFreezeService()	Gets the freeze service
protected HoldService	getHoldService()	Gets the hold service
IdentifierService	getIdentifierService()	Gets the identifier service
NodeRef	getImplicitTargetNodeRef()	By default, rmActions do not provide an implicit target nodeRef.
String	getLabel()	Get the label of the action
protected ModelSecurityService	getModelSecurityService()	Gets the model security service
String	getName()	Get the name of the action
protected NamespaceService	getNamespaceService()	Gets the namespace service
protected NodeService	getNodeService()	Gets the node service
protected OwnableService	getOwnableService()	Gets the ownable service
protected RecordFolderService	getRecordFolderService()	Gets the record folder service
protected RecordService	getRecordService()	Gets the record service
RecordsManagementActionDefinition	getRecordsManagementActionDefinition()	Get the records management action definition.
protected RecordsManagementActionService	getRecordsManagementActionService()	Gets the records management action service
protected RecordsManagementAdminService	getRecordsManagementAdminService()	Gets the records management admin service
protected RecordsManagementAuditService	getRecordsManagementAuditService()	Gets the records management audit service
protected RecordsManagementEventService	getRecordsManagementEventService()	Gets the records management event service
protected TransactionService	getTransactionService()	Get the transaction service
protected VitalRecordService	getVitalRecordService()	Gets the vital record service
void	init()	Init method
boolean	isDispositionAction()	By default an action is not a disposition action
boolean	isPublicAction()	Indicates whether this records management action is public or not
protected String	padString(String s, int len)	Deprecated. As of 2.1, replaced by StringUtils.leftPad(String, int)
void	setActionService(ActionService actionService)	Set action service
void	setApplicableKinds(String[] applicableKinds)	Sets the applicable kinds
void	setBeanName(String name)
void	setContentService(ContentService contentService)	Set the content service
void	setDictionaryService(DictionaryService dictionaryService)	Set the dictionary service
void	setDispositionService(DispositionService dispositionService)	Set the disposition service
void	setFreezeService(FreezeService freezeService)	Set freeze service
void	setHoldService(HoldService holdService)	Sets the hold service
void	setIdentifierService(IdentifierService identifierService)	Sets the identifier service
void	setModelSecurityService(ModelSecurityService modelSecurityService)	Sets the model security service
void	setNamespaceService(NamespaceService namespaceService)	Set the namespace service
void	setNodeService(NodeService nodeService)	Set the node service
void	setOwnableService(OwnableService ownableService)	Set the ownable service
void	setRecordFolderService(RecordFolderService recordFolderService)	Sets the record folder service
void	setRecordService(RecordService recordService)	Set record service
void	setRecordsManagementActionService(RecordsManagementActionService recordsManagementActionService)	Set records management service
void	setRecordsManagementAdminService(RecordsManagementAdminService recordsManagementAdminService)	Sets the records management admin service
void	setRecordsManagementAuditService(RecordsManagementAuditService recordsManagementAuditService)	Set the audit service that action details will be sent to
void	setRecordsManagementEventService(RecordsManagementEventService recordsManagementEventService)	Set the records management event service
void	setTransactionService(TransactionService transactionService)	Set the transaction service
void	setVitalRecordService(VitalRecordService vitalRecordService)	Sets the vital record service

Methods 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

protected Set<FilePlanComponentKind> applicableKinds

List of kinds for which this action is applicable

Constructor Details

RMActionExecuterAbstractBase

public RMActionExecuterAbstractBase()

Method Details

getTransactionService

protected TransactionService getTransactionService()

Get the transaction service

Returns:

The transaction service

setTransactionService

public void setTransactionService(TransactionService transactionService)

Set the transaction service

Parameters:

transactionService - The transaction service

getNamespaceService

protected NamespaceService getNamespaceService()

Gets the namespace service

Returns:

The namespace service

setNamespaceService

public void setNamespaceService(NamespaceService namespaceService)

Set the namespace service

Parameters:

namespaceService - The namespace service

getNodeService

protected NodeService getNodeService()

Gets the node service

Returns:

The node service

setNodeService

public void setNodeService(NodeService nodeService)

Set the node service

Parameters:

nodeService - The node service

getDictionaryService

protected DictionaryService getDictionaryService()

Gets the dictionary service

Returns:

The dictionary service

setDictionaryService

public void setDictionaryService(DictionaryService dictionaryService)

Set the dictionary service

Overrides:

setDictionaryService in class ActionExecuterAbstractBase

Parameters:

dictionaryService - The dictionary service

getContentService

protected ContentService getContentService()

Gets the content service

Returns:

The content service

setContentService

public void setContentService(ContentService contentService)

Set the content service

Parameters:

contentService - The content service

getActionService

protected ActionService getActionService()

Gets the action service

Returns:

The action service

setActionService

public void setActionService(ActionService actionService)

Set action service

Parameters:

actionService - The action service

getRecordsManagementAuditService

protected RecordsManagementAuditService 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

protected RecordsManagementActionService 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

protected DispositionService getDispositionService()

Gets the disposition service

Returns:

The disposition service

setDispositionService

public void setDispositionService(DispositionService dispositionService)

Set the disposition service

Parameters:

dispositionService - The disposition service

getVitalRecordService

protected VitalRecordService getVitalRecordService()

Gets the vital record service

Returns:

The vital record service

setVitalRecordService

public void setVitalRecordService(VitalRecordService vitalRecordService)

Sets the vital record service

Parameters:

vitalRecordService - vital record service

getRecordsManagementEventService

protected RecordsManagementEventService 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

protected OwnableService getOwnableService()

Gets the ownable service

Returns:

The ownable service

setOwnableService

public void setOwnableService(OwnableService ownableService)

Set the ownable service

Parameters:

ownableService - The ownable service

getFreezeService

protected FreezeService getFreezeService()

Gets the freeze service

Returns:

The freeze service

setFreezeService

public void setFreezeService(FreezeService freezeService)

Set freeze service

Parameters:

freezeService - freeze service

getRecordService

protected RecordService getRecordService()

Gets the record service

Returns:

The record service

setRecordService

public void setRecordService(RecordService recordService)

Set record service

Parameters:

recordService - record service

getRecordsManagementAdminService

protected RecordsManagementAdminService 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

protected ModelSecurityService getModelSecurityService()

Gets the model security service

Returns:

The model security service

setModelSecurityService

public void setModelSecurityService(ModelSecurityService modelSecurityService)

Sets the model security service

Parameters:

modelSecurityService - model security service

getRecordFolderService

protected RecordFolderService getRecordFolderService()

Gets the record folder service

Returns:

The record folder service

setRecordFolderService

public void setRecordFolderService(RecordFolderService recordFolderService)

Sets the record folder service

Parameters:

recordFolderService - record folder service

getHoldService

protected HoldService getHoldService()

Gets the hold service

Returns:

The hold service

setHoldService

public void setHoldService(HoldService holdService)

Sets the hold service

Parameters:

holdService - hold service

getIdentifierService

public IdentifierService getIdentifierService()

Gets the identifier service

Returns:

the identifier service

setIdentifierService

public void setIdentifierService(IdentifierService identifierService)

Sets the identifier service

Parameters:

identifierService - the identifier service

setApplicableKinds

public void setApplicableKinds(String[] applicableKinds)

Sets the applicable kinds

Parameters:

applicableKinds - kinds that this action is applicable for

createActionDefinition

protected ActionDefinition createActionDefinition(String name)

Overrides:

createActionDefinition in class ActionExecuterAbstractBase

See Also:

• ActionExecuterAbstractBase.createActionDefinition(java.lang.String)

getActionDefinition

public ActionDefinition getActionDefinition()

Specified by:

getActionDefinition in interface ActionExecuter

Overrides:

getActionDefinition in class ActionExecuterAbstractBase

See Also:

• ActionExecuterAbstractBase.getActionDefinition()

getRecordsManagementActionDefinition

public RecordsManagementActionDefinition getRecordsManagementActionDefinition()

Description copied from interface: RecordsManagementAction

Get the records management action definition.

Specified by:

getRecordsManagementActionDefinition in interface RecordsManagementAction

Returns:

The records management action definition.

See Also:

• RecordsManagementAction.getRecordsManagementActionDefinition()

init

public void init()

Init method

Overrides:

init in class AuditableActionExecuterAbstractBase

See Also:

• ActionExecuterAbstractBase.init()

isPublicAction

public boolean isPublicAction()

Indicates whether this records management action is public or not

Specified by:

isPublicAction in interface RecordsManagementAction

Returns:

boolean true if public, false otherwise

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

Overrides:

setBeanName in class CommonResourceAbstractBase

See Also:

• CommonResourceAbstractBase.setBeanName(java.lang.String)

getName

public String getName()

Description copied from interface: RecordsManagementAction

Get the name of the action

Specified by:

getName in interface RecordsManagementAction

Returns:

String action name

See Also:

• RecordsManagementAction.getName()

getLabel

public String getLabel()

Description copied from interface: RecordsManagementAction

Get the label of the action

Specified by:

getLabel in interface RecordsManagementAction

Returns:

String action label

See Also:

• RecordsManagementAction.getLabel()

getDescription

public String getDescription()

Description copied from interface: RecordsManagementAction

Get the description of the action

Specified by:

getDescription in interface RecordsManagementAction

Returns:

String action description

See Also:

• RecordsManagementAction.getDescription()

isDispositionAction

public boolean isDispositionAction()

By default an action is not a disposition action

Specified by:

isDispositionAction in interface RecordsManagementAction

Returns:

boolean true if a disposition action, false otherwise

See Also:

• RecordsManagementAction.isDispositionAction()

execute

public RecordsManagementActionResult execute(NodeRef filePlanComponent,
 Map<String,Serializable> parameters)

Description copied from interface: RecordsManagementAction

Execution of the action

Specified by:

execute in interface RecordsManagementAction

Parameters:

filePlanComponent - file plan component the action is executed upon

parameters - action parameters

Returns:

The result of the executed action

See Also:

• RecordsManagementAction.execute(org.alfresco.service.cmr.repository.NodeRef, java.util.Map)

padString

@Deprecated
protected String padString(String s,
 int len)

Deprecated.

As of 2.1, replaced by StringUtils.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' characters

len - Length to pad to

Returns:

padded string or the original if already at >= len characters

addParameterDefinitions

protected void addParameterDefinitions(List<ParameterDefinition> paramList)

By default there are no parameters.

Specified by:

addParameterDefinitions in class ParameterizedItemAbstractBase

See Also:

• ParameterizedItemAbstractBase.addParameterDefinitions(java.util.List)

getImplicitTargetNodeRef

public NodeRef getImplicitTargetNodeRef()

By default, rmActions do not provide an implicit target nodeRef.

Specified by:

getImplicitTargetNodeRef in interface RecordsManagementAction

Returns:

the target nodeRef