com.highdeal.pnr.hci
Class UnlockChargingContractException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.highdeal.hci.OperationFailureException
              com.highdeal.pnr.hci.UnlockChargingContractException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class UnlockChargingContractException
extends OperationFailureException

Exception thrown when the unlocking of a provider contract fails.

The following reasons are defined:

• DOES_NOT_EXIST , which means that the provider contract does not exist
• INVALID , which means that the operation is invalid (provider contract ID is missing)
• NOT_LOCKED , which means that the provider contract is not locked

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="unlockChargingContractFault">
   <xs:complexType>
     <xs:attribute name="reason" type="UnlockChargingContractFaultReasonType"/>
     <xs:attribute name="message" type="xs:string"/>
   </xs:complexType>
 </xs:element>
 <xs:simpleType name="UnlockChargingContractFaultReasonType">
   <xs:restriction base="xs:string">
      <xs:enumeration value="does_not_exist"/>
      <xs:enumeration value="invalid"/>
      <xs:enumeration value="not_locked"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary

static int	DOES_NOT_EXIST 0: Constant indicating that the provider contract does not exist
static int	INVALID 1: Constant indicating that the operation is invalid (provider contract ID is missing)
static int	NOT_LOCKED 2: Constant indicating that the provider contract is not locked
static java.lang.String	OPERATION_NAME The XML tag name of this exception: "unlockChargingContractFault"

Constructor Summary

UnlockChargingContractException()
Constructs an empty exception.

UnlockChargingContractException(int reason, java.lang.String message)
Constructs an exception with a message.

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	getMessage()
java.lang.String	getName() Gets the name of the operation.
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 com.highdeal.hci.OperationFailureException

getOperandReference

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

Field Detail

DOES_NOT_EXIST

public static final int DOES_NOT_EXIST

0: Constant indicating that the provider contract does not exist

See Also:

Constant Field Values

INVALID

public static final int INVALID

1: Constant indicating that the operation is invalid (provider contract ID is missing)

See Also:

Constant Field Values

NOT_LOCKED

public static final int NOT_LOCKED

2: Constant indicating that the provider contract is not locked

See Also:

Constant Field Values

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The XML tag name of this exception: "unlockChargingContractFault"

See Also:

Constant Field Values

Constructor Detail

UnlockChargingContractException

public UnlockChargingContractException()

Constructs an empty exception.

UnlockChargingContractException

public UnlockChargingContractException(int reason,
                                       java.lang.String message)

Constructs an exception with a message. It contains a human readable text.

Parameters:

reason - the reason.

message - the message.

Method Detail

getName

public java.lang.String getName()

Gets the name of the operation.

Returns:

"unlockChargingContractFault"

getReason

public int getReason()

getMessage

public java.lang.String getMessage()

Overrides:

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