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 gets the list of the available administration parameters.

See Also :

GetParametersResult

Operation Failure Exception :

ServerFailureException

XML Schema Fragment

<xs:element name="getParameters">
   <xs:complexType>
     <xs:attribute name="definitionOnly" type="xs:boolean"/>
   </xs:complexType>
 </xs:element>

Operation availability :

Edition	Available On:
	Rater	Updater	Backup	Guider	Charger	BulkLoader	BillingAssistant	EZTaxer
Rate	yes	yes	yes	yes	no	no	no	yes
Charge	yes	yes	yes	yes	no	no	no	yes
Bill	yes	yes	yes	yes	yes	yes	yes	yes
Full	yes	yes	yes	yes	yes	yes	yes	yes

Field Summary

static java.lang.String

OPERATION_NAME The name of this 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.
java.lang.String	getName() Returns the name of the operation, that is "getParameters".
boolean	isDefinitionOnly() True if the operation must fetch only the definition of the parameters, false it it must also fetch the value of the paramters.
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	setDefinitionOnly(boolean definitionOnly) Sets the mode the operation: true if the operation must fetch only the definition of the paramters, false if it must also fetch the value of the parameters

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The name of this 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"

isDefinitionOnly

public boolean isDefinitionOnly()

True if the operation must fetch only the definition of the parameters, false it it must also fetch the value of the paramters.

Returns:

true if the operation must fetch only the definition of the paramters, false if it must also fetch the value of the parameters.

setDefinitionOnly

public void setDefinitionOnly(boolean definitionOnly)

Sets the mode the operation: true if the operation must fetch only the definition of the paramters, false if it must also fetch the value of the parameters

Parameters:

definitionOnly - true if the operation must fetch only the definition of the paramters, false if it must also fetch the value of the parameters.

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