com.highdeal.admin.hci

Class ResetCachesResult

java.lang.Object

com.highdeal.admin.hci.ResetCachesResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class ResetCachesResult
extends java.lang.Object
implements OperationResult

This class represents the result of the Reset Caches operation.

Operation Request

ResetCachesOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="resetCachesResult">
   <xs:complexType>
     <xs:attribute name="partitionId" type="xs:short" use="optional"/>
   </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_NAME The name of this operation: "pingResult"
static java.lang.String	PARTITION_ID_ATTRIBUTE_NAME The XML attribute name for the partition identifier

Constructor Summary

Constructors

Constructor and Description
ResetCachesResult()

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds string data to this operation; This data is ignored for this operation.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child tag to this operation; This tag is ignored for this operation.
java.lang.String	getName() Returns the name of the operation, that is "ping".
java.lang.String	getOperandReference() Gets the operand reference for auditing purpose.
java.lang.Short	getPartitionId() Gets the identifier of the partition on which the operation was executed.
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	setPartitionId(java.lang.Short partitionId) Sets the identifier of the partition on which the operation was executed.

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

See Also:

Constant Field Values

PARTITION_ID_ATTRIBUTE_NAME

public static final java.lang.String PARTITION_ID_ATTRIBUTE_NAME

The XML attribute name for the partition identifier

See Also:

Constant Field Values

Constructor Detail

ResetCachesResult

public ResetCachesResult()

Method Detail

getName

public java.lang.String getName()

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

Returns:

"resetCaches"

getOperandReference

public java.lang.String getOperandReference()

Gets the operand reference for auditing purpose.

Specified by:

getOperandReference in interface OperationResult

Returns:

null, as this operation is not audited

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

getPartitionId

public java.lang.Short getPartitionId()

Gets the identifier of the partition on which the operation was executed.

Returns:

the identifier of the partition on which the operation was executed, or null if the operation was executed on all partitions

setPartitionId

public void setPartitionId(java.lang.Short partitionId)

Sets the identifier of the partition on which the operation was executed.

Parameters:

partitionId - the identifier of the partition on which the operation was executed, or null if the operation was executed on all partitions