com.highdeal.admin.hci
Class ServerManagementResult

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

All Implemented Interfaces:

OperationResult, XMLMarshallable

Direct Known Subclasses:

ServerShutdownResult

public abstract class ServerManagementResult
extends java.lang.Object
implements OperationResult

This abstract Java class represents the result of the Server Management operation; Consider the known Java subclasses that extend this Java class: ServerShutdownResult.

The result is one of the following:

• IS_PROCESSING
• UNKNOWN_OPERATION
• UNKNOWN_SERVER

Implementation in Your Client Application

Use the getReason() method to get the resulting reason.

See Also:

ServerManagementOp

Field Summary

static int	IS_PROCESSING Reason when the server is processing the operation request: 0
static java.lang.String	REASON Mapping for the reason: "reason"
static int	UNKNOWN_OPERATION Reason concerning an unknown operation: 1
static int	UNKNOWN_SERVER Reason concerning an unknown server: 2

Constructor Summary

ServerManagementResult()

ServerManagementResult(java.lang.String serverName, int reason)

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	getMessage() Returns the message of this operation.
abstract java.lang.String	getName() Returns the name of this operation.
abstract java.lang.String	getOperandReference() Returns the operand reference for audit.
int	getReason() Gets the reason.
java.lang.String	getServerName() Gets the name of the server system.
void	marshal(XMLOutputter output) Writes the operation XML data to the specified output.
void	setAttributes(XMLAttributes atts) Sets the operation attributes from the XMLAttributes.
void	setMessage(java.lang.String message) Sets the message of the operation.
void	setReason(int reason) Sets the reason.
void	setServerName(java.lang.String name) Sets the name of the server system.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_SERVER

public static final int UNKNOWN_SERVER

Reason concerning an unknown server: 2

See Also:

Constant Field Values

UNKNOWN_OPERATION

public static final int UNKNOWN_OPERATION

Reason concerning an unknown operation: 1

See Also:

Constant Field Values

IS_PROCESSING

public static final int IS_PROCESSING

Reason when the server is processing the operation request: 0

See Also:

Constant Field Values

REASON

public static final java.lang.String REASON

Mapping for the reason: "reason"

See Also:

Constant Field Values

Constructor Detail

ServerManagementResult

public ServerManagementResult()

ServerManagementResult

public ServerManagementResult(java.lang.String serverName,
                              int reason)

Method Detail

getServerName

public java.lang.String getServerName()

Gets the name of the server system.

Returns:

The server name

setServerName

public void setServerName(java.lang.String name)

Sets the name of the server system.

Parameters:

name - The server name

getReason

public int getReason()

Gets the reason.

Returns:

The reason

See Also:

setReason(int), UNKNOWN_OPERATION, UNKNOWN_SERVER, IS_PROCESSING

setReason

public void setReason(int reason)

Sets the reason.

Parameters:

reason - The reason

See Also:

getReason(), UNKNOWN_OPERATION, UNKNOWN_SERVER, IS_PROCESSING

getName

public abstract java.lang.String getName()

Returns the name of this operation.

Returns:

The name of this operation

getMessage

public java.lang.String getMessage()

Returns the message of this operation.

Returns:

The message of this operation

setMessage

public void setMessage(java.lang.String message)

Sets the message of the operation.

Parameters:

message - The operation message

getOperandReference

public abstract java.lang.String getOperandReference()

Returns the operand reference for audit.

Specified by:

getOperandReference in interface OperationResult

Returns:

The operand reference for audit

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 specified output.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XMLOutputter to write to