Package org.alfresco.module.org_alfresco_module_rm.action

Interface RecordsManagementActionService

All Known Implementing Classes:
RecordsManagementActionServiceImpl
@AlfrescoPublicApi public interface RecordsManagementActionService
Records management action service interface
Author:
Roy Wetherall

  • Method Details

    • getRecordsManagementActions

      List<RecordsManagementAction> getRecordsManagementActions()
      Get a list of the available records management actions
      Returns:
      List of records management actions

    • getRecordsManagementActionConditions

      List<RecordsManagementActionCondition> getRecordsManagementActionConditions()
      Get a list of the available records management action conditions
      Returns:
      List of records management action conditions
      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 of 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(NodeRef nodeRef, String name)
      Execute a records management action
      Parameters:
      nodeRef - node reference to a rm container, rm folder or record
      name - action name
      Returns:
      The result of executed records management action

    • executeRecordsManagementAction

      Map<NodeRef,RecordsManagementActionResult> executeRecordsManagementAction(List<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
      Returns:
      The result of executed records management action against several nodes

    • executeRecordsManagementAction

      RecordsManagementActionResult executeRecordsManagementAction(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
      Returns:
      The result of executed records management action

    • executeRecordsManagementAction

      Map<NodeRef,RecordsManagementActionResult> executeRecordsManagementAction(List<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
      Returns:
      The result of executed records management action against several nodes

    • 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
      Returns:
      The result of executed records management action

    • register

      void register(RecordsManagementAction rmAction)
      Register records management action
      Parameters:
      rmAction - records management action

    • register

      void register(RecordsManagementActionCondition rmCondition)
      Register records management condition
      Parameters:
      rmCondition - records management condition
      Since:
      2.1