Package com.appiancorp.suiteapi.type.exceptions

Class ImportException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.appiancorp.suiteapi.common.exceptions.AppianException

com.appiancorp.exceptions.AppianException

com.appiancorp.suiteapi.type.exceptions.ImportException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InvalidXsdException, UnsupportedXsdException, XsdImportEcoreSaveException

public class ImportException
extends AppianException

Thrown when a new type could not be imported.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ErrorCode	_errorCode
protected Object[]	_errorCodeArguments

Constructor Summary

Constructors

Constructor	Description
ImportException(ImportDiagnostic[] diagnostics_, ErrorCode errorCode_)	Constructs a new exception with the specified error code and import diagnostics.
ImportException(ImportDiagnostic[] diagnostics_, ErrorCode errorCode_, Object[] errorCodeArguments_)	Constructs a new exception with the specified error code and import diagnostics.
ImportException(ImportDiagnostic[] diagnostics_, ErrorCode errorCode_, Object[] errorCodeArguments_, Throwable cause_)	Constructs a new exception with the specified error code and import diagnostics.

Method Summary

Modifier and Type	Method	Description
ImportDiagnostic[]	getDiagnostics()	Retrieves the diagnostics that were generated during the attempted import.
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.
boolean	hasSameErrorCodeAndArguments(ImportException e)	Checks whether the specified ImportException has the same error code and error code arguments as this object.
void	setDiagnostics(ImportDiagnostic[] diagnostics_)	Sets the diagnostics that are associated with the ImportException.

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 Details

_errorCode

protected ErrorCode _errorCode

_errorCodeArguments

protected Object[] _errorCodeArguments

Constructor Details

ImportException

public ImportException(ImportDiagnostic[] diagnostics_,
 ErrorCode errorCode_)

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

Parameters:

diagnostics_ - the diagnostics that were generated during the attempted import

errorCode_ - the ErrorCode associated with the exception

ImportException

public ImportException(ImportDiagnostic[] diagnostics_,
 ErrorCode errorCode_,
 Object[] errorCodeArguments_)

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

Parameters:

diagnostics_ - the diagnostics that were generated during the attempted import

errorCode_ - the ErrorCode associated with the exception

errorCodeArguments_ - the arguments that must be used to render this exception's message representation

ImportException

public ImportException(ImportDiagnostic[] diagnostics_,
 ErrorCode errorCode_,
 Object[] errorCodeArguments_,
 Throwable cause_)

Constructs a new exception with the specified error code and import diagnostics.

Parameters:

diagnostics_ - the diagnostics that were generated during the attempted import

errorCode_ - the ErrorCode associated with the exception

errorCodeArguments_ - the arguments that must be used to render this exception's message representation

cause_ - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Method Details

getErrorCode

public ErrorCode getErrorCode()

Gets the error code associated with this exception.

Overrides:

getErrorCode in class AppianException

See Also:

• ErrorCode.GENERIC_ERROR

getErrorCodeArguments

protected Object[] getErrorCodeArguments()

Gets the arguments that must be used to render this exception's message representation.

Overrides:

getErrorCodeArguments in class AppianException

Returns:

the arguments of the error code tied to this exception

See Also:

• ErrorCode.GENERIC_ERROR

hasSameErrorCodeAndArguments

public boolean hasSameErrorCodeAndArguments(ImportException e)

Checks whether the specified ImportException has the same error code and error code arguments as this object.

Parameters:

e - an ImportException instance

Returns:

true if the same, false otherwise

getDiagnostics

public ImportDiagnostic[] getDiagnostics()

Retrieves the diagnostics that were generated during the attempted import.

Returns:

the diagnostics

setDiagnostics

public void setDiagnostics(ImportDiagnostic[] diagnostics_)

Sets the diagnostics that are associated with the ImportException.

Parameters:

diagnostics_ - the diagnostics that were generated during the attempted import