com.highdeal.admin.hci

Class GetParametersResult

java.lang.Object

com.highdeal.admin.hci.GetParametersResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class GetParametersResult
extends Object
implements OperationResult

This class represents the result of the Get Parameters operation; It contains a Vector of parameters of the connected SAP CC system.

Implementation in Your Client Application

Use the getParameters() method to get the resulting vector.

See Also:

GetParameterValueOp

Operation Request

GetParametersOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_NAME The name of this operation : "getParametersResult"

Constructor Summary

Constructors

Constructor and Description
GetParametersResult()

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
void	addParameter(AdminParameterModel model)
String	getName()
String	getOperandReference() Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
Vector<String>	getParameterNames()
Vector<AdminParameterModel>	getParameters()
void	marshal(XMLOutputter output) Writes the operation XML data to the specified output.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.

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 name of this operation : "getParametersResult"

See Also:

Constant Field Values

Constructor Detail

GetParametersResult

public GetParametersResult()

Method Detail

getName

public String getName()

addParameter

public void addParameter(AdminParameterModel model)

getParameters

public Vector<AdminParameterModel> getParameters()

getParameterNames

public Vector<String> getParameterNames()

getOperandReference

public String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Specified by:

getOperandReference in interface OperationResult

Returns:

The operand reference of the operation result

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addCharacterData

public void addCharacterData(String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

addChild

public void addChild(String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Writes the operation XML data to the specified output.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XMLOutputter to write into