Package com.appiancorp.suiteapi.process
Class ProcessExceptionType
java.lang.Object
com.appiancorp.suiteapi.process.ProcessExceptionType
- All Implemented Interfaces:
Serializable
Metadata about a class of process exceptions (errors that occur while a process is executing).
- See Also:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
int
Gets the type of object to which exceptions of this type are attached, which should beTYPEBPMPROCESS
,TYPEBPMTASK
, orTYPEBPMNODE
.Gets a description of this exception type.Gets the primary key for this exception type.Gets the id of the note that holds the message for this exception type.Gets the action that the system recommends the user take in response to exceptions of this type.int
hashCode()
boolean
Determines whether process administrators are notified when exceptions of this type occur.boolean
Determines whether the process initiator is notified when exceptions of this type occur.boolean
Determines whether the system administrators are notified when exceptions of this type occur.boolean
Determines whether users who have accepted the task on which the error occurred are notified when exceptions of this type occur.void
setAttachedToType
(int attachedToType) Sets the type of object to which exceptions of this type are attached, which should beTYPEBPMPROCESS
,TYPEBPMTASK
, orTYPEBPMNODE
.void
setDescription
(String description) Sets the description of this exception type.void
setLocalId
(String localId) Sets the primary key for this exception type.void
setNoteContent
(String noteContent) void
Sets the id of the note that holds the message for this exception type.void
setNotifyProcessAdministrators
(boolean notifyProcessAdministrators) Sets whether process administrators are notified when exceptions of this type occur.void
setNotifyProcessInitiator
(boolean notifyProcessInitiator) Sets whether the process initiator is notified when exceptions of this type occur.void
setNotifySystemAdministrators
(boolean notifySystemAdministrators) Sets whether the system administrators are notified when exceptions of this type occur.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.void
setRecommendedAction
(String recommendedAction) Sets the action that the system recommends the user take in response to exceptions of this type.toString()
-
Field Details
-
SORT_BY_LOCAL_ID
-
SORT_BY_ATTACHED_TO_TYPE
-
SORT_BY_DESCRIPTION
-
SORT_BY_RECOMMENDED_ACTION
-
SORT_BY_NOTIFY_PROCESS_INITIATOR
-
SORT_BY_NOTIFY_PROCESS_ADMINS
-
SORT_BY_NOTIFY_SYSTEM_ADMINS
-
SORT_BY_NOTIFY_TASK_ACCEPTOR
-
SORT_BY_NOTE_ID
-
-
Constructor Details
-
ProcessExceptionType
public ProcessExceptionType()
-
-
Method Details
-
getDescription
Gets a description of this exception type.- Returns:
- a description of this exception type.
-
setDescription
Sets the description of this exception type.- Parameters:
description
- the description of the exception type.
-
getRecommendedAction
Gets the action that the system recommends the user take in response to exceptions of this type.- Returns:
- the recommended action.
-
setRecommendedAction
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 beTYPEBPMPROCESS
,TYPEBPMTASK
, orTYPEBPMNODE
.- 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 beTYPEBPMPROCESS
,TYPEBPMTASK
, orTYPEBPMNODE
.- See Also:
-
getLocalId
Gets the primary key for this exception type.- Returns:
- the primary key for this exception type.
-
setLocalId
Sets the primary key for this exception type.- Parameters:
localId
- the primary key for this exception type.
-
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
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
-
setNoteContent
-
hashCode
public int hashCode() -
equals
-
toString
-