com.highdeal.admin.hci

Class SetParameterValueResult

java.lang.Object

com.highdeal.admin.hci.ParameterOperationResult

com.highdeal.admin.hci.SetParameterValueResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class SetParameterValueResult
extends ParameterOperationResult

This class represents the result of the Set Parameter Value operation; This result is the parameter model whose value has been set.

Implementation in Your Client Application

Use the getParameter() method to get the resulting parameter model.

Operation Request

SetParameterValueOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_ID Mapping for the operation ID: "opID"
static java.lang.String	OPERATION_NAME The XML name of this operation: "setParameterValueResult"

Constructor Summary

Constructors

Constructor and Description
SetParameterValueResult()
SetParameterValueResult(AdminParameterModel model) Initializes a new SetParameterValueResult instance with a parameter name and a parameter value.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds string data to this operation.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child tag to this operation.
java.lang.String	getName() Returns the XML name of the operation, that is "setParameterValueResult".
java.lang.String	getOperandReference() Returns the operand reference for audit.
java.lang.String	getOperationID() Gets the operation identifier.
AdminParameterModel	getParameter() Gets the parameter.
void	marshal(XMLOutputter output) Writes the operation XML data to the given output.
void	setAttributes(XMLAttributes atts) Sets the operation attributes from the XMLAttributes.
void	setOperationID(java.lang.String id) Sets the operation identifier.

Methods inherited from class com.highdeal.admin.hci.ParameterOperationResult

setParameter

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The XML name of this operation: "setParameterValueResult"

See Also:

Constant Field Values

OPERATION_ID

public static final java.lang.String OPERATION_ID

Mapping for the operation ID: "opID"

See Also:

Constant Field Values

Constructor Detail

SetParameterValueResult

public SetParameterValueResult()

SetParameterValueResult

public SetParameterValueResult(AdminParameterModel model)

Initializes a new SetParameterValueResult instance with a parameter name and a parameter value.

Parameters:

model - The model of the parameter

Method Detail

getParameter

public AdminParameterModel getParameter()

Gets the parameter.

Overrides:

getParameter in class ParameterOperationResult

Returns:

The parameter

getOperationID

public java.lang.String getOperationID()

Gets the operation identifier.

Returns:

The operation ID, or null if the operation has no identifier.

setOperationID

public void setOperationID(java.lang.String id)

Sets the operation identifier.

Parameters:

id - The operation ID

getName

public java.lang.String getName()

Returns the XML name of the operation, that is "setParameterValueResult".

Returns:

"setParameterValueResult"

getOperandReference

public java.lang.String getOperandReference()

Returns the operand reference for audit.

Returns:

The operand reference for audit

setAttributes

public void setAttributes(XMLAttributes atts)

Sets the operation attributes from the XMLAttributes.

Parameters:

atts - The XMLAttributes containing the data

addCharacterData

public void addCharacterData(java.lang.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(java.lang.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