com.stellent.cis.client.api.common
Interface ICISCommonContext

All Superinterfaces:

ICISObjectInitializable, java.io.Serializable

public interface ICISCommonContext
extends java.io.Serializable, ICISObjectInitializable

Passed into common search methods, identifies which adapters to query and what user information to use.

Nested Class Summary

Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

ICISObjectInitializable.AdapterVersionAware

Field Summary

static java.lang.String

BEAN_ID ID for storage of this object in a web context

Method Summary

void	addContext(IContext ctx) Adds a context to the query.
void	clearContexts() Resets this object to contain no context objects.
IContext	getContext(java.lang.String adapterName) Retrieve a context associated with the given adapter
java.util.Collection	getContexts()
boolean	isHasGuestContexts()
void	setContexts(java.util.Collection contexts) Replaces current context values with supplied list.

Methods inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

intialize

Field Detail

BEAN_ID

static final java.lang.String BEAN_ID

ID for storage of this object in a web context

See Also:

Constant Field Values

Method Detail

addContext

void addContext(IContext ctx)

Adds a context to the query.

Parameters:

ctx - The context to add.

getContext

IContext getContext(java.lang.String adapterName)

Retrieve a context associated with the given adapter

Parameters:

adapterName - the adapter name

Returns:

the context associated with that adapter or null if no such context exists

getContexts

java.util.Collection getContexts()

Returns:

Returns a list of current contexts.

clearContexts

void clearContexts()

Resets this object to contain no context objects.

setContexts

void setContexts(java.util.Collection contexts)

Replaces current context values with supplied list.

Parameters:

contexts - A list of IContext objects.

isHasGuestContexts

boolean isHasGuestContexts()

Returns:

true if one or more of the context objects is a guest context (i.e. IContext.isGuest() == true)