org.opennms.protocols.wmi
Class WmiResult

java.lang.Object
  extended by org.opennms.protocols.wmi.WmiResult

public class WmiResult
extends Object

This object implements the results received by the WmiManager system.

Author:
Matt Raykowski

Field Summary
static short RES_STATE_CRIT
          This value is used to state the the service check was validated and needs immediate attention, an outage has occurred.
static short RES_STATE_OK
          This value is used to state that the service check was validated OK.
static short RES_STATE_UNKNOWN
          This value is used when a service check validation has unknown results.
static HashMap<String,Short> StateStrings
          This member is used to convert result codes to strings and vice versa.
 
Method Summary
static String convertStateToString(short type)
          This method converts a result code to a string.
static short convertStringToType(String type)
          This method returns the result code for a corresponding string.
 ArrayList<Object> getResponse()
          Returns the value of the server response.
 short getResultCode()
          Returns the result code for the validation.
 void setResultCode(short res)
          This method sets the result code for the check validation.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RES_STATE_OK

public static final short RES_STATE_OK
This value is used to state that the service check was validated OK.

See Also:
Constant Field Values

RES_STATE_CRIT

public static final short RES_STATE_CRIT
This value is used to state the the service check was validated and needs immediate attention, an outage has occurred.

See Also:
Constant Field Values

RES_STATE_UNKNOWN

public static final short RES_STATE_UNKNOWN
This value is used when a service check validation has unknown results.

See Also:
Constant Field Values

StateStrings

public static HashMap<String,Short> StateStrings
This member is used to convert result codes to strings and vice versa.

Method Detail

convertStateToString

public static String convertStateToString(short type)
This method converts a result code to a string.

Parameters:
type - the result code to convert
Returns:
the string name of the result code passed, default "UNKNOWN" if no correspond code found.

convertStringToType

public static short convertStringToType(String type)
This method returns the result code for a corresponding string.

Parameters:
type - the string name of the result code.
Returns:
the short ID for the result code.

getResponse

public ArrayList<Object> getResponse()
Returns the value of the server response.

Returns:
the value of the server response.

getResultCode

public short getResultCode()
Returns the result code for the validation.

Returns:
the result code for the validation.

setResultCode

public void setResultCode(short res)
This method sets the result code for the check validation.

Parameters:
res - the result code.

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2009. All Rights Reserved.