com.broadleafcommerce.data.tracking.core

Interface EmbeddedContextStateAware

public interface EmbeddedContextStateAware

Defines additional information for embedded collection members of ContextStateAware business domains that describes aspects of those collection members related to the context of the request. For example which member items were changed and which fields therein.

A collection member item's EmbeddedContextState is only populated when coming out of the repository domain that maps into a business domain. This is not designed to be used in other scenarios.

Indicating that your embedded collection object should receive a context is as simple as implementing this interface for any business-domain equivalent of a collection item belonging to a repository domain that implements Tracking.

Author:

Nathan Moore (nathandmoore)

See Also:

ContextStateAware, EmbeddedContextState

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FIELD_NAME

Method Summary

Modifier and Type	Method and Description
EmbeddedContextState	getContextState() Retrieves additional information for the business domain's embedded collection members that describes aspects of those members related to the context of the request
void	setContextState(EmbeddedContextState contextState) Set additional information for the business domain's embedded collection members that describes aspects of those members related to the context of the request

Field Detail

DEFAULT_FIELD_NAME

static final String DEFAULT_FIELD_NAME

See Also:

Constant Field Values

Method Detail

getContextState

EmbeddedContextState getContextState()

Retrieves additional information for the business domain's embedded collection members that describes aspects of those members related to the context of the request

Returns:

additional information for the business domain's embedded collection members that describes aspects of those members related to the context of the request

setContextState

void setContextState(EmbeddedContextState contextState)

Set additional information for the business domain's embedded collection members that describes aspects of those members related to the context of the request

Parameters:

contextState - additional information for the business domain's embedded collection members that describes aspects of those members related to the context of the request