atg.process.action
Class ActionException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          atg.process.action.ActionException

All Implemented Interfaces:

ActionConstants, java.io.Serializable

public class ActionException
extends java.lang.Exception
implements ActionConstants

An exception that can occur when executing a process Action, either on a single process instance, or on a batch of instances.

See Also:

Action, Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from interface atg.process.action.ActionConstants

ERROR_RESPONSE_CONTINUE, ERROR_RESPONSE_DEFAULT, ERROR_RESPONSE_DELETE, ERROR_RESPONSE_INSTANCE_DELETED, ERROR_RESPONSE_RETRY, EXECUTION_POLICY_COLLECTIVE, EXECUTION_POLICY_INDIVIDUAL

Constructor Summary

ActionException(FailedActionInfo pFailedActionInfo)
Constructs a new ActionException with the given FailedActionInfo, representing failure to execute an action for a single process instance.

ActionException(FailedActionInfo[] pFailedActionInfos)
Constructs a new ActionException with the given array of FailedActionInfo objects, each of which represents failure to execute an action for a single process instance.

ActionException(FailedActionInfo[] pFailedActionInfos, int pErrorResponse)
Constructs a new ActionException with the given array of FailedActionInfo objects and error response.

ActionException(FailedActionInfo pFailedActionInfo, int pErrorResponse)
Constructs a new ActionException with the given FailedActionInfo and error response.

Method Summary

int	getErrorResponse() Returns the desired error response.
FailedActionInfo[]	getFailedActionInfos() Returns the array of FailedActionInfo objects, each of which represents failure to execute an action for a single process instance.
java.lang.String	getMessage()
void	setErrorResponse(int pErrorResponse) Sets the error response.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ActionException

public ActionException(FailedActionInfo pFailedActionInfo)

Constructs a new ActionException with the given FailedActionInfo, representing failure to execute an action for a single process instance.

ActionException

public ActionException(FailedActionInfo pFailedActionInfo,
                       int pErrorResponse)

Constructs a new ActionException with the given FailedActionInfo and error response.

ActionException

public ActionException(FailedActionInfo[] pFailedActionInfos)

Constructs a new ActionException with the given array of FailedActionInfo objects, each of which represents failure to execute an action for a single process instance.

ActionException

public ActionException(FailedActionInfo[] pFailedActionInfos,
                       int pErrorResponse)

Constructs a new ActionException with the given array of FailedActionInfo objects and error response.

Method Detail

getErrorResponse

public int getErrorResponse()

Returns the desired error response. If no error response was explicitly specified, returns ERROR_RESPONSE_DEFAULT, indicating that the default value from the action registry should be used.

setErrorResponse

public void setErrorResponse(int pErrorResponse)

Sets the error response.

getFailedActionInfos

public FailedActionInfo[] getFailedActionInfos()

Returns the array of FailedActionInfo objects, each of which represents failure to execute an action for a single process instance.

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

See Also:

Throwable.getMessage()