oracle.dmt.op.re.reapi.rt
Class IdentificationData

java.lang.Object
oracle.dmt.op.re.reapi.rt.IdentificationData

public class IdentificationData

extends java.lang.Object

This class encapsulates the user identification information.

Since:

9.0.0

Method Summary

static IdentificationData	createSessionful(java.lang.String sessionId) Creates a new ID object for a sessionful session.
static IdentificationData	createSessionful(java.lang.String sessionId, Enum.UserType userType) Creates a new ID object for a sessionful session.
static IdentificationData	createSessionless(java.lang.String userID) Creates a new sessionless session.
static IdentificationData	createSessionless(java.lang.String userID, Enum.UserType userType)
java.lang.String	getAppSessionID() Returns the seesion ID given by the host app.
java.lang.String	getUserID() Returns user ID.
Enum.UserType	getUserType() Returns the user type, Visitor or Customer, as defined in Enum.UserType.
boolean	validateIDPair() Checks if this IdentificationData object contains a valid pair of IDs.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getUserID

public java.lang.String getUserID()

Returns user ID.

getAppSessionID

public java.lang.String getAppSessionID()

Returns the seesion ID given by the host app.

getUserType

public Enum.UserType getUserType()

Returns the user type, Visitor or Customer, as defined in Enum.UserType.

createSessionful

public static IdentificationData createSessionful(java.lang.String sessionId)
                                           throws NullParameterException

Creates a new ID object for a sessionful session.

Parameters:

sessionId - session ID assigned by the host app

Throws:

NullParameterException

createSessionful

public static IdentificationData createSessionful(java.lang.String sessionId,
                                                  Enum.UserType userType)
                                           throws NullParameterException

Creates a new ID object for a sessionful session.

Parameters:

sessionId - assigned by the host app

userType - Customer or Visitor; see Enum.UserType

Throws:

NullParameterException

createSessionless

public static IdentificationData createSessionless(java.lang.String userID)
                                            throws NullParameterException

Creates a new sessionless session.

Parameters:

userID -

Throws:

NullParameterException

createSessionless

public static IdentificationData createSessionless(java.lang.String userID,
                                                   Enum.UserType userType)
                                            throws NullParameterException

Throws:

NullParameterException

validateIDPair

public boolean validateIDPair()

Checks if this IdentificationData object contains a valid pair of IDs.

Returns:

true if the ID pair is valid, false otherwise