com.highdeal.hci
Class AlreadyExistException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.highdeal.hci.OperationFailureException
              com.highdeal.hci.AlreadyExistException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class AlreadyExistException
extends OperationFailureException

Generic exception thrown when there is an attempt to create an entity with a unique code (such as a product or a business relationship) that already exists.

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="alreadyExistFault">
   <xs:complexType>
     <xs:attribute name="code" type="xs:string"/>
   </xs:complexType>
 </xs:element>

Constructor Summary

AlreadyExistException()
Constructs an empty exception.

AlreadyExistException(java.lang.String duplicateCode)
Constructs an exception for the code that is duplicate.

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.String	getCode() Gets the duplicate code that already exists in master data.
java.lang.String	getMessage() Returns a comprehensive text message for this exception: alreadyExistFault: <ALREADY_EXISTING_CODE>.
java.lang.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.
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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AlreadyExistException

public AlreadyExistException()

Constructs an empty exception.

AlreadyExistException

public AlreadyExistException(java.lang.String duplicateCode)

Constructs an exception for the code that is duplicate.

Parameters:

duplicateCode - The code that is duplicate

Method Detail

getCode

public java.lang.String getCode()

Gets the duplicate code that already exists in master data.

Returns:

The duplicate code

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(java.lang.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(java.lang.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

getOperandReference

public java.lang.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 java.lang.String getMessage()

Returns a comprehensive text message for this exception: alreadyExistFault: <ALREADY_EXISTING_CODE>.

Overrides:

getMessage in class java.lang.Throwable