com.highdeal.admin.hci

Class GetParameterValueOp

java.lang.Object

com.highdeal.admin.hci.ParameterOperation

com.highdeal.admin.hci.GetParameterValueOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class GetParameterValueOp
extends ParameterOperation

This operation allows you to retrieve the value of a parameter of the connected SAP CC system.

Implementation in Your Client Application

You specify the parameter name and its scope.

See Also:

ParameterModel

Operation Result

GetParameterValueResult

Operation Failure Exception

UnknownParameterException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="getParameterValue">
   <xs:complexType>
     <xs:attribute name="parameterName" use="required">
       <xs:simpleType>
         <xs:restriction base="xs:string">
             <xs:maxLength value="128"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="scope">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:enumeration value="PERSISTENT"/>
           <xs:enumeration value="MEMORY"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:attribute>
   </xs:complexType>
 </xs:element>

Operation Availability

You can send this operation request in HCI messages to the following final target types of instances in the connected SAP CC system:

Edition	Final Target Instances
	rater	updater	guider	bulkLoader	taxer	dispatcher
charge	Yes	Yes	Yes	Yes	Yes	Yes

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_NAME The XML tag name of this service operation: "getParameterValue"

Fields inherited from class com.highdeal.admin.hci.ParameterOperation

PARAM_NAME, SCOPE, VALUE

Constructor Summary

Constructors

Constructor and Description
GetParameterValueOp()

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 name of the operation, that is "getParameterValue".
void	marshal(XMLOutputter output) Writes the operation XML data to the given output.
void	setAttributes(XMLAttributes atts) Sets the operation attributes from the XMLAttributes.

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

getParameterName, getScope, getValue, isMemoryScope, isPersistentScope, setParameterName, setScope, setValue

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 tag name of this service operation: "getParameterValue"

See Also:

Constant Field Values

Constructor Detail

GetParameterValueOp

public GetParameterValueOp()

Method Detail

getName

public java.lang.String getName()

Returns the name of the operation, that is "getParameterValue".

Returns:

"getParameterValue"

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.

This tag is ignored for this operation.

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