com.highdeal.admin.hci
Class ResetParameterValueResult

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

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class ResetParameterValueResult
extends java.lang.Object
implements OperationResult

This class conveys the result of the ResetParameterValueOp operation.
This result is the parameter model which has been reset.
Please, use getParameter() to get the resulting parameter model.

See Also :

ResetParameterValueOp

XML Schema Fragment

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

Field Summary

static java.lang.String	OPERATION_ID Mapping for the operation ID : "opID".
static java.lang.String	OPERATION_NAME The name of this operation : "resetParameterValueResult".

Constructor Summary

ResetParameterValueResult()

ResetParameterValueResult(AdminParameterModel parameter)
Initializes a new ResetParameterValueResult instance with a parameter name.

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 "resetParameterValueResult".
java.lang.String	getOperandReference() Gets the code or the reference (if no code exists) identifying the operand of the operation.
java.lang.String	getOperationID() Gets the operation id.
AdminParameterModel	getParameter() Gets the parameter.
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	setOperationID(java.lang.String id) Sets the operation id.

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 : "resetParameterValueResult".

See Also:

Constant Field Values

OPERATION_ID

public static final java.lang.String OPERATION_ID

Mapping for the operation ID : "opID".

See Also:

Constant Field Values

Constructor Detail

ResetParameterValueResult

public ResetParameterValueResult()

ResetParameterValueResult

public ResetParameterValueResult(AdminParameterModel parameter)

Initializes a new ResetParameterValueResult instance with a parameter name.

Parameters:

parameter - the parameter to be returned

Method Detail

getParameter

public AdminParameterModel getParameter()

Gets the parameter.

Returns:

the parameter

getOperationID

public java.lang.String getOperationID()

Gets the operation id.

Returns:

the operation id, or null if the operation has no id.

setOperationID

public void setOperationID(java.lang.String id)

Sets the operation id.

Parameters:

id - the operation id.

getName

public java.lang.String getName()

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

Returns:

"resetParameterValueResult"

getOperandReference

public java.lang.String getOperandReference()

Description copied from interface: OperationResult

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

Specified by:

getOperandReference in interface OperationResult

Returns:

The operand reference of the result.

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.

For this operation, the child must be a ParameterModel.

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