Package com.highdeal.admin.hci

Class UnknownParameterException

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.highdeal.hci.OperationFailureException
com.highdeal.admin.hci.UnknownParameterException
All Implemented Interfaces:
OperationResult, XMLMarshallable, Serializable
public class UnknownParameterException extends OperationFailureException
Exception thrown when trying to access the value of a system parameter that does not exist when using the Get Parameter Value operation.
See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="unknownParameterException">
  <xs:complexType>
     <xs:attribute name="parameterName" type="xs:string" use="required"/>
   </xs:complexType>
 </xs:element>

  • Field Details

  • Constructor Details

    • UnknownParameterException

      public UnknownParameterException()

    • UnknownParameterException

      public UnknownParameterException(String parameterName)
      Creates an UnknownParameterException initialized with a parameter name.
      Parameters:
      parameterName - The name of the parameter not found

  • Method Details

    • getParameterName

      public String getParameterName()
      Gets the parameter name wanted and not found.
      Returns:
      The parameter name

    • getOperandReference

      public 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 String getMessage()
      Overrides:
      getMessage in class 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(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