com.highdeal.admin.hci
Class GetParametersOp

java.lang.Object
  com.highdeal.admin.hci.GetParametersOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class GetParametersOp
extends java.lang.Object
implements MessageOperation

This operation allows you to retrieve the list of the available administration parameters in the connected SAP CC system.

See Also:

GetParameterValueOp

Operation Result

GetParametersResult

Operation Failure Exception

ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="getParameters">
   <xs:complexType>
     <xs:attribute name="instanceType">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:pattern value="(rater|updater|guider|bulkLoader|bart|taxer|dispatcher)"/>
         </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

protected InstanceType	instanceType
static java.lang.String	OPERATION_NAME The XML tag name of this service operation: getParameters

Constructor Summary

GetParametersOp()

Method Summary

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.
InstanceType	getInstanceType() Gets the instance type.
java.lang.String	getName() Returns the name of the operation, that is "getParameters".
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	setInstanceType(InstanceType instanceType) Sets the instance type.

Methods inherited from class java.lang.Object

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

Field Detail

instanceType

protected InstanceType instanceType

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The XML tag name of this service operation: getParameters

See Also:

Constant Field Values

Constructor Detail

GetParametersOp

public GetParametersOp()

Method Detail

getName

public java.lang.String getName()

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

Specified by:

getName in interface MessageOperation

Returns:

"getParameters"

getInstanceType

public InstanceType getInstanceType()

Gets the instance type.

Returns:

The instance type

setInstanceType

public void setInstanceType(InstanceType instanceType)

Sets the instance type.

Parameters:

instanceType - The instance type to set up

setAttributes

public void setAttributes(XMLAttributes atts)

Sets the operation attributes from the XMLAttributes.

Specified by:

setAttributes in interface XMLMarshallable

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.

Specified by:

addCharacterData in interface XMLMarshallable

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.

Specified by:

addChild in interface XMLMarshallable

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.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XMLOutputter to write into