Package org.alfresco.repo.action.scheduled

Class AbstractScheduledAction

java.lang.Object
org.alfresco.repo.action.scheduled.AbstractScheduledAction
All Implemented Interfaces:
ScheduledActionDefinition, org.springframework.beans.factory.InitializingBean
Direct Known Subclasses:
CronScheduledQueryBasedTemplateActionDefinition
public abstract class AbstractScheduledAction extends Object implements ScheduledActionDefinition
Abstract action support. Each action applies to a set of nodes. These actions may be executed in one overall transaction or one individual transaction. If actions are in individual transactions an error may halt subsequent execution or processing can try and invoke the action for each node.
Author:
Andy Hind

  • Constructor Details

    • AbstractScheduledAction

      public AbstractScheduledAction()
      Simple constructor

  • Method Details

    • getRunAsUser

      public String getRunAsUser()
      Get the user in whose name to run the action.
      Returns:
      - the user as whom to run the action

    • setRunAsUser

      public void setRunAsUser(String runAsUser)
      Set the user in whose name to run the action.
      Parameters:
      runAsUser - String

    • getTemplateActionDefinition

      public TemplateActionDefinition getTemplateActionDefinition()
      Get the template definition.
      Specified by:
      getTemplateActionDefinition in interface ScheduledActionDefinition
      Returns:
      - the template action definition

    • setActionService

      public void setActionService(ActionService actionService)
      Set the action service - IOC.
      Parameters:
      actionService - ActionService

    • getActionService

      public ActionService getActionService()
      Get the actions service.
      Returns:
      - the action service

    • setCompensatingActionMode

      public void setCompensatingActionMode(String compensatingActionModeString)
      Set the behaviour for compensating actiions.
      Parameters:
      compensatingActionModeString - String

    • setTransactionMode

      public void setTransactionMode(String transactionModeString)
      Set transactional behaviour.
      Parameters:
      transactionModeString - String

    • getTransactionService

      public TransactionService getTransactionService()
      Get the transaction service.
      Returns:
      - the transaction service.

    • setTransactionService

      public void setTransactionService(TransactionService transactionService)
      Set the transactions service - IOC.
      Parameters:
      transactionService - TransactionService

    • setTemplateActionDefinition

      public void setTemplateActionDefinition(TemplateActionDefinition templateActionDefinition)
      Set the template action that is used to generate the real action for each node.
      Specified by:
      setTemplateActionDefinition in interface ScheduledActionDefinition
      Parameters:
      templateActionDefinition - TemplateActionDefinition

    • getCompensatingActionModeEnum

      public AbstractScheduledAction.CompensatingActionMode getCompensatingActionModeEnum()
      Get the behaviour for compensating actions.
      Returns:
      - the compensating action mode.

    • getTransactionModeEnum

      public AbstractScheduledAction.TransactionMode getTransactionModeEnum()
      Get the transaction mode.
      Returns:
      - the transaction mode.

    • register

      public void register(org.quartz.Scheduler scheduler) throws org.quartz.SchedulerException
      Register with teh scheduler.
      Specified by:
      register in interface ScheduledActionDefinition
      Parameters:
      scheduler - Scheduler
      Throws:
      org.quartz.SchedulerException

    • getTrigger

      public abstract org.quartz.Trigger getTrigger()
      Get the trigger definition for this job. Used to register with the injected scheduler.
      Returns:
      - the trigger definition for this scheduled action.

    • getNodes

      public abstract List<NodeRef> getNodes()
      Get the list of nodes against which this action should run.
      Returns:
      - the list of node refs for which to run this action.

    • getAction

      public abstract Action getAction(NodeRef nodeRef)
      Generate the actual action for the given node from the action template.
      Parameters:
      nodeRef - NodeRef
      Returns:
      - the action to execute.