Class RecordsManagementActionServiceImpl
- java.lang.Object
-
- org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionServiceImpl
-
- All Implemented Interfaces:
RecordsManagementActionService
public class RecordsManagementActionServiceImpl extends Object implements RecordsManagementActionService
Records Management Action Service Implementation- Author:
- Roy Wetherall
-
-
Constructor Summary
Constructors Constructor Description RecordsManagementActionServiceImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RecordsManagementActionResult
executeRecordsManagementAction(String name, Map<String,Serializable> parameters)
Execute a records management action.Map<org.alfresco.service.cmr.repository.NodeRef,RecordsManagementActionResult>
executeRecordsManagementAction(List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs, String name)
Execute a records management action against several nodesMap<org.alfresco.service.cmr.repository.NodeRef,RecordsManagementActionResult>
executeRecordsManagementAction(List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs, String name, Map<String,Serializable> parameters)
Execute a records management action against several nodesRecordsManagementActionResult
executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef nodeRef, String name)
Execute a records management actionRecordsManagementActionResult
executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef nodeRef, String name, Map<String,Serializable> parameters)
Execute a records management actionRecordsManagementAction
getDispositionAction(String name)
Gets the named disposition actionList<RecordsManagementAction>
getDispositionActions()
Get a list of the available disposition actions.List<RecordsManagementAction>
getDispositionActions(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Gets the disposition actions for the given nodeprotected org.alfresco.service.cmr.repository.NodeService
getNodeService()
protected org.alfresco.repo.policy.PolicyComponent
getPolicyComponent()
RecordsManagementAction
getRecordsManagementAction(String name)
Gets the named records management actionList<RecordsManagementActionCondition>
getRecordsManagementActionConditions()
Get a list of the available records management action conditionsList<RecordsManagementAction>
getRecordsManagementActions()
Get a list of the available records management actionsvoid
init()
Initialise RM action serviceprotected void
invokeBeforeRMActionExecution(org.alfresco.service.cmr.repository.NodeRef nodeRef, String name, Map<String,Serializable> parameters)
Invoke beforeRMActionExecution policyprotected void
invokeOnRMActionExecution(org.alfresco.service.cmr.repository.NodeRef nodeRef, String name, Map<String,Serializable> parameters)
Invoke onRMActionExecution policyvoid
register(RecordsManagementAction rmAction)
Register records management actionvoid
register(RecordsManagementActionCondition rmCondition)
Register records management conditionvoid
setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
Set the node servicevoid
setPolicyComponent(org.alfresco.repo.policy.PolicyComponent policyComponent)
Set the policy component
-
-
-
Method Detail
-
getPolicyComponent
protected org.alfresco.repo.policy.PolicyComponent getPolicyComponent()
- Returns:
- Policy component
-
getNodeService
protected org.alfresco.service.cmr.repository.NodeService getNodeService()
- Returns:
- Node Service
-
setPolicyComponent
public void setPolicyComponent(org.alfresco.repo.policy.PolicyComponent policyComponent)
Set the policy component- Parameters:
policyComponent
- policy component
-
setNodeService
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
Set the node service- Parameters:
nodeService
- node service
-
init
public void init()
Initialise RM action service
-
register
public void register(RecordsManagementAction rmAction)
Description copied from interface:RecordsManagementActionService
Register records management action- Specified by:
register
in interfaceRecordsManagementActionService
- Parameters:
rmAction
- records management action- See Also:
RecordsManagementActionService.register(org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementAction)
-
register
public void register(RecordsManagementActionCondition rmCondition)
Description copied from interface:RecordsManagementActionService
Register records management condition- Specified by:
register
in interfaceRecordsManagementActionService
- Parameters:
rmCondition
- records management condition
-
invokeBeforeRMActionExecution
protected void invokeBeforeRMActionExecution(org.alfresco.service.cmr.repository.NodeRef nodeRef, String name, Map<String,Serializable> parameters)
Invoke beforeRMActionExecution policy- Parameters:
nodeRef
- node referencename
- action nameparameters
- action parameters
-
invokeOnRMActionExecution
protected void invokeOnRMActionExecution(org.alfresco.service.cmr.repository.NodeRef nodeRef, String name, Map<String,Serializable> parameters)
Invoke onRMActionExecution policy- Parameters:
nodeRef
- node referencename
- action nameparameters
- action parameters
-
getRecordsManagementActions
public List<RecordsManagementAction> getRecordsManagementActions()
Description copied from interface:RecordsManagementActionService
Get a list of the available records management actions- Specified by:
getRecordsManagementActions
in interfaceRecordsManagementActionService
- Returns:
- List of records management actions
- See Also:
RecordsManagementActionService.getRecordsManagementActions()
-
getRecordsManagementActionConditions
public List<RecordsManagementActionCondition> getRecordsManagementActionConditions()
Description copied from interface:RecordsManagementActionService
Get a list of the available records management action conditions- Specified by:
getRecordsManagementActionConditions
in interfaceRecordsManagementActionService
- Returns:
- List of records management action conditions
- See Also:
RecordsManagementActionService.getRecordsManagementActionConditions()
-
getDispositionActions
public List<RecordsManagementAction> getDispositionActions(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Gets the disposition actions for the given node- Parameters:
nodeRef
- The node reference- Returns:
- List of records management action
-
getDispositionActions
public List<RecordsManagementAction> getDispositionActions()
Description copied from interface:RecordsManagementActionService
Get a list of the available disposition actions. A disposition action is a records management action that can be used when defining disposition instructions.- Specified by:
getDispositionActions
in interfaceRecordsManagementActionService
- Returns:
- List of disposition actions
- See Also:
RecordsManagementActionService.getDispositionActions()
-
getDispositionAction
public RecordsManagementAction getDispositionAction(String name)
Description copied from interface:RecordsManagementActionService
Gets the named disposition action- Specified by:
getDispositionAction
in interfaceRecordsManagementActionService
- Parameters:
name
- The name of the disposition action to retrieve- Returns:
- The RecordsManagementAction or null if it doesn't exist
- See Also:
RecordsManagementActionService.getDispositionAction(java.lang.String)
-
getRecordsManagementAction
public RecordsManagementAction getRecordsManagementAction(String name)
Description copied from interface:RecordsManagementActionService
Gets the named records management action- Specified by:
getRecordsManagementAction
in interfaceRecordsManagementActionService
- Parameters:
name
- The name of the RM action to retrieve- Returns:
- The RecordsManagementAction or null if it doesn't exist
- See Also:
RecordsManagementActionService.getRecordsManagementAction(java.lang.String)
-
executeRecordsManagementAction
public RecordsManagementActionResult executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef nodeRef, String name)
Description copied from interface:RecordsManagementActionService
Execute a records management action- Specified by:
executeRecordsManagementAction
in interfaceRecordsManagementActionService
- Parameters:
nodeRef
- node reference to a rm container, rm folder or recordname
- action name- Returns:
- The result of executed records management action
- See Also:
RecordsManagementActionService.executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)
-
executeRecordsManagementAction
public Map<org.alfresco.service.cmr.repository.NodeRef,RecordsManagementActionResult> executeRecordsManagementAction(List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs, String name)
Description copied from interface:RecordsManagementActionService
Execute a records management action against several nodes- Specified by:
executeRecordsManagementAction
in interfaceRecordsManagementActionService
- Parameters:
nodeRefs
- node references to rm containers, rm folders or recordsname
- action name- Returns:
- The result of executed records management action against several nodes
- See Also:
RecordsManagementActionService.executeRecordsManagementAction(java.util.List, java.lang.String)
-
executeRecordsManagementAction
public RecordsManagementActionResult executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef nodeRef, String name, Map<String,Serializable> parameters)
Description copied from interface:RecordsManagementActionService
Execute a records management action- Specified by:
executeRecordsManagementAction
in interfaceRecordsManagementActionService
- Parameters:
nodeRef
- node reference to a rm container, rm folder or recordname
- action nameparameters
- action parameters- Returns:
- The result of executed records management action
- See Also:
RecordsManagementActionService.executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.util.Map)
-
executeRecordsManagementAction
public RecordsManagementActionResult executeRecordsManagementAction(String name, Map<String,Serializable> parameters)
Description copied from interface:RecordsManagementActionService
Execute a records management action. The nodeRef against which the action is to be executed must be provided by the RecordsManagementAction implementation.- Specified by:
executeRecordsManagementAction
in interfaceRecordsManagementActionService
- Parameters:
name
- action nameparameters
- action parameters- Returns:
- The result of executed records management action
- See Also:
RecordsManagementActionService.executeRecordsManagementAction(java.lang.String, java.util.Map)
-
executeRecordsManagementAction
public Map<org.alfresco.service.cmr.repository.NodeRef,RecordsManagementActionResult> executeRecordsManagementAction(List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs, String name, Map<String,Serializable> parameters)
Description copied from interface:RecordsManagementActionService
Execute a records management action against several nodes- Specified by:
executeRecordsManagementAction
in interfaceRecordsManagementActionService
- Parameters:
nodeRefs
- node references to rm containers, rm folders or recordsname
- action nameparameters
- action parameters- Returns:
- The result of executed records management action against several nodes
- See Also:
RecordsManagementActionService.executeRecordsManagementAction(java.util.List, java.lang.String, java.util.Map)
-
-