Package com.highdeal.admin.hci

Class InvalidParameterValueException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.admin.hci.InvalidParameterValueException

All Implemented Interfaces:

OperationResult, XMLMarshallable, Serializable

public class InvalidParameterValueException
extends OperationFailureException

Exception thrown when trying to set the value of a parameter to a value that is not valid for this parameter; The exception contains the current parameter value.

See Also:

• Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="invalidParameterValueException">
 <xs:complexType>
     <xs:sequence>
       <xs:element ref="adminParameter" minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
     <xs:attribute name="reason" type="InvalidParameterReasonType"/>
 </xs:complexType>
 </xs:element>

<xs:simpleType name="InvalidParameterReasonType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="unknown"/>  
     <xs:enumeration value="invalidValue"/>  
     <xs:enumeration value="parameterNotModifiable"/>  
   </xs:restriction> 
 </xs:simpleType>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INVALID_VALUE
static final int	NOT_MODIFIABLE
static final String	OPERATION_NAME	The XML tag name: invalidParameterValueException
static final int	UNKNOWN

Constructor Summary

Constructors

Constructor	Description
InvalidParameterValueException()
InvalidParameterValueException(AdminParameterModel parameter)	Creates an InvalidParameterValueException initialized with a parameter.
InvalidParameterValueException(AdminParameterModel parameter, int reason)	Creates an InvalidParameterValueException initialized with a parameter.

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.
AdminParameterModel	getParameter()	Gets the parameter initialized with its current value.
int	getReason()
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

UNKNOWN

public static final int UNKNOWN

See Also:

• Constant Field Values

INVALID_VALUE

public static final int INVALID_VALUE

See Also:

• Constant Field Values

NOT_MODIFIABLE

public static final int NOT_MODIFIABLE

See Also:

• Constant Field Values

OPERATION_NAME

public static final String OPERATION_NAME

The XML tag name: invalidParameterValueException

See Also:

• Constant Field Values

Constructor Details

InvalidParameterValueException

public InvalidParameterValueException()

InvalidParameterValueException

public InvalidParameterValueException(AdminParameterModel parameter)

Creates an InvalidParameterValueException initialized with a parameter.

Parameters:

parameter - The parameter to be returned

InvalidParameterValueException

public InvalidParameterValueException(AdminParameterModel parameter,
 int reason)

Creates an InvalidParameterValueException initialized with a parameter.

Parameters:

parameter - The parameter to be returned

reason - The reason

Method Details

getParameter

public AdminParameterModel getParameter()

Gets the parameter initialized with its current value.

Returns:

The parameter

getReason

public int getReason()

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