com.highdeal.admin.hci

Class SetMaintenanceModeResult

java.lang.Object

com.highdeal.admin.hci.SetMaintenanceModeResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class SetMaintenanceModeResult
extends java.lang.Object
implements OperationResult

This result corresponds to the SetMaintenanceModeOp operation.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="setMaintenanceModeResult">
   <xs:complexType>
     <xs:attribute name="enabled" type="xs:boolean" use="required"/>
   </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENABLED_NAME The XML attribute name of the enabled status.
static java.lang.String	RESULT_NAME The XML element name of the result.

Constructor Summary

Constructors

Constructor and Description
SetMaintenanceModeResult()

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.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.
boolean	isEnabled() Gets whether the maintenance mode is enabled.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setEnabled(boolean enabled) Sets whether the maintenance mode is enabled.

Methods inherited from class java.lang.Object

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

Field Detail

RESULT_NAME

public static final java.lang.String RESULT_NAME

The XML element name of the result.

See Also:

Constant Field Values

ENABLED_NAME

public static final java.lang.String ENABLED_NAME

The XML attribute name of the enabled status.

See Also:

Constant Field Values

Constructor Detail

SetMaintenanceModeResult

public SetMaintenanceModeResult()

Method Detail

getOperandReference

public java.lang.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(java.lang.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(java.lang.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)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into

setEnabled

public void setEnabled(boolean enabled)

Sets whether the maintenance mode is enabled.

Parameters:

enabled - true if the maintenance mode is enabled, false otherwise

isEnabled

public boolean isEnabled()

Gets whether the maintenance mode is enabled.

Returns:

true if the maintenance mode is enabled, false otherwise