com.ibm.diameter.sh.util
Class PSUserState

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

public class PSUserState
extends UserState

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

See Also:
UserState, CSUserState, com.ibm.diameter.sh.DiameterShService#getPSUserState, com.ibm.diameter.sh.DiameterShService#getUserData

Field Summary
static int AttachedNotReachableForPaging
           
static int AttachedReachableForPaging
           
static int ConnectedNotReachableForPaging
           
static int ConnectedReachableForPaging
           
static int Detached
           
static int NetworkDeterminedNotReachable
           
static int NotProvidedFromSGSN
           
 
Constructor Summary
PSUserState()
           
 
Method Summary
 int getUserState()
          Used by an IMS Application Server application to retrieve the PSUserState value.
static boolean isPSUserStateDefined(int value)
          Used by the Sh subscriber profile Web service to determine if the PSUserState 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 PSUserState after parsing the XML file received from the HSS.
 java.lang.String toString()
          Debug method that returns the PSUserState 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

Detached

public static final int Detached
See Also:
Constant Field Values

AttachedNotReachableForPaging

public static final int AttachedNotReachableForPaging
See Also:
Constant Field Values

AttachedReachableForPaging

public static final int AttachedReachableForPaging
See Also:
Constant Field Values

ConnectedNotReachableForPaging

public static final int ConnectedNotReachableForPaging
See Also:
Constant Field Values

ConnectedReachableForPaging

public static final int ConnectedReachableForPaging
See Also:
Constant Field Values

NotProvidedFromSGSN

public static final int NotProvidedFromSGSN
See Also:
Constant Field Values

NetworkDeterminedNotReachable

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

PSUserState

public PSUserState()
Method Detail

getUserState

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

Specified by:
getUserState in class UserState
Returns:
PSUserState

setUserState

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

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

isPSUserStateDefined

public static boolean isPSUserStateDefined(int value)
Used by the Sh subscriber profile Web service to determine if the PSUserState 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 PSUserState 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.