Package 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 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:

<h3 id="seeIMPL3 class="j">Implementation in Your Client Application

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

See Also:

  • Field Details

    • UNKNOWN_SERVER

      public static final int UNKNOWN_SERVER
      Reason concerning an unknown server: 2
      See Also:

    • UNKNOWN_OPERATION

      public static final int UNKNOWN_OPERATION
      Reason concerning an unknown operation: 1
      See Also:

    • IS_PROCESSING

      public static final int IS_PROCESSING
      Reason when the server is processing the operation request: 0
      See Also:

    • REASON

      public static final String REASON
      Mapping for the reason: "reason"
      See Also:

  • Constructor Details

    • ServerManagementResult

      public ServerManagementResult()

    • ServerManagementResult

      public ServerManagementResult(String serverName, int reason)

  • Method Details

    • getServerName

      public String getServerName()
      Gets the name of the server system.
      Returns:
      The server name

    • setServerName

      public void setServerName(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

      public void setReason(int reason)
      Sets the reason.
      Parameters:
      reason - The reason
      See Also:

    • getName

      public abstract String getName()
      Returns the name of this operation.
      Returns:
      The name of this operation

    • getMessage

      public String getMessage()
      Returns the message of this operation.
      Returns:
      The message of this operation

    • setMessage

      public void setMessage(String message)
      Sets the message of the operation.
      Parameters:
      message - The operation message

    • getOperandReference

      public abstract 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(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(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