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:

ParameterOperationResult

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 Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_ID The mapping for the operation ID: "opID"
static String	OPERATION_NAME The XML tag name of this service operation: "getParameterValueResult"

Constructor Summary

Constructors

Constructor and Description
GetParameterValueResult()
GetParameterValueResult(AdminParameterModel model)

Method Summary

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

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

getParameter, setParameter

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final String OPERATION_NAME

The XML tag name of this service operation: "getParameterValueResult"

See Also:

Constant Field Values

OPERATION_ID

public static final String OPERATION_ID

The mapping for the operation ID: "opID"

See Also:

Constant Field Values

Constructor Detail

GetParameterValueResult

public GetParameterValueResult()

GetParameterValueResult

public GetParameterValueResult(AdminParameterModel model)

Method Detail

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