com.webct.platform.sdk.systemintegrationapi.common
Class StatusCode

java.lang.Object
  extended by com.webct.platform.sdk.systemintegrationapi.common.StatusCode
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class StatusCode
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

This class provides for type-safe status code constants, allowing lookup of a constant instance given either a String label or an int value.

See Also:
Serialized Form

Field Summary
static StatusCode FAILURE
          FAILURE
static int FAILURE_ID
           
static StatusCode PARTIAL_FAILURE
          PARTIAL_FAILURE
static int PARTIAL_FAILURE_ID
           
static StatusCode SUCCESS
          SUCCESS
static int SUCCESS_ID
           
static StatusCode UNPROCESSED
          UNPROCESSED
static int UNPROCESSED_ID
           
 
Method Summary
 java.lang.Object clone()
          Creates a clone.
 boolean equals(java.lang.Object obj)
          Evaluates for equivalence.
 int hashCode()
          Returns a unique identifier for this instance.
 int intValue()
          Returns the integer value.
static StatusCode lookup(int value)
          Gets the appropriate StatusCode given an integer value.
static StatusCode lookup(java.lang.String value)
          Gets the appropriate StatusCode given a string value.
 java.lang.String toString()
          Returns the string representation.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

UNPROCESSED_ID

public static final int UNPROCESSED_ID
See Also:
Constant Field Values

SUCCESS_ID

public static final int SUCCESS_ID
See Also:
Constant Field Values

PARTIAL_FAILURE_ID

public static final int PARTIAL_FAILURE_ID
See Also:
Constant Field Values

FAILURE_ID

public static final int FAILURE_ID
See Also:
Constant Field Values

UNPROCESSED

public static final StatusCode UNPROCESSED
Description copied from class: StatusCode
UNPROCESSED


SUCCESS

public static final StatusCode SUCCESS
Description copied from class: StatusCode
SUCCESS


PARTIAL_FAILURE

public static final StatusCode PARTIAL_FAILURE
Description copied from class: StatusCode
PARTIAL_FAILURE


FAILURE

public static final StatusCode FAILURE
Description copied from class: StatusCode
FAILURE

Method Detail

lookup

public static StatusCode lookup(int value)
Description copied from class: StatusCode
Gets the appropriate StatusCode given an integer value.

Returns:
The StatusCode reference that matches the value or null

lookup

public static StatusCode lookup(java.lang.String value)
Description copied from class: StatusCode
Gets the appropriate StatusCode given a string value.

Returns:
The StatusCode reference that matches the value or null

intValue

public final int intValue()
Description copied from class: StatusCode
Returns the integer value.


toString

public final java.lang.String toString()
Description copied from class: StatusCode
Returns the string representation.

Overrides:
toString in class java.lang.Object

hashCode

public int hashCode()
Description copied from class: StatusCode
Returns a unique identifier for this instance.

Overrides:
hashCode in class java.lang.Object
Returns:
Unique identifing value

equals

public boolean equals(java.lang.Object obj)
Description copied from class: StatusCode
Evaluates for equivalence.

Overrides:
equals in class java.lang.Object
Parameters:
obj - object of comparison
Returns:
true or false

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Description copied from class: StatusCode
Creates a clone.

Overrides:
clone in class java.lang.Object
Returns:
Object
Throws:
java.lang.CloneNotSupportedException


Copyright © 2000-2004 WebCT Corp. All Rights Reserved.