Package de.uplanet.lucy.server.workflow

Interface IWorkflowAction

All Superinterfaces:
IActivatableWorkflowObject, IWorkflowObject, Serializable
All Known Implementing Classes:
AbstractDataGroupWorkflowAction, AbstractExpendableTimerWorkflowAction, AbstractGroupAdministrationWorkflowAction, AbstractImpersonateWorkflowAction, AbstractJMSMessageProducerWorkflowAction, AbstractPluginFeedWorkflowAction, AbstractReportWorkflowAction, AbstractSharePushNotificationWorkflowAction, AbstractSynchronizeGroupMembersWorkflowAction, AbstractSynchronizeGroupModeratorsWorkflowAction, AbstractTextFeedWorkflowAction, AbstractTimerWorkflowAction, AbstractTriggerSubsequentWorkflowEventsWorkflowAction, AbstractWorkflowAction, AppendNewGroupMembersWorkflowAction, AppendNewGroupModeratorsWorkflowAction, CheckPermissionWorkflowAction, CreateGroupWorkflowAction, CreatePluginFeedWorkflowAction, CreateRecordDataGroupWorkflowAction, CreateRecordReportWorkflowAction, DeleteGroupMembersWorkflowAction, DeleteGroupWorkflowAction, DeletePluginFeedWorkflowAction, DeleteRecordDataGroupWorkflowAction, DisableTriggerSubsequentWorkflowEventsWorkflowAction, EnableTriggerSubsequentWorkflowEventsWorkflowAction, ExpendableTimerDataGroupWorkflowAction, ExpendableTimerWorkflowAction, GroovyScriptWorkflowAction, GroupReadOnlyWorkflowAction, GroupTextFeedWorkflowAction, HypArchiveImpersonateWorkflowAction, ImpersonateWorkflowAction, IncludeWorkflowAction, IxBrokerWorkflowAction, JdbcExecuteUpdateWorkflowAction, JMSQueueMessageProducerWorkflowAction, JMSTopicMessageProducerWorkflowAction, LoggerWorkflowAction, MergePluginFeedWorkflowAction, MQTTMessageProducerWorkflowAction, MSExchangeImpersonateWorkflowAction, MsTeamsCreateGroupWorkflowAction, MsTeamsCreateMeetingWorkflowAction, MsTeamsCreateTeamWorkflowAction, MsTeamsMessageWorkflowAction, NoopWorkflowAction, ODataImpersonateWorkflowAction, PushNotificationWorkflowAction, ReplaceGroupMembersWorkflowAction, ReplaceGroupModeratorsWorkflowAction, RollbackTransactionWorkflowAction, SendMailWorkflowAction, ShareFrequencyPushNotificationWorkflowAction, ShareGroupEventLinkPatcherWorkflowAction, ShareGroupModeratorPatcherWorkflowAction, ShareImmediatelyPushNotificationWorkflowAction, SharePhotoAlbumPatcherWorkflowAction, ShareUserSynchronisationPatcherWorkflowAction, ShutdownPortalServiceWorkflowAction, SleepWorkflowAction, StartSchedulerJobWorkflowAction, StopWorkflowAction, SystemMessageWorkflowAction, TextFeedWorkflowAction, ThrowExceptionWorkflowAction, TimerDataGroupWorkflowAction, TimerWorkflowAction, TouchSessionWorkflowAction, UDPSendDatagramWorkflowAction, UpdateGroupModeratorWorkflowAction, UpdatePluginFeedWorkflowAction, UpdateRecordDataGroupWorkflowAction, UpdateRecordReportWorkflowAction, VelocityWorkflowAction, WebServiceWorkflowAction, WebSocketWorkflowAction, WorkflowActivateWorkflowAction
public interface IWorkflowAction extends IWorkflowObject, IActivatableWorkflowObject
This is the interface for workflow actions.

Classes that implement this interface should have the WorkflowAction name suffix.

Since:
Intrexx 5.0.

  • Method Details

    • getAfferentTransition

      WorkflowTransition getAfferentTransition()
      Get the afferent transition of this workflow action.
      Returns:
      The afferent transition (this is normally not null).

    • setAfferentTransition

      void setAfferentTransition(WorkflowTransition p_wfTransition)
      Set the afferent transition of this workflow action.
      Parameters:
      p_wfTransition - The transition to be set.

    • getEfferentTransition

      WorkflowTransition getEfferentTransition()
      Get the efferent transition of this workflow action.
      Returns:
      The efferent transition, or null.

    • setEfferentTransition

      void setEfferentTransition(WorkflowTransition p_wfTransition)
      Set the efferent transition of this workflow action.
      Parameters:
      p_wfTransition - The transition to be set.

    • isActive

      boolean isActive()
      Check if this workflow action is active or inactive.

      See process(IWorkflowEvent, IWorkflowProcessingContext, IProcessingContext) for the general contract of the activation state.

      Specified by:
      isActive in interface IActivatableWorkflowObject
      Returns:
      The activation state of this workflow action.

    • setActive

      void setActive(boolean p_bActive)
      Set this workflow action active or inactive.

      See process(IWorkflowEvent, IWorkflowProcessingContext, IProcessingContext) for the general contract of the activation state.

      Specified by:
      setActive in interface IActivatableWorkflowObject
      Parameters:
      p_bActive - The new activation state to be set.

    • process

      WorkflowTransition process(IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx, de.uplanet.lucy.server.IProcessingContext p_ctx) throws InterruptedException, Exception
      Process a workflow event in the given context.

      Normally, a workflow action should return its efferent transition, regardless whether it is active, or not.

      Parameters:
      p_evt - The event to be processed.
      p_wfCtx - The workflow processing context.
      p_ctx - The processing context.
      Returns:
      The efferent transition, or null.
      Throws:
      InterruptedException - If processing of this action has been interrupted.
      Exception - If an error occurred.