Package com.appiancorp.suiteapi.process.exceptions

Class UnsupportedReportSpecificationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.appiancorp.suiteapi.common.exceptions.AppianException

com.appiancorp.exceptions.AppianException

com.appiancorp.suiteapi.process.exceptions.UnsupportedReportSpecificationException

All Implemented Interfaces:

Serializable

public class UnsupportedReportSpecificationException
extends AppianException

This exception is thrown if the user calls an API method that acts on a report specification and that specification has an unsupported metric, transformation, attribute, etc.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UnsupportedReportSpecificationException.Environment
static enum	UnsupportedReportSpecificationException.ErrorType

Constructor Summary

Constructors

Constructor	Description
UnsupportedReportSpecificationException()	Constructs a new exception with null as its detail message.
UnsupportedReportSpecificationException(UnsupportedReportSpecificationException.Environment env, UnsupportedReportSpecificationException.ErrorType errorType, String message_, String... errorCodeArguments)	Constructs a new exception with the specified detail message.
UnsupportedReportSpecificationException(UnsupportedReportSpecificationException.ErrorType errorType, String message_, String... errorCodeArguments)
UnsupportedReportSpecificationException(String message_)

Method Summary

Modifier and Type	Method	Description
UnsupportedReportSpecificationException.Environment	getEnvironment()
ErrorCode	getErrorCode()	Gets the error code associated with this exception.
protected Object[]	getErrorCodeArguments()	Gets the arguments that must be used to render this exception's message representation.
UnsupportedReportSpecificationException.ErrorType	getErrorType()
void	setEnvironment(UnsupportedReportSpecificationException.Environment env)
void	setErrorType(UnsupportedReportSpecificationException.ErrorType errorType)

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

Constructor Details

UnsupportedReportSpecificationException

public UnsupportedReportSpecificationException()

Constructs a new exception with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable)

UnsupportedReportSpecificationException

public UnsupportedReportSpecificationException(UnsupportedReportSpecificationException.Environment env,
 UnsupportedReportSpecificationException.ErrorType errorType,
 String message_,
 String... errorCodeArguments)

Constructs a new exception with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable)

Parameters:

message_ - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method

UnsupportedReportSpecificationException

public UnsupportedReportSpecificationException(UnsupportedReportSpecificationException.ErrorType errorType,
 String message_,
 String... errorCodeArguments)

UnsupportedReportSpecificationException

public UnsupportedReportSpecificationException(String message_)

Method Details

setEnvironment

public void setEnvironment(UnsupportedReportSpecificationException.Environment env)

getEnvironment

public UnsupportedReportSpecificationException.Environment getEnvironment()

setErrorType

public void setErrorType(UnsupportedReportSpecificationException.ErrorType errorType)

getErrorType

public UnsupportedReportSpecificationException.ErrorType getErrorType()

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

getErrorCodeArguments

protected 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