atg.commerce.util

Interface ContextValueSource

All Known Implementing Classes:

ContextValueSourceImpl, ProfileContextValueSource, SiteContextValueSource

public interface ContextValueSource

Represents an additional source of context values that ContextValueRetriever can consult.

Created: June 24 2016

See Also:

ContextValueRetriever

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string from source code control system.
static RepositoryItem	DEFAULT_VALUE A repository item that a ContextValueSource can return to represent that no following ContenxtValueSources should be consulted, and the default behavior should be invoked.

Method Summary

Modifier and Type	Method and Description
RepositoryItem	retrieveValue(atg.commerce.util.ContextValueRetrieverArguments pArguments) Determine the appropriate value for one profile property based on information provided in an arguments object.
void	setContextValueRetriever(ContextValueRetriever pContextValueRetriever) Sets property contextValueRetriever.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string from source code control system.

See Also:

Constant Field Values

DEFAULT_VALUE

static final RepositoryItem DEFAULT_VALUE

A repository item that a ContextValueSource can return to represent that no following ContenxtValueSources should be consulted, and the default behavior should be invoked.

Method Detail

setContextValueRetriever

void setContextValueRetriever(ContextValueRetriever pContextValueRetriever)

Sets property contextValueRetriever. Our owning ContextValueRetriever, set during ContextValueRetriever's doStartService.

Parameters:

pContextValueRetriever - our owning context value retriever.

retrieveValue

RepositoryItem retrieveValue(atg.commerce.util.ContextValueRetrieverArguments pArguments)
                      throws RepositoryException

Determine the appropriate value for one profile property based on information provided in an arguments object.

Parameters:

pArguments - an object containing properties that define possible sources for the value to be retrieved

Returns:

a RepositoryItem (or null). The DEFAULT_VALUE constant can be returned, indicating that following ContextValueSources should not be consulted, and the default (non-override) value should be retrieved.

Throws:

RepositoryException