com.highdeal.hci

Class InvalidModificationErrorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.hci.OperationFailureErrorException

com.highdeal.hci.InvalidModificationErrorException

All Implemented Interfaces:

IErrorException, IXMLMarshallable, OperationResult, XMLMarshallable, Serializable

public class InvalidModificationErrorException
extends OperationFailureErrorException

Generic exception thrown when there is an attempt to modify something which is not valid.

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="invalidModificationError">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="cause" minOccurs="1" maxOccurs="1"/>
       <xs:element ref="causedBy" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="category" type="InvalidModificationCategoryType" use="required"/>
   </xs:complexType>
 </xs:element>

 <xs:simpleType name="InvalidModificationCategoryType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="doesNotExist"/>
     <xs:enumeration value="invalid"/>
     <xs:enumeration value="prerequisiteMissing"/>
     <xs:enumeration value="incompatibleConfiguration"/>
     <xs:enumeration value="illegalState"/>
     <xs:enumeration value="temporaryIllegalState"/>
   </xs:restriction>
 </xs:simpleType>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvalidModificationErrorException.InvalidModificationCategory This enumeration lists all the categories of errors that may occur during the modification of a master data.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_NAME The XML tag name of the Invalid Modification Error XML representation

Fields inherited from class com.highdeal.hci.OperationFailureErrorException

CAUSE_TAG_NAME, CAUSED_BY_TAG_NAME, MESSAGE_TAG_NAME

Constructor Summary

Constructors

Constructor and Description
InvalidModificationErrorException() Builds an empty exception.
InvalidModificationErrorException(InvalidModificationErrorException.InvalidModificationCategory category, IError error) Builds an exception with the error which has triggered it and associated category.
InvalidModificationErrorException(InvalidModificationErrorException.InvalidModificationCategory category, IError error, OperationFailureErrorException exception) Builds an exception with an error, the Operation Failure which has triggered it and associated category.
InvalidModificationErrorException(InvalidModificationErrorException.InvalidModificationCategory category, IError error, Throwable throwable) Builds an exception with an error, the Throwable which has triggered it and associated category.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
InvalidModificationErrorException.InvalidModificationCategory	getCategory() Gets the failure category of this exception.
String	getTagName() Gets the XML tag name of the HCI model.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.

Methods inherited from class com.highdeal.hci.OperationFailureErrorException

addChild, getError, getMessage, marshal, marshalChildren, marshalIError, setError, unmarshalIError

Methods inherited from class com.highdeal.hci.OperationFailureException

getOperandReference

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 Detail

TAG_NAME

public static final String TAG_NAME

The XML tag name of the Invalid Modification Error XML representation

See Also:

Constant Field Values

Constructor Detail

InvalidModificationErrorException

public InvalidModificationErrorException()

Builds an empty exception.

InvalidModificationErrorException

public InvalidModificationErrorException(InvalidModificationErrorException.InvalidModificationCategory category,
                                         IError error)

Builds an exception with the error which has triggered it and associated category.

Parameters:

category - The error category

error - The error which has triggered the exception

InvalidModificationErrorException

public InvalidModificationErrorException(InvalidModificationErrorException.InvalidModificationCategory category,
                                         IError error,
                                         OperationFailureErrorException exception)

Builds an exception with an error, the Operation Failure which has triggered it and associated category.

Parameters:

category - The error category

error - The error of the exception

exception - The exception which has triggered the current one

InvalidModificationErrorException

public InvalidModificationErrorException(InvalidModificationErrorException.InvalidModificationCategory category,
                                         IError error,
                                         Throwable throwable)

Builds an exception with an error, the Throwable which has triggered it and associated category.

Parameters:

category - The error category

error - The error of the exception

throwable - The throwable which has triggered the current one

Method Detail

getCategory

public InvalidModificationErrorException.InvalidModificationCategory getCategory()

Gets the failure category of this exception.

Returns:

The failure category of this exception

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

getTagName

public String getTagName()

Description copied from class: OperationFailureErrorException

Gets the XML tag name of the HCI model.

Specified by:

getTagName in class OperationFailureErrorException

Returns:

The XML tag name

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Parameters:

output - The XML output to marshal the object attributes into