Package com.highdeal.admin.hci

Class GetParameterValueResult

java.lang.Object
com.highdeal.admin.hci.ParameterOperationResult
com.highdeal.admin.hci.GetParameterValueResult
All Implemented Interfaces:
OperationResult, XMLMarshallable
public class GetParameterValueResult extends ParameterOperationResult
This Java class represents the result of the Get Parameter Value operation; It contains the information relating to the specified parameter.

Implementation in Your Client Aplication

Use getParameter() method to get the retrieved information as system parameters in the connected SAP CC system.

See Also:

Operation Request

GetParameterValueOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="getParameterValueResult">
   <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 XML tag name of this service operation: "getParameterValueResult"
      See Also:

    • OPERATION_ID

      public static final String OPERATION_ID
      The mapping for the operation ID: "opID"
      See Also:

  • Constructor Details

    • GetParameterValueResult

      public GetParameterValueResult()

    • GetParameterValueResult

      public GetParameterValueResult(AdminParameterModel model)

  • Method Details

    • getOperationID

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

    • setOperationID

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

    • getName

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

    • getOperandReference

      public String getOperandReference()
      Returns the operand reference for audit.
      Returns:
      null, as this result is not audited

    • 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 specified output.
      Parameters:
      output - The XMLOutputter to write into