Class PreRateException

All Implemented Interfaces:
OperationResult, XMLMarshallable, Serializable

public class PreRateException extends OperationFailureException
Exception that may occur during a PreRateOp execution.
This Exception has one of the reasons below:
  • invalidReservationUID error occurs when the identifier is null.
  • invalidTTL error is related to the ttl that can not be negative.
  • invalidDefaultResolution error occurs when the default resolution passed into the PreRateOp is invalid (null or unknown).
  • invalidResultType occurs when the result type is unknown.
See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="preRateFault">
   <xs:complexType>
     <xs:attribute name="reason" type="PreRateFaultType"/>
     <xs:attribute name="message" type="xs:string"/>
   </xs:complexType>
 </xs:element>
<xs:simpleType name="PreRateFaultType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="invalidReservationUID"/>
     <xs:enumeration value="invalidTTL"/>
     <xs:enumeration value="invalidDefaultResolution"/>
     <xs:enumeration value="invalidResultType"/>
    </xs:restriction>
 </xs:simpleType>

  • Field Details

    • INVALID_RESERVATION_UID

      public static final int INVALID_RESERVATION_UID
      Constant for invalidReservationUID error.
      See Also:
    • INVALID_TTL

      public static final int INVALID_TTL
      Constant for invalidTTL error.
      See Also:
    • INVALID_DEFAULT_RESOLUTION

      public static final int INVALID_DEFAULT_RESOLUTION
      Constant for invalidDefaultResolution error.
      See Also:
    • INVALID_RESULT_TYPE

      public static final int INVALID_RESULT_TYPE
      Constant for invalidResultType error.
      See Also:
  • Constructor Details

  • Method Details

    • setReason

      public void setReason(int reason)
      Sets the reason of this PreRateException.
      Parameters:
      reason - the reason of this PreRateException
      See Also:
    • getReason

      public int getReason()
      Gets the reason of this PreRateException.
      Returns:
      the reason of this PreRateException
      See Also:
    • setMessage

      public void setMessage(String message)
      Sets the message for this PreRateException.
      Parameters:
      message - the message for this PreRateException
    • getMessage

      public String getMessage()
      Gets the message for this PreRateException.
      Overrides:
      getMessage in class Throwable
      Returns:
      the message of this PreRateException
    • 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