com.appiancorp.suiteapi.applications

Class InvalidActionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.appiancorp.suiteapi.common.exceptions.AppianException

com.appiancorp.suiteapi.applications.InvalidActionException

All Implemented Interfaces:

java.io.Serializable

public class InvalidActionException
extends AppianException

Exception thrown to indicate an invalid ApplicationAction element. The error code contains the specific information of the issue that produced the exception.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ErrorCode	errorCode
protected java.lang.Object[]	errorCodeArguments

Constructor Summary

Constructors

Constructor and Description
InvalidActionException() Creates a new exception with a default ErrorCode.INVALID_ACTION code.
InvalidActionException(ErrorCode errorCode) Creates a new exception with the passed error code, which indicates the reason of the exception.
InvalidActionException(ErrorCode errorCode, java.lang.String[] errorCodeArguments) Creates a new exception with the passed error code, which indicates the reason of the exception.

Method Summary

Modifier and Type	Method and Description
ErrorCode	getErrorCode() Gets the error code associated with this exception.
java.lang.Object[]	getErrorCodeArguments() Gets the arguments that must be used to render this exception's message representation.

Methods inherited from class com.appiancorp.suiteapi.common.exceptions.AppianException

getErrorCodeArguments, getErrorCodeArgumentsAsStringArray, getLocalizedMessage, getLocalizedMessage, getLocalizedMessageWithErrorCode, getLocalizedTitle, getMessage, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

errorCode

protected ErrorCode errorCode

errorCodeArguments

protected java.lang.Object[] errorCodeArguments

Constructor Detail

InvalidActionException

public InvalidActionException()

Creates a new exception with a default ErrorCode.INVALID_ACTION code.

InvalidActionException

public InvalidActionException(ErrorCode errorCode)

Creates a new exception with the passed error code, which indicates the reason of the exception.

Parameters:

errorCode - The associated error code.

InvalidActionException

public InvalidActionException(ErrorCode errorCode,
                              java.lang.String[] errorCodeArguments)

Creates a new exception with the passed error code, which indicates the reason of the exception. The error code receives the passed parameters.

Parameters:

errorCode - The associated error code.

errorCodeArguments - The error code arguments.

Method Detail

getErrorCodeArguments

public java.lang.Object[] getErrorCodeArguments()

Description copied from class: AppianException

Gets the arguments that must be used to render this exception's message representation. Subclasses should override this method to return specific arguments. The default implementation returns a length 1 array containing the message as returned by the parent class of AppianException. This method is only called when AppianException.getErrorCodeArguments(Locale) hasn't been overwritten.

Overrides:

getErrorCodeArguments in class AppianException

Returns:

the arguments of the error code tied to this exception

See Also:

ErrorCode.GENERIC_ERROR

getErrorCode

public ErrorCode getErrorCode()

Description copied from class: AppianException

Gets the error code associated with this exception. Subclasses should override this method to return specific error codes. The default implementation returns APNX-1-0000-000 (ErrorCode.GENERIC_ERROR).

Overrides:

getErrorCode in class AppianException

See Also:

ErrorCode.GENERIC_ERROR