oneapi.model.common

Class PolicyException

java.lang.Object

oneapi.model.common.PolicyException

All Implemented Interfaces:

Serializable

public class PolicyException
extends Object
implements Serializable

specific error case indicated by the OneAPI server as a Policy Exception

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PolicyException() default constructor
PolicyException(String messageId, String text, String[] variables) utility constructor to create a ServiceException object with all fields set

Method Summary

Modifier and Type	Method and Description
String	getMessageId() return the distinctive error message identifier
String	getText() return the textual representation of the error
String[]	getVariables() return any instance specific error variables
void	setMessageId(String messageId) set the distinctive error message identifier.
void	setText(String text) set the textual representation of the error.
void	setVariables(String[] variables) set any instance specific error variables.
String	toString() generate a textual representation of the ServiceException instance

Methods inherited from class java.lang.Object

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

Constructor Detail

PolicyException

public PolicyException()

default constructor

PolicyException

public PolicyException(String messageId,
                       String text,
                       String[] variables)

utility constructor to create a ServiceException object with all fields set

Method Detail

getMessageId

public String getMessageId()

return the distinctive error message identifier

getText

public String getText()

return the textual representation of the error

getVariables

public String[] getVariables()

return any instance specific error variables

setMessageId

public void setMessageId(String messageId)

set the distinctive error message identifier. This is called internally to set the contents according to the JSON response.

setText

public void setText(String text)

set the textual representation of the error. This is called internally to set the contents according to the JSON response.

setVariables

public void setVariables(String[] variables)

set any instance specific error variables. This is called internally to set the contents according to the JSON response.

toString

public String toString()

generate a textual representation of the ServiceException instance

Overrides:

toString in class Object