com.highdeal.hci

Class BadMessageFormatException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.hci.BadMessageFormatException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class BadMessageFormatException
extends OperationFailureException

Exception thrown when a message with a bad format is received by the SAP CC system.

Reasons

See Also:

MessageSender, Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="badMessageFormatFault">
  <xs:complexType>
   <xs:attribute name="tag" type="xs:string"/>
   <xs:attribute name="attribute" type="xs:string"/>
   <xs:attribute name="value" type="xs:string"/>
  </xs:complexType>
 </xs:element>

Constructor Summary

Constructors

Constructor and Description
BadMessageFormatException() Builds an empty exception.
BadMessageFormatException(java.lang.String tag, java.lang.String attribute, java.lang.String value) Builds a complete exception.

Method Summary

Modifier and Type	Method and Description
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	getAttribute() Returns the attribute containing the error if available.
java.lang.String	getMessage()
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.
java.lang.String	getTag() Returns the XML tag containing the error if available.
java.lang.String	getValue() Returns the bad value if available.
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

Constructor Detail

BadMessageFormatException

public BadMessageFormatException()

Builds an empty exception.

BadMessageFormatException

public BadMessageFormatException(java.lang.String tag,
                                 java.lang.String attribute,
                                 java.lang.String value)

Builds a complete exception.

Parameters:

tag - The XML tag containing the error, if available

attribute - The XML attribute containing the error, if available

value - The bad value, if available

Method Detail

getTag

public java.lang.String getTag()

Returns the XML tag containing the error if available.

Returns:

The XML tag containing the error if available

getAttribute

public java.lang.String getAttribute()

Returns the attribute containing the error if available.

Returns:

The attribute containing the error if available

getValue

public java.lang.String getValue()

Returns the bad value if available.

Returns:

The bad value if available

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

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

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

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()

Overrides:

getMessage in class java.lang.Throwable