Package com.highdeal.pnr.hci

Class CleanupException

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.highdeal.hci.OperationFailureException
com.highdeal.pnr.hci.CleanupException
All Implemented Interfaces:
OperationResult, XMLMarshallable, Serializable
public class CleanupException extends OperationFailureException
Exception thrown during the processing of a cleanup operation request in the connected SAP CC system; The exception is registered in the operation results.

The main reasons are:

  • The invalidSubscriptionCode error occurs when the given code is null or does not correspond to a subscription in the database.
  • The invalidResultType occurs when the result type is unknown.
  • The invalidToDate error occurs when the given date is null.
  • The incompatibleCurrencies occurs when aggregating the total amounts of different currencies.

Note

Consult the field summary and the field details for the complete list of reasons and detailed information.

See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="cleanupFault">
                  <xs:complexType>
                     <xs:attribute name="reason" type="CleanupFaultType"/>
                     <xs:attribute name="message" type="xs:string"/>
                  </xs:complexType>
               </xs:element>
<xs:simpleType name="CleanupFaultType">
                  <xs:restriction base="xs:string">
                     <xs:enumeration value="invalidSubscriberAccountCode"/>
                     <xs:enumeration value="invalidServiceProvider"/>
                     <xs:enumeration value="invalidSubscriptionOid"/>
                     <xs:enumeration value="invalidToDate"/>
                     <xs:enumeration value="invalidResultType"/>
                     <xs:enumeration value="incompatibleCurrencies"/>
                     <xs:enumeration value="cleanupProcessAlreadyRunning"/>
                     <xs:enumeration value="dispatcherCommunicationFailed"/>
                     <xs:enumeration value="unknown"/>
                  </xs:restriction>
               </xs:simpleType>

  • Field Details

    • OPERATION_NAME

      public static final String OPERATION_NAME
      The XML name: "cleanupFault"
      See Also:

    • INVALID_SUBSCRIBER_ACCOUNT_CODE

      public static final int INVALID_SUBSCRIBER_ACCOUNT_CODE
      0: Constant for invalidSubscriberAccountCode error
      See Also:

    • INVALID_SERVICE_PROVIDER

      public static final int INVALID_SERVICE_PROVIDER
      1: Constant for invalidServiceProvider error
      See Also:

    • INVALID_SUBSCRIPTION_OID

      public static final int INVALID_SUBSCRIPTION_OID
      2: Constant for invalidSubscriptionOid error
      See Also:

    • INVALID_TO_DATE

      public static final int INVALID_TO_DATE
      3: Constant for invalidToDate error
      See Also:

    • INVALID_RESULT_TYPE

      public static final int INVALID_RESULT_TYPE
      4: Constant for invalidResultType error
      See Also:

    • INCOMPATIBLE_CURRENCIES

      public static final int INCOMPATIBLE_CURRENCIES
      5: Constant for incompatibleCurrencies error
      See Also:

    • CLEANUP_PROCESS_ALREADY_RUNNING

      public static final int CLEANUP_PROCESS_ALREADY_RUNNING
      6: Constant for cleanupProcesssAlreadyRunning error. A cleanup process is still running.
      See Also:

    • DISPATCHER_COMMUNICATION_FAILED

      public static final int DISPATCHER_COMMUNICATION_FAILED
      7: Constant for dispatcherCommunicationFailed error
      See Also:

    • UNKNOWN

      public static final int UNKNOWN
      -1: Constant for unknown error
      See Also:

  • Constructor Details

  • Method Details

    • setReason

      public void setReason(int reason)
      SAP CC sets up the reason of this CleanupException.
      Parameters:
      reason - The reason of this CleanupException

    • getReason

      public int getReason()
      Gets the recorded reason of this CleanupException for further investigations.
      Returns:
      The reason of this CleanupException
      See Also:

    • setMessage

      public void setMessage(String message)
      SAP CC sets up the message for this CleanupException.
      Parameters:
      message - The message for this CleanupException

    • getMessage

      public String getMessage()
      Gets the recorded detailed message for this CleanupException.
      Overrides:
      getMessage in class Throwable
      Returns:
      The text message of this CleanupException

    • 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

    • toString

      public String toString()
      Overrides:
      toString in class Throwable