org.alfresco.module.org_alfresco_module_rm.action

Interface RecordsManagementActionService

All Known Implementing Classes:

RecordsManagementActionServiceImpl

public interface RecordsManagementActionService

Records management action service interface

Author:

Roy Wetherall

Method Summary

Modifier and Type	Method and Description
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 nodes
Map<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 nodes
RecordsManagementActionResult	executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef nodeRef, String name) Execute a records management action
RecordsManagementActionResult	executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef nodeRef, String name, Map<String,Serializable> parameters) Execute a records management action
RecordsManagementActionResult	executeRecordsManagementAction(String name, Map<String,Serializable> parameters) Execute a records management action.
RecordsManagementAction	getDispositionAction(String name) Gets the named disposition action
List<RecordsManagementAction>	getDispositionActions() Get a list of the available disposition actions.
RecordsManagementAction	getRecordsManagementAction(String name) Gets the named records management action
List<RecordsManagementActionCondition>	getRecordsManagementActionConditions()
List<RecordsManagementAction>	getRecordsManagementActions() Get a list of the available records management actions
void	register(RecordsManagementAction rmAction) Register records management action
void	register(RecordsManagementActionCondition rmCondition)

Method Detail

getRecordsManagementActions

List<RecordsManagementAction> getRecordsManagementActions()

Get a list of the available records management actions

Returns:

List records management actions

getRecordsManagementActionConditions

List<RecordsManagementActionCondition> getRecordsManagementActionConditions()

Returns:

Since:

2.1

getDispositionActions

List<RecordsManagementAction> getDispositionActions()

Get a list of the available disposition actions. A disposition action is a records management action that can be used when defining disposition instructions.

Returns:

List disposition actions

getRecordsManagementAction

RecordsManagementAction getRecordsManagementAction(String name)

Gets the named records management action

Parameters:

name - The name of the RM action to retrieve

Returns:

The RecordsManagementAction or null if it doesn't exist

getDispositionAction

RecordsManagementAction getDispositionAction(String name)

Gets the named disposition action

Parameters:

name - The name of the disposition action to retrieve

Returns:

The RecordsManagementAction or null if it doesn't exist

executeRecordsManagementAction

RecordsManagementActionResult executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                             String name)

Execute a records management action

Parameters:

nodeRef - node reference to a rm container, rm folder or record

name - action name

executeRecordsManagementAction

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 nodes

Parameters:

nodeRefs - node references to rm containers, rm folders or records

name - action name

executeRecordsManagementAction

RecordsManagementActionResult executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                             String name,
                                                             Map<String,Serializable> parameters)

Execute a records management action

Parameters:

nodeRef - node reference to a rm container, rm folder or record

name - action name

parameters - action parameters

executeRecordsManagementAction

Map<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 nodes

Parameters:

nodeRefs - node references to rm containers, rm folders or records

name - action name

parameters - action parameters

executeRecordsManagementAction

RecordsManagementActionResult executeRecordsManagementAction(String name,
                                                             Map<String,Serializable> parameters)

Execute a records management action. The nodeRef against which the action is to be executed must be provided by the RecordsManagementAction implementation.

Parameters:

name - action name

parameters - action parameters

register

void register(RecordsManagementAction rmAction)

Register records management action

Parameters:

rmAction - records management action

register

void register(RecordsManagementActionCondition rmCondition)

Parameters:

rmCondition -

Since:

2.1