com.appiancorp.suiteapi.content.exceptions

Class RenameNotAllowedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.appiancorp.suiteapi.common.exceptions.AppianException

com.appiancorp.suiteapi.content.exceptions.RenameNotAllowedException

All Implemented Interfaces:

java.io.Serializable

public class RenameNotAllowedException
extends AppianException

This exception should be thrown when renaming of a Content (like Rule or Constant) is not allowed in certain scenarios. Since ContentService.createVersion(com.appiancorp.suiteapi.content.Content, Integer) doesn't restrict renaming, this exception should be thrown explicitly if it's allowed for the scenario.

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
RenameNotAllowedException(ErrorCode errorCode)
RenameNotAllowedException(ErrorCode errorCode, java.lang.Object... errorCodeArguments)

Method Summary

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

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

RenameNotAllowedException

public RenameNotAllowedException(ErrorCode errorCode)

RenameNotAllowedException

public RenameNotAllowedException(ErrorCode errorCode,
                                 java.lang.Object... errorCodeArguments)

Method Detail

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

setErrorCodeArguments

public void setErrorCodeArguments(java.lang.Object... errorCodeArguments)

getErrorCodeArguments

protected 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