com.stellent.cis.client.context
Interface IContext

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ISCSContext, ISISContext

public interface IContext
extends java.io.Serializable

Generic context used for communication with Command APIs.

Method Summary

java.lang.String	getAdapterName() Get the name of the adapter to use
java.lang.String	getContextPath() Gets the path that is the root of a request with this context
java.lang.String	getDevice() Get the user's device
java.util.Locale	getLocale() Get the current user's locale
java.lang.String	getSessionID() Gets the session ID for this context
java.lang.String	getUser() Get the user ID.
boolean	isGuest() Determines if this is a guest account.
void	setAdapterName(java.lang.String adapterName) Set the name of the adapter
void	setContextPath(java.lang.String path) The context path that is the root of a request with this context
void	setDevice(java.lang.String device) Set the user's device
void	setGuest(boolean isGuest) Sets whether this is a guest account
void	setLocale(java.util.Locale locale) Set the current users locale
void	setSessionID(java.lang.String id) Set the session ID for this context
void	setUser(java.lang.String user) Set the user ID to use in the context

Method Detail

getUser

java.lang.String getUser()

Get the user ID. This is the current active user ID as known to the J2EE server.

Returns:

the user id

setUser

void setUser(java.lang.String user)

Set the user ID to use in the context

Parameters:

user - the user ID to set

getLocale

java.util.Locale getLocale()

Get the current user's locale

Returns:

the current user's locale, or null if using the default system/JVM locale

setLocale

void setLocale(java.util.Locale locale)

Set the current users locale

Parameters:

locale - the locale of the current user

getDevice

java.lang.String getDevice()

Get the user's device

Returns:

the user's device

setDevice

void setDevice(java.lang.String device)

Set the user's device

Parameters:

device - the user's device

isGuest

boolean isGuest()

Determines if this is a guest account.

Returns:

true if this is a guest account, false otherwise

setGuest

void setGuest(boolean isGuest)

Sets whether this is a guest account

Parameters:

isGuest - set to true if this is a guest account, false otherwise

getAdapterName

java.lang.String getAdapterName()

Get the name of the adapter to use

Returns:

the adapter name or null for the default

setAdapterName

void setAdapterName(java.lang.String adapterName)

Set the name of the adapter

Parameters:

adapterName - set the adapter name or null for the default

setContextPath

void setContextPath(java.lang.String path)

The context path that is the root of a request with this context

Parameters:

path - the context path

getContextPath

java.lang.String getContextPath()

Gets the path that is the root of a request with this context

Returns:

the context path

getSessionID

java.lang.String getSessionID()

Gets the session ID for this context

Returns:

a unique ID for this context

setSessionID

void setSessionID(java.lang.String id)

Set the session ID for this context

Parameters:

id - the unique session ID for this context