com.ibm.commerce.catalog.businesscontextimpl

Class CatalogContextImpl

java.lang.Object

com.ibm.commerce.context.baseimpl.AbstractContextImpl

com.ibm.commerce.catalog.businesscontextimpl.CatalogContextImpl

All Implemented Interfaces:

CatalogContext, Context, ContextSPI, java.io.Serializable

public class CatalogContextImpl
extends AbstractContextImpl
implements CatalogContext

This command will hold contextual information of the catalog that is in the current session.

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from class com.ibm.commerce.context.baseimpl.AbstractContextImpl

SER_VALUE_SEP

Fields inherited from interface com.ibm.commerce.catalog.businesscontext.CatalogContext

CATALOG_ID, CONTEXT_NAME, MASTER_CATALOG

Constructor Summary

Constructors

Constructor and Description
CatalogContextImpl() This is the default constructor for this class and it invokes the super.

Method Summary

Modifier and Type	Method and Description
void	clearContext() Clears the attributes defined for the context.
void	copyContext(Context ctx) Copies the the attributes of the catalog context from another catalog context.
java.lang.String	getCatalogID() This method gets the unique ID of the catalog in context.
java.lang.Object[]	getContextAttributes() Return the attributes defined by the context.
java.lang.String	getContextName() Gets the name of the context.
java.lang.String	getOwnerID() This method will return the catalog owner ID of the catalog in context.
void	initializeContext(com.ibm.commerce.component.contextservice.ActivityData initData) This method initializes the context value.
boolean	isEntitlementCheckAlwaysEnforced() Check if the entitlement check is always enforced.
boolean	isMasterCatalog() Check if this is the master catalog.
void	preInvokeContext(com.ibm.commerce.component.contextservice.ActivityData sessionData) This method updates this context based on the given session data.
void	setCatalogID(java.lang.String id) This method sets the unique ID of the catalog in context.
void	setContextAttributes(java.lang.String[] ctxAttrs) Set the attributes for this context.
void	setMasterCatalog(boolean isMaster) Sets the master catalog flag.
void	setOwnerID(java.lang.String id) This method will set the catalog owner ID of the catalog in context.
boolean	validate() Performs validation of context attributes.

Methods inherited from class com.ibm.commerce.context.baseimpl.AbstractContextImpl

clear, getActivityToken, getContextSerializedString, initialize, initialize, initializeContext, isDirty, postInvoke, postInvokeContext, preInvoke, recalibrate, recalibrateContext, reset, resetContext, setContextSerializedString, setDirty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.commerce.context.base.Context

getActivityToken

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

CatalogContextImpl

public CatalogContextImpl()

This is the default constructor for this class and it invokes the super.

Method Detail

getCatalogID

public java.lang.String getCatalogID()

This method gets the unique ID of the catalog in context.

Specified by:

getCatalogID in interface CatalogContext

Returns:

Returns the unique ID of the catalog in context.

setCatalogID

public void setCatalogID(java.lang.String id)

This method sets the unique ID of the catalog in context.

Specified by:

setCatalogID in interface CatalogContext

Parameters:

id - Sets the unique ID of the catalog in context.

initializeContext

public void initializeContext(com.ibm.commerce.component.contextservice.ActivityData initData)
                       throws BusinessContextException

This method initializes the context value.

Overrides:

initializeContext in class AbstractContextImpl

Parameters:

initData - Initial data for context.

Throws:

BusinessContextException - Exception detected by the business context service.

See Also:

AbstractContextImpl.initializeContext(ActivityData)

preInvokeContext

public void preInvokeContext(com.ibm.commerce.component.contextservice.ActivityData sessionData)
                      throws BusinessContextException

This method updates this context based on the given session data. This method is called by the startRequest() method of the business context service before request execution.

Specified by:

preInvokeContext in class AbstractContextImpl

Parameters:

sessionData - the map of name-value pairs for the parameters that are passed in the request

Throws:

BusinessContextException - Exception detected during business context processing.

See Also:

AbstractContextImpl.preInvokeContext(com.ibm.commerce.component.contextservice.ActivityData)

getContextAttributes

public java.lang.Object[] getContextAttributes()
                                        throws BusinessContextException

Return the attributes defined by the context.

Specified by:

getContextAttributes in class AbstractContextImpl

Returns:

the array of attributes to include in the string representation of this context

Throws:

BusinessContextException - Exception detected during processing.

See Also:

AbstractContextImpl.getContextAttributes()

setContextAttributes

public void setContextAttributes(java.lang.String[] ctxAttrs)
                          throws BusinessContextException

Set the attributes for this context.

Specified by:

setContextAttributes in class AbstractContextImpl

Parameters:

ctxAttrs - given array of context attributes

Throws:

BusinessContextException - Exception detected during processing.

See Also:

AbstractContextImpl.setContextAttributes(java.lang.String[])

clearContext

public void clearContext()

Clears the attributes defined for the context.

Specified by:

clearContext in class AbstractContextImpl

Throws:

BusinessContextException - Exception detected during processing.

See Also:

AbstractContextImpl.clearContext()

getContextName

public java.lang.String getContextName()

Gets the name of the context.

Specified by:

getContextName in interface Context

Returns:

the name of this context

Throws:

BusinessContextException - Exception detected during processing.

See Also:

Context.getContextName()

validate

public boolean validate()
                 throws BusinessContextException

Performs validation of context attributes.

Specified by:

validate in interface Context

Returns:

true if all the attributes are valid

Throws:

BusinessContextException - Exception detected during processing.

See Also:

Context.validate()

copyContext

public void copyContext(Context ctx)

Copies the the attributes of the catalog context from another catalog context.

Specified by:

copyContext in interface Context

Parameters:

ctx - the context to copy from

Throws:

BusinessContextException - Exception detected during processing.

See Also:

Context.copyContext(com.ibm.commerce.context.base.Context)

getOwnerID

public java.lang.String getOwnerID()

This method will return the catalog owner ID of the catalog in context.

Specified by:

getOwnerID in interface CatalogContext

Returns:

Returns the owner ID.

setOwnerID

public void setOwnerID(java.lang.String id)

This method will set the catalog owner ID of the catalog in context.

Specified by:

setOwnerID in interface CatalogContext

Parameters:

id - the owner ID to set.

isMasterCatalog

public boolean isMasterCatalog()

Check if this is the master catalog.

Specified by:

isMasterCatalog in interface CatalogContext

Returns:

Returns true if this is the master catalog.

setMasterCatalog

public void setMasterCatalog(boolean isMaster)

Sets the master catalog flag.

Specified by:

setMasterCatalog in interface CatalogContext

Parameters:

isMaster - True if this is the master catalog.

isEntitlementCheckAlwaysEnforced

public boolean isEntitlementCheckAlwaysEnforced()

Check if the entitlement check is always enforced.

Specified by:

isEntitlementCheckAlwaysEnforced in interface CatalogContext

Returns:

Returns true if entitlement check is always enforced.