Package com.highdeal.admin.hci

Class ConstraintViolationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.admin.hci.ConstraintViolationException

All Implemented Interfaces:

OperationResult, XMLMarshallable, Serializable

public class ConstraintViolationException
extends OperationFailureException

This class implement the methods for the description of an unknown parameter exception.
Such an exception is thrown when trying to access the value of a parameter that does not exist.

See Also:

• Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="constraintViolationException">
  <xs:complexType>
     <xs:attribute name="parameterName" type="xs:string" use="required"/>
     <xs:attribute name="parameterValue" type="xs:string" use="optional"/>
     <xs:attribute name="message" type="xs:string" use="required"/>
   </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MESSAGE	The parameter message key.
static final String	OPERATION_NAME	The operation name
static final String	PARAM_NAME	The parameter name key.
static final String	PARAM_VALUE	The parameter value.

Constructor Summary

Constructors

Constructor	Description
ConstraintViolationException()
ConstraintViolationException(String parameterName, String parameterValue, String message)	Creates an ConstraintViolationException initialized with: a parameter name a parameter value (optional) a error message

Method Summary

Modifier and Type	Method	Description
void	addCharacterData(String cData)	Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child)	Adds a child to the object, the child representing the marshallable object which must be added to the element.
String	getMessage()
String	getOperandReference()	Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
String	getParameterName()	Gets the parameter name wanted and not found.
String	getParameterValue()	Gets the parameter value.
void	marshal(XMLOutputter output)	Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts)	Sets the attributes of the XML representation of the element being processed.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

OPERATION_NAME

public static final String OPERATION_NAME

The operation name

See Also:

• Constant Field Values

PARAM_NAME

public static final String PARAM_NAME

The parameter name key.

See Also:

• Constant Field Values

PARAM_VALUE

public static final String PARAM_VALUE

The parameter value.

See Also:

• Constant Field Values

MESSAGE

public static final String MESSAGE

The parameter message key.

See Also:

• Constant Field Values

Constructor Details

ConstraintViolationException

public ConstraintViolationException()

ConstraintViolationException

public ConstraintViolationException(String parameterName,
 String parameterValue,
 String message)

Creates an ConstraintViolationException initialized with:

• a parameter name
• a parameter value (optional)
• a error message

Parameters:

parameterName - the name of the parameter not found

parameterValue - the value of the parameter not found

message - the error message

Method Details

getParameterName

public String getParameterName()

Gets the parameter name wanted and not found.

Returns:

the parameter name

getParameterValue

public String getParameterValue()

Gets the parameter value.

Returns:

the parameter value

getOperandReference

public String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Specified by:

getOperandReference in interface OperationResult

Overrides:

getOperandReference in class OperationFailureException

Returns:

The operand reference of the operation result

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

addCharacterData

public void addCharacterData(String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

addChild

public void addChild(String tagName,
 XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Parameters:

output - The XML output to marshal the object into