com.ibm.diameter.sh.util
Class CSUserState

java.lang.Object
  extended by com.ibm.diameter.sh.util.UserState
      extended by com.ibm.diameter.sh.util.CSUserState

public class CSUserState
extends UserState

The CSUserState object correlates to the CSUserState element defined in ShDataType.xsd. CSUserState extends the UserState object. The ShDataType.xsd schema defines the follwing states for CSUserState:

See Also:
UserState, PSUserState, com.ibm.diameter.sh.DiameterShService#getCSUserState, com.ibm.diameter.sh.DiameterShService#getUserData

Field Summary
static int AssumedIdle
           
static int CAMELBusy
           
static int NetworkDeterminedNotReachable
           
static int NotProvidedfromVLR
           
 
Constructor Summary
CSUserState()
           
 
Method Summary
 int getUserState()
          Used by an IMS Application Server application to retrieve the CSUserState value.
static boolean isCSUserStateDefined(int value)
          Used by the Sh subscriber profile Web service to determine if the CSUserState value received from the HSS is recognized as a valid state value.
 void setUserState(int state)
          Used by the Sh subscriber profile Web service to set CSUserState after parsing the XML file received from the HSS.
 java.lang.String toString()
          Debug method that returns the CSUserState as a String for inclusion in (English only) trace logs.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CAMELBusy

public static final int CAMELBusy
See Also:
Constant Field Values

NetworkDeterminedNotReachable

public static final int NetworkDeterminedNotReachable
See Also:
Constant Field Values

AssumedIdle

public static final int AssumedIdle
See Also:
Constant Field Values

NotProvidedfromVLR

public static final int NotProvidedfromVLR
See Also:
Constant Field Values
Constructor Detail

CSUserState

public CSUserState()
Method Detail

getUserState

public int getUserState()
Used by an IMS Application Server application to retrieve the CSUserState value.

Specified by:
getUserState in class UserState
Returns:
CSUserState

setUserState

public void setUserState(int state)
Used by the Sh subscriber profile Web service to set CSUserState after parsing the XML file received from the HSS.

Specified by:
setUserState in class UserState
Parameters:
Sets - the CSUserState.

isCSUserStateDefined

public static boolean isCSUserStateDefined(int value)
Used by the Sh subscriber profile Web service to determine if the CSUserState value received from the HSS is recognized as a valid state value.

Parameters:
state - value to be tested
Returns:
boolean indicating whether the specified state value is valid

toString

public java.lang.String toString()
Debug method that returns the CSUserState as a String for inclusion in (English only) trace logs.

Overrides:
toString in class java.lang.Object
Returns:
The String representation of this object for debug purposes only.


Copyright © 2006 IBM Corp. All Rights Reserved.