com.ibm.commerce.context.base

Interface Context

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

AuditContext, BaseContext, CatalogContext, ContentContext, EntitlementContext, ExperimentContext, GiftCenterContext, GiftRegistryContext, GlobalizationContext, PreviewContext, TaskContext

All Known Implementing Classes:

AbstractContextImpl, CatalogContextImpl, ExperimentContextImpl, GiftCenterContextImpl, GiftRegistryContextImpl, PreviewContextImpl, StoreGeoCodeContextImpl

public interface Context
extends java.io.Serializable

Context API: the interface that a command or an application will use to interact with a business context.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Method Summary

Modifier and Type	Method and Description
void	copyContext(Context ctx) This method copies the content of a given context to this context.
ActivityToken	getActivityToken() This method gets the token that represents this context's activity.
java.lang.String	getContextName() This method gets the name of this context.
boolean	validate() This method checks whether this context's attributes are valid.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Method Detail

getActivityToken

ActivityToken getActivityToken()

This method gets the token that represents this context's activity.

Returns:

this context's activity token

getContextName

java.lang.String getContextName()

This method gets the name of this context.

Returns:

the name of this context

validate

boolean validate()
          throws BusinessContextException

This method checks whether this context's attributes are valid.

Returns:

true if all the attributes are valid

Throws:

BusinessContextException - if any one of the attributes is not valid

copyContext

void copyContext(Context ctx)

This method copies the content of a given context to this context.

Parameters:

ctx - the context to copy from