public abstract class RMActionExecuterAbstractBase extends PropertySubActionExecuterAbstractBase implements RecordsManagementAction, RecordsManagementModel, org.springframework.beans.factory.BeanNameAware
| Modifier and Type | Field and Description |
|---|---|
protected Set<FilePlanComponentKind> |
applicableKinds
List of kinds for which this action is applicable
|
actionDefinition, applicableTypes, publicActionadhocPropertiesAllowed, DISPLAY_LABEL, runtimeActionServiceASPECT_ASCENDED, ASPECT_CAVEAT_CONFIG_ROOT, 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_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_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_DEFINITIONASPECT_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| Constructor and Description |
|---|
RMActionExecuterAbstractBase() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
addParameterDefinitions(List<org.alfresco.service.cmr.action.ParameterDefinition> paramList)
By default there are no parameters.
|
protected org.alfresco.service.cmr.action.ActionDefinition |
createActionDefinition(String name) |
RecordsManagementActionResult |
execute(org.alfresco.service.cmr.repository.NodeRef filePlanComponent,
Map<String,Serializable> parameters)
Execution of the action
|
org.alfresco.service.cmr.action.ActionDefinition |
getActionDefinition() |
protected org.alfresco.service.cmr.action.ActionService |
getActionService()
Gets the action service
|
protected org.alfresco.service.cmr.repository.ContentService |
getContentService()
Gets the content service
|
String |
getDescription()
Get the description of the action
|
protected org.alfresco.service.cmr.dictionary.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
|
org.alfresco.service.cmr.repository.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 org.alfresco.service.namespace.NamespaceService |
getNamespaceService()
Gets the namespace service
|
protected org.alfresco.service.cmr.repository.NodeService |
getNodeService()
Gets the node service
|
protected org.alfresco.service.cmr.security.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 org.alfresco.service.transaction.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
org.apache.commons.lang.StringUtils.leftPad |
void |
setActionService(org.alfresco.service.cmr.action.ActionService actionService)
Set action service
|
void |
setApplicableKinds(String[] applicableKinds)
Sets the applicable kinds
|
void |
setBeanName(String name) |
void |
setContentService(org.alfresco.service.cmr.repository.ContentService contentService)
Set the content service
|
void |
setDictionaryService(org.alfresco.service.cmr.dictionary.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 |
setModelSecurityService(ModelSecurityService modelSecurityService)
Sets the model security service
|
void |
setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
Set the namespace service
|
void |
setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
Set the node service
|
void |
setOwnableService(org.alfresco.service.cmr.security.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(org.alfresco.service.transaction.TransactionService transactionService)
Set the transaction service
|
void |
setVitalRecordService(VitalRecordService vitalRecordService)
Sets the vital record service
|
execute, getParameterProcessorComponent, isAllowParameterSubstitutions, setAllowParameterSubstitutions, setParameterProcessorComponentgetApplicationContext, isAuditable, isAuditedImmediately, setApplicationContext, setAuditable, setAuditedImmediatelyexecuteImpl, getIgnoreLock, getQueueName, getTrackStatus, isApplicableType, onLogException, setApplicableTypes, setBaseNodeService, setIgnoreLock, setLockService, setMlAwareNodeService, setPublicAction, setQueueName, setTrackStatuscheckMandatoryProperties, getAdhocPropertiesAllowed, getDescriptionKey, getLocalizedParameterDefinitions, getParamDisplayLabel, getParamDisplayLabel, getParameterDefintions, getTitleKey, setAdhocPropertiesAllowed, setLocales, setRuntimeActionService, toStringprotected Set<FilePlanComponentKind> applicableKinds
protected org.alfresco.service.transaction.TransactionService getTransactionService()
public void setTransactionService(org.alfresco.service.transaction.TransactionService transactionService)
transactionService - The transaction serviceprotected org.alfresco.service.namespace.NamespaceService getNamespaceService()
public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
namespaceService - The namespace serviceprotected org.alfresco.service.cmr.repository.NodeService getNodeService()
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
nodeService - The node serviceprotected org.alfresco.service.cmr.dictionary.DictionaryService getDictionaryService()
public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
setDictionaryService in class org.alfresco.repo.action.executer.ActionExecuterAbstractBasedictionaryService - The dictionary serviceprotected org.alfresco.service.cmr.repository.ContentService getContentService()
public void setContentService(org.alfresco.service.cmr.repository.ContentService contentService)
contentService - The content serviceprotected org.alfresco.service.cmr.action.ActionService getActionService()
public void setActionService(org.alfresco.service.cmr.action.ActionService actionService)
actionService - The action serviceprotected RecordsManagementAuditService getRecordsManagementAuditService()
public void setRecordsManagementAuditService(RecordsManagementAuditService recordsManagementAuditService)
recordsManagementAuditService - The audit service that action details will be sent toprotected RecordsManagementActionService getRecordsManagementActionService()
public void setRecordsManagementActionService(RecordsManagementActionService recordsManagementActionService)
recordsManagementActionService - The records management serviceprotected DispositionService getDispositionService()
public void setDispositionService(DispositionService dispositionService)
dispositionService - The disposition serviceprotected VitalRecordService getVitalRecordService()
public void setVitalRecordService(VitalRecordService vitalRecordService)
vitalRecordService - vital record serviceprotected RecordsManagementEventService getRecordsManagementEventService()
public void setRecordsManagementEventService(RecordsManagementEventService recordsManagementEventService)
recordsManagementEventService - The records management event serviceprotected org.alfresco.service.cmr.security.OwnableService getOwnableService()
public void setOwnableService(org.alfresco.service.cmr.security.OwnableService ownableService)
ownableService - The ownable serviceprotected FreezeService getFreezeService()
public void setFreezeService(FreezeService freezeService)
freezeService - freeze serviceprotected RecordService getRecordService()
public void setRecordService(RecordService recordService)
recordService - record serviceprotected RecordsManagementAdminService getRecordsManagementAdminService()
public void setRecordsManagementAdminService(RecordsManagementAdminService recordsManagementAdminService)
recordsManagementAdminService - records management admin serviceprotected ModelSecurityService getModelSecurityService()
public void setModelSecurityService(ModelSecurityService modelSecurityService)
modelSecurityService - model security serviceprotected RecordFolderService getRecordFolderService()
public void setRecordFolderService(RecordFolderService recordFolderService)
recordFolderService - record folder serviceprotected HoldService getHoldService()
public void setHoldService(HoldService holdService)
holdService - hold servicepublic void setApplicableKinds(String[] applicableKinds)
applicableKinds - kinds that this action is applicable forprotected org.alfresco.service.cmr.action.ActionDefinition createActionDefinition(String name)
createActionDefinition in class org.alfresco.repo.action.executer.ActionExecuterAbstractBaseActionExecuterAbstractBase.createActionDefinition(java.lang.String)public org.alfresco.service.cmr.action.ActionDefinition getActionDefinition()
getActionDefinition in interface org.alfresco.repo.action.executer.ActionExecutergetActionDefinition in class org.alfresco.repo.action.executer.ActionExecuterAbstractBaseActionExecuterAbstractBase.getActionDefinition()public RecordsManagementActionDefinition getRecordsManagementActionDefinition()
RecordsManagementActiongetRecordsManagementActionDefinition in interface RecordsManagementActionRecordsManagementAction.getRecordsManagementActionDefinition()public void init()
init in class AuditableActionExecuterAbstractBaseActionExecuterAbstractBase.init()public boolean isPublicAction()
isPublicAction in interface RecordsManagementActionpublic void setBeanName(String name)
setBeanName in interface org.springframework.beans.factory.BeanNameAwaresetBeanName in class org.alfresco.repo.action.CommonResourceAbstractBaseCommonResourceAbstractBase.setBeanName(java.lang.String)public String getName()
RecordsManagementActiongetName in interface RecordsManagementActionRecordsManagementAction.getName()public String getLabel()
RecordsManagementActiongetLabel in interface RecordsManagementActionRecordsManagementAction.getLabel()public String getDescription()
RecordsManagementActiongetDescription in interface RecordsManagementActionRecordsManagementAction.getDescription()public boolean isDispositionAction()
isDispositionAction in interface RecordsManagementActionRecordsManagementAction.isDispositionAction()public RecordsManagementActionResult execute(org.alfresco.service.cmr.repository.NodeRef filePlanComponent, Map<String,Serializable> parameters)
RecordsManagementActionexecute in interface RecordsManagementActionfilePlanComponent - file plan component the action is executed uponparameters - action parametersRecordsManagementAction.execute(org.alfresco.service.cmr.repository.NodeRef, java.util.Map)@Deprecated protected String padString(String s, int len)
org.apache.commons.lang.StringUtils.leftPads - String to pad with leading zero '0' characterslen - Length to pad toprotected void addParameterDefinitions(List<org.alfresco.service.cmr.action.ParameterDefinition> paramList)
addParameterDefinitions in class org.alfresco.repo.action.ParameterizedItemAbstractBaseParameterizedItemAbstractBase.addParameterDefinitions(java.util.List)public org.alfresco.service.cmr.repository.NodeRef getImplicitTargetNodeRef()
getImplicitTargetNodeRef in interface RecordsManagementActionCopyright © 2005–2017 Alfresco Software. All rights reserved.