Package com.nuix.superutilities.cases
Class WorkFunctionErrorEvent
- java.lang.Object
-
- com.nuix.superutilities.cases.WorkFunctionErrorEvent
-
public class WorkFunctionErrorEvent extends java.lang.ObjectThis class is used to provide a callback information regarding an exception encountered byBulkCaseProcessorwhile executing code provided in user code. This class also provides a way for that callback to instructBulkCaseProcessorhow to react to this.
-
-
Constructor Summary
Constructors Constructor Description WorkFunctionErrorEvent(CaseInfo erroredCaseInfo, java.lang.Exception functionError)Creates a new instance
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidabort()NotifiesBulkCaseProcessorthat all further processing should be abortedCaseInfogetCaseInfo()Gets information related to case which was lockedjava.lang.ExceptiongetError()Gets the exception thrownCaseIssueReactiongetReaction()Gets the reaction that should be takenvoidsetReaction(CaseIssueReaction reaction)Sets the reaction that should be taken Note that a value of CaseIssueReaction.Retry makes not sense in this context and should be considered invalid.voidskipCase()NotifiesBulkCaseProcessorthat this case should be skipped in response
-
-
-
Constructor Detail
-
WorkFunctionErrorEvent
public WorkFunctionErrorEvent(CaseInfo erroredCaseInfo, java.lang.Exception functionError)
Creates a new instance- Parameters:
erroredCaseInfo- Information about the case open when the error occurredfunctionError- The exception which was thrown
-
-
Method Detail
-
getCaseInfo
public CaseInfo getCaseInfo()
Gets information related to case which was locked- Returns:
- Information related to case which was locked
-
getReaction
public CaseIssueReaction getReaction()
Gets the reaction that should be taken- Returns:
- The reaction to take
-
setReaction
public void setReaction(CaseIssueReaction reaction)
Sets the reaction that should be taken Note that a value of CaseIssueReaction.Retry makes not sense in this context and should be considered invalid.- Parameters:
reaction- The reaction to take
-
getError
public java.lang.Exception getError()
Gets the exception thrown- Returns:
- The exception which was thrown
-
skipCase
public void skipCase()
NotifiesBulkCaseProcessorthat this case should be skipped in response
-
abort
public void abort()
NotifiesBulkCaseProcessorthat all further processing should be aborted
-
-