Package com.appiancorp.suiteapi.process

Class ProcessExceptionType

java.lang.Object
com.appiancorp.suiteapi.process.ProcessExceptionType
All Implemented Interfaces:
Serializable
public class ProcessExceptionType extends Object implements Serializable
Metadata about a class of process exceptions (errors that occur while a process is executing).
See Also:

  • Field Details

    • SORT_BY_LOCAL_ID

      public static final Integer SORT_BY_LOCAL_ID

    • SORT_BY_ATTACHED_TO_TYPE

      public static final Integer SORT_BY_ATTACHED_TO_TYPE

    • SORT_BY_DESCRIPTION

      public static final Integer SORT_BY_DESCRIPTION

    • SORT_BY_NOTIFY_PROCESS_INITIATOR

      public static final Integer SORT_BY_NOTIFY_PROCESS_INITIATOR

    • SORT_BY_NOTIFY_PROCESS_ADMINS

      public static final Integer SORT_BY_NOTIFY_PROCESS_ADMINS

    • SORT_BY_NOTIFY_SYSTEM_ADMINS

      public static final Integer SORT_BY_NOTIFY_SYSTEM_ADMINS

    • SORT_BY_NOTIFY_TASK_ACCEPTOR

      public static final Integer SORT_BY_NOTIFY_TASK_ACCEPTOR

    • SORT_BY_NOTE_ID

      public static final Integer SORT_BY_NOTE_ID

  • Constructor Details

    • ProcessExceptionType

      public ProcessExceptionType()

  • Method Details

    • getDescription

      public String getDescription()
      Gets a description of this exception type.
      Returns:
      a description of this exception type.

    • setDescription

      public void setDescription(String description)
      Sets the description of this exception type.
      Parameters:
      description - the description of the exception type.

    • getRecommendedAction

      public String getRecommendedAction()
      Gets the action that the system recommends the user take in response to exceptions of this type.
      Returns:
      the recommended action.

    • setRecommendedAction

      public void setRecommendedAction(String recommendedAction)
      Sets the action that the system recommends the user take in response to exceptions of this type.
      Parameters:
      recommendedAction - the recommended action.

    • getAttachedToType

      public int getAttachedToType()
      Gets the type of object to which exceptions of this type are attached, which should be TYPEBPMPROCESS, TYPEBPMTASK, or TYPEBPMNODE.
      Returns:
      the type of object to which this exception is attached.
      See Also:

    • setAttachedToType

      public void setAttachedToType(int attachedToType)
      Sets the type of object to which exceptions of this type are attached, which should be TYPEBPMPROCESS, TYPEBPMTASK, or TYPEBPMNODE.
      See Also:

    • getLocalId

      public String getLocalId()
      Gets the primary key for this exception type.
      Returns:
      the primary key for this exception type.

    • setLocalId

      public void setLocalId(String localId)
      Sets the primary key for this exception type.
      Parameters:
      localId - the primary key for this exception type.

    • getNoteId

      public Long getNoteId()
      Gets the id of the note that holds the message for this exception type.
      Returns:
      the id of the note that holds the message for this exception type.

    • setNoteId

      public void setNoteId(Long noteId)
      Sets the id of the note that holds the message for this exception type.
      Parameters:
      noteId - the id of the note that holds the message for this exception type.

    • isNotifyProcessAdministrators

      public boolean isNotifyProcessAdministrators()
      Determines whether process administrators are notified when exceptions of this type occur.
      Returns:
      true if the administrators are notified, false if they are not notified.

    • setNotifyProcessAdministrators

      public void setNotifyProcessAdministrators(boolean notifyProcessAdministrators)
      Sets whether process administrators are notified when exceptions of this type occur.
      Parameters:
      notifyProcessAdministrators - true if the administrators are notified, false if they are not notified.

    • isNotifyProcessInitiator

      public boolean isNotifyProcessInitiator()
      Determines whether the process initiator is notified when exceptions of this type occur.
      Returns:
      true if the initiator is notified, false if he or she is not notified.

    • setNotifyProcessInitiator

      public void setNotifyProcessInitiator(boolean notifyProcessInitiator)
      Sets whether the process initiator is notified when exceptions of this type occur.
      Parameters:
      notifyProcessInitiator - true if the initiator is notified, false if he or she is not notified.

    • isNotifySystemAdministrators

      public boolean isNotifySystemAdministrators()
      Determines whether the system administrators are notified when exceptions of this type occur.
      Returns:
      true if the administrators are notified, false if they are not notified.

    • setNotifySystemAdministrators

      public void setNotifySystemAdministrators(boolean notifySystemAdministrators)
      Sets whether the system administrators are notified when exceptions of this type occur.

    • isNotifyTaskAcceptor

      public boolean isNotifyTaskAcceptor()
      Determines whether users who have accepted the task on which the error occurred are notified when exceptions of this type occur.
      Returns:
      true if the acceptors are notified, false if they are not notified.

    • setNotifyTaskAcceptor

      public void setNotifyTaskAcceptor(boolean notifyTaskAcceptor)
      Sets whether users who have accepted the task on which the error occurred are notified when exceptions of this type occur.
      Parameters:
      notifyTaskAcceptor - true if the acceptors are notified, false if they are not notified.

    • getNoteContent

      public String getNoteContent()

    • setNoteContent

      public void setNoteContent(String noteContent)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object