Package com.avoka.fc.core.entity

Class JobAction

java.lang.Object
org.apache.cayenne.PersistentObject
org.apache.cayenne.BaseDataObject
org.apache.cayenne.CayenneDataObject
com.avoka.core.entity.BaseEntity
com.avoka.fc.core.entity.auto._JobAction
com.avoka.fc.core.entity.JobAction
All Implemented Interfaces:
IEntity, Serializable, org.apache.cayenne.DataObject, org.apache.cayenne.Persistent, org.apache.cayenne.Validating
public class JobAction extends _JobAction
Provides a transaction job action entity. A job action is part of a job step.
Since:
4.0.0
See Also:

  • Field Details

    • EXPIRY_ACTION_NAME

      public static final String EXPIRY_ACTION_NAME
      The "Expiry" action name.
      See Also:

    • STATUS_ASSIGNED

      public static final String STATUS_ASSIGNED
      The Job "Assigned" status. The Task assignment action has completed successfully, but awaiting the user submission to be fully completed.
      See Also:

    • STATUS_CANCELLED

      public static final String STATUS_CANCELLED
      The Job Action "Cancelled" status. The job action is cancelled manually and will never be run again.
      See Also:

    • STATUS_COMPLETED

      public static final String STATUS_COMPLETED
      The Job Action "Completed" status. The job action is completed and will never run again.
      See Also:

    • STATUS_ERROR

      public static final String STATUS_ERROR
      The Job "Error" status. The job action is in an error state (potentially looping) will be executed next time job runs.
      See Also:

    • STATUS_EXPIRED

      public static final String STATUS_EXPIRED
      The Job Action "Expired" status. The job action has expired (automaticallY) and will never run again.
      See Also:

    • STATUS_IN_PROGRESS

      public static final String STATUS_IN_PROGRESS
      The Job Action "In Progress" status. The job action is in progress (looping) and will be executed next time job runs.
      See Also:

    • STATUS_INVOKED

      public static final String STATUS_INVOKED
      The Job Action "Invoked" status. The asynchronous job action has been invoked.
      See Also:

    • STATUS_PENDING

      public static final String STATUS_PENDING
      The Job "Pending" status. The job action is paused and waiting for an external event to move it forward.
      See Also:

    • STATUS_READY

      public static final String STATUS_READY
      The Job Action "Ready" status. The action will be executed next time job runs.
      See Also:

    • STATUS_VALUES

      public static final String[] STATUS_VALUES
      The valid Job Action status values.

    • TYPE_VALUES

      public static final String[] TYPE_VALUES
      The Job Action type values.

  • Constructor Details

    • JobAction

      public JobAction()

  • Method Details

    • isStatusAssigned

      public boolean isStatusAssigned()
      Returns:
      true if the action status is "Assigned"

    • isStatusCompleted

      public boolean isStatusCompleted()
      Returns:
      true if the action status is "Completed"

    • isStatusCancelled

      public boolean isStatusCancelled()
      Returns:
      true if the action status is "Cancelled"

    • isStatusError

      public boolean isStatusError()
      Returns:
      true if the action status is "Error"

    • isStatusExpired

      public boolean isStatusExpired()
      Returns:
      true if the action status is "Expired"

    • isStatusInProgress

      public boolean isStatusInProgress()
      Returns:
      true if the action status is "In Progress"

    • isStatusInvoked

      public boolean isStatusInvoked()
      Returns:
      true if the action status is "Invoked"

    • isStatusPending

      public boolean isStatusPending()
      Returns:
      true if the action status is "Pending"

    • isStatusReady

      public boolean isStatusReady()
      Returns:
      true if the action status is "Ready"

    • isTypeJobAction

      public boolean isTypeJobAction()
      Returns:
      type if type is "Job Action"

    • isTypeJobAsyncActionWait

      public boolean isTypeJobAsyncActionWait()
      Returns:
      type if type is "Job Action Wait"

    • isTypeJobDelivery

      public boolean isTypeJobDelivery()
      Returns:
      type if type is "Job Delivery"

    • isTypeJobDeliveryWait

      public boolean isTypeJobDeliveryWait()
      Returns:
      type if type is "Job Delivery Wait"

    • isTypeJobExpiry

      public boolean isTypeJobExpiry()
      Returns:
      type if type is "Job Expiry"

    • isTypeJobFormStart

      public boolean isTypeJobFormStart()
      Returns:
      type if type is "Job Form Start"

    • isTypeJobReceiptWait

      public boolean isTypeJobReceiptWait()
      Returns:
      type if type is "Job Receipt Wait"

    • isTypeJobTaskAssign

      public boolean isTypeJobTaskAssign()
      Returns:
      type if type is "Job Task Assign"

    • isTypeJobTaskWait

      public boolean isTypeJobTaskWait()
      Returns:
      type if type is "Job Task Wait"

    • isExpiryAction

      public boolean isExpiryAction()
      Returns:
      if an expiry action with the name "Expiry".

    • setType

      public void setType(String type)
      Set the type value.
      Overrides:
      setType in class _JobAction
      Parameters:
      type - the type value to set

    • incrementActionServiceAttempts

      public void incrementActionServiceAttempts()
      Increment the number of action service attempts by one.

    • isActionServiceExecutable

      public boolean isActionServiceExecutable()
      Return true if the action service is ready to execute.
      Returns:
      true if the action service is ready to execute

    • toString

      public String toString()
      Overrides:
      toString in class BaseEntity
      Returns:
      the string representation of this object.