Package com.highdeal.admin.hci

Class ResetParameterValueResult

java.lang.Object
com.highdeal.admin.hci.ParameterOperationResult
com.highdeal.admin.hci.ResetParameterValueResult
All Implemented Interfaces:
OperationResult, XMLMarshallable
public class ResetParameterValueResult extends ParameterOperationResult
This class represents the result of the Reset Parameter Value operation; It is the parameter model which has been reset.

Use getParameter() to get the resulting parameter model.

Operation Request

ResetParameterValueOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="resetParameterValueResult">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="adminParameter" minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

  • Field Details

    • OPERATION_NAME

      public static final String OPERATION_NAME
      The name of this operation : "resetParameterValueResult".
      See Also:

    • OPERATION_ID

      public static final String OPERATION_ID
      Mapping for the operation ID : "opID".
      See Also:

  • Constructor Details

    • ResetParameterValueResult

      public ResetParameterValueResult()

    • ResetParameterValueResult

      public ResetParameterValueResult(AdminParameterModel parameter)
      Initializes a new ResetParameterValueResult instance with a parameter name.
      Parameters:
      parameter - the parameter to be returned

  • Method Details

    • getParameter

      public AdminParameterModel getParameter()
      Gets the parameter.
      Overrides:
      getParameter in class ParameterOperationResult
      Returns:
      the parameter

    • getOperationID

      public String getOperationID()
      Gets the operation id.
      Returns:
      the operation id, or null if the operation has no id.

    • setOperationID

      public void setOperationID(String id)
      Sets the operation id.
      Parameters:
      id - the operation id.

    • getName

      public String getName()
      Returns the name of the operation, that is "resetParameterValueResult".
      Returns:
      "resetParameterValueResult"

    • 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.
      Returns:
      The operand reference of the operation result

    • setAttributes

      public void setAttributes(XMLAttributes atts)
      Sets the operation attributes from the XMLAttributes.
      Parameters:
      atts - the XMLAttributes containing the data

    • addCharacterData

      public void addCharacterData(String cData)
      Adds string data to this operation.

      This data is ignored for this operation.

      Parameters:
      cData - the character data to add to the operation

    • addChild

      public void addChild(String tagName, XMLMarshallable child)
      Adds a child tag to this operation.

      For this operation, the child must be a ParameterModel.

      Parameters:
      tagName - the name of the tag
      child - the XMLMarshallable child to add

    • marshal

      public void marshal(XMLOutputter output)
      Writes the operation XML data to the given output.
      Parameters:
      output - the XMLOutputter to write into