org.alfresco.module.org_alfresco_module_rm.action

Class RMDispositionActionExecuterAbstractBase

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

org.alfresco.module.org_alfresco_module_rm.action.RMDispositionActionExecuterAbstractBase

All Implemented Interfaces:

RecordsManagementAction, RecordsManagementCustomModel, RecordsManagementModel, org.alfresco.repo.action.executer.ActionExecuter, org.alfresco.repo.action.executer.LoggingAwareExecuter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

CutOffAction, DestroyAction, RetainAction, TransferAction

public abstract class RMDispositionActionExecuterAbstractBase
extends RMActionExecuterAbstractBase

Author:

Roy Wetherall

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_NO_ERROR_CHECK Parameter value indicating whether we should be doing non-error raising state checks

Fields inherited from class org.alfresco.module.org_alfresco_module_rm.action.RMActionExecuterAbstractBase

applicableKinds

Fields inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase

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.module.org_alfresco_module_rm.model.RecordsManagementModel

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_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_RECORDS, ASSOC_HOLDS, ASSOC_NEXT_DISPOSITION_ACTION, ASSOC_TRANSFERRED, ASSOC_TRANSFERS, 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_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

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.repo.action.executer.ActionExecuter

PARAM_RESULT

Constructor Summary

Constructors

Constructor and Description
RMDispositionActionExecuterAbstractBase()

Method Summary

Modifier and Type	Method and Description
protected void	addParameterDefinitions(List<org.alfresco.service.cmr.action.ParameterDefinition> paramList) By default there are no parameters.
protected DispositionSchedule	checkDispositionActionExecutionValidity(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.repository.NodeRef nextDispositionActionNodeRef, boolean throwError)
protected boolean	checkEligibility(org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef) Indicated whether we should validate the disposition action is eligible or not.
protected boolean	checkNextDispositionAction(org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef) Indicates whether we should validate the next disposition action is the action we are trying to execute.
protected void	executeImpl(org.alfresco.service.cmr.action.Action action, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
protected abstract void	executeRecordFolderLevelDisposition(org.alfresco.service.cmr.action.Action action, org.alfresco.service.cmr.repository.NodeRef recordFolder)
protected abstract void	executeRecordLevelDisposition(org.alfresco.service.cmr.action.Action action, org.alfresco.service.cmr.repository.NodeRef record)
boolean	getSetDispositionActionComplete() Indicates whether the disposition is marked complete
boolean	isDispositionAction() All children of this implementation are disposition actions.

Methods inherited from class org.alfresco.module.org_alfresco_module_rm.action.RMActionExecuterAbstractBase

createActionDefinition, execute, getActionDefinition, getActionService, getContentService, getDescription, getDictionaryService, getDispositionService, getFreezeService, getHoldService, getIdentifierService, getImplicitTargetNodeRef, getLabel, getModelSecurityService, getName, getNamespaceService, getNodeService, getOwnableService, getRecordFolderService, getRecordService, getRecordsManagementActionDefinition, getRecordsManagementActionService, getRecordsManagementAdminService, getRecordsManagementAuditService, getRecordsManagementEventService, getTransactionService, getVitalRecordService, init, isPublicAction, padString, setActionService, setApplicableKinds, setBeanName, setContentService, setDictionaryService, setDispositionService, setFreezeService, setHoldService, setIdentifierService, setModelSecurityService, setNamespaceService, setNodeService, setOwnableService, setRecordFolderService, setRecordService, setRecordsManagementActionService, setRecordsManagementAdminService, setRecordsManagementAuditService, setRecordsManagementEventService, setTransactionService, setVitalRecordService

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

getIgnoreLock, getQueueName, getTrackStatus, isApplicableType, onLogException, setApplicableTypes, setBaseNodeService, setIgnoreLock, setLockService, setMlAwareNodeService, setPublicAction, setQueueName, setTrackStatus

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

Field Detail

PARAM_NO_ERROR_CHECK

public static final String PARAM_NO_ERROR_CHECK

Parameter value indicating whether we should be doing non-error raising state checks

See Also:

Constant Field Values

Constructor Detail

RMDispositionActionExecuterAbstractBase

public RMDispositionActionExecuterAbstractBase()

Method Detail

isDispositionAction

public boolean isDispositionAction()

All children of this implementation are disposition actions.

Specified by:

isDispositionAction in interface RecordsManagementAction

Overrides:

isDispositionAction in class RMActionExecuterAbstractBase

Returns:

boolean true if a disposition action, false otherwise

See Also:

RMActionExecuterAbstractBase.isDispositionAction()

getSetDispositionActionComplete

public boolean getSetDispositionActionComplete()

Indicates whether the disposition is marked complete

Returns:

true if marked complete, false otherwise

checkNextDispositionAction

protected boolean checkNextDispositionAction(org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)

Indicates whether we should validate the next disposition action is the action we are trying to execute.

Returns:

checkEligibility

protected boolean checkEligibility(org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)

Indicated whether we should validate the disposition action is eligible or not.

Parameters:

actionedUponNodeRef -

Returns:

executeImpl

protected void executeImpl(org.alfresco.service.cmr.action.Action action,
                           org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)

Specified by:

executeImpl in class org.alfresco.repo.action.executer.ActionExecuterAbstractBase

See Also:

ActionExecuterAbstractBase.executeImpl(org.alfresco.service.cmr.action.Action, org.alfresco.service.cmr.repository.NodeRef)

addParameterDefinitions

protected void addParameterDefinitions(List<org.alfresco.service.cmr.action.ParameterDefinition> paramList)

Description copied from class: RMActionExecuterAbstractBase

By default there are no parameters.

Overrides:

addParameterDefinitions in class RMActionExecuterAbstractBase

See Also:

ParameterizedItemAbstractBase.addParameterDefinitions(java.util.List)

executeRecordLevelDisposition

protected abstract void executeRecordLevelDisposition(org.alfresco.service.cmr.action.Action action,
                                                      org.alfresco.service.cmr.repository.NodeRef record)

Parameters:

action -

record -

executeRecordFolderLevelDisposition

protected abstract void executeRecordFolderLevelDisposition(org.alfresco.service.cmr.action.Action action,
                                                            org.alfresco.service.cmr.repository.NodeRef recordFolder)

Parameters:

action -

recordFolder -

checkDispositionActionExecutionValidity

protected DispositionSchedule checkDispositionActionExecutionValidity(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                                      org.alfresco.service.cmr.repository.NodeRef nextDispositionActionNodeRef,
                                                                      boolean throwError)

Parameters:

nodeRef -

Returns: