atg.repository.search.config
Interface SearchDimension

All Known Implementing Classes:

GenericDimensionService, LanguageDimensionService, RepositoryGroupDimensionService

public interface SearchDimension

This interface provide methods to check dimension matches.

Field Summary

static java.lang.String

CLASS_VERSION

Method Summary

boolean	dimensionMatchesValue(DynamoHttpServletRequest pRequest, java.lang.String pValue) Checks whether or not a value matches this service.
boolean	dimensionMatchesValue(RepositoryItem pProfile, java.lang.String pValue) Checks whether or not a value extracted from the given profile matches the given value.
boolean	dimensionMatchesValue(java.lang.String pSourceValue, java.lang.String pTargetValue) Checks whether or not a given source value matches the given target value.
java.util.List	getAllDimensionValues() Returns a list of string dimension values that are valid for this dimension and additional specific dimension values such as "All others"
java.lang.String	getDimensionName() Gets the string name of this dimension, e.g.
java.lang.String	getDimensionValueDisplayName(java.lang.String pDimensionValue) Gets the localised display name for a dimension value.
java.util.List	getDimensionValues() Returns a list of string dimension values that are valid for this dimension.
java.lang.String	getDisplayName() Gets the localised name for this dimension service.
boolean	isProfileBased()

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

getDimensionName

java.lang.String getDimensionName()

Gets the string name of this dimension, e.g. "language" or "segment".

Returns:

String name of this dimension.

getDisplayName

java.lang.String getDisplayName()

Gets the localised name for this dimension service.

Returns:

the String display name for this dimension service.

Throws:

java.util.MissingResourceException - if resource can't be found.

java.lang.NullPointerException - if locale or resource bundle name is null.

getDimensionValues

java.util.List getDimensionValues()

Returns a list of string dimension values that are valid for this dimension.

Returns:

List of String dimension values.

getAllDimensionValues

java.util.List getAllDimensionValues()

Returns a list of string dimension values that are valid for this dimension and additional specific dimension values such as "All others"

Returns:

List of String dimension values.

getDimensionValueDisplayName

java.lang.String getDimensionValueDisplayName(java.lang.String pDimensionValue)

Gets the localised display name for a dimension value.

Parameters:

pDimensionValue - String dimension value

Returns:

String display name for the dimension value.

Throws:

java.util.MissingResourceException - if resource can't be found.

java.lang.NullPointerException - if locale or resource bundle name is null.

dimensionMatchesValue

boolean dimensionMatchesValue(DynamoHttpServletRequest pRequest,
                              java.lang.String pValue)

Checks whether or not a value matches this service.

Parameters:

pRequest - is the current customer DynamoHttpServletRequest request.

pValue - is the dimensionValue property of the item being checked.

Returns:

true if pValue is matched with appropriate value from pRequest.

dimensionMatchesValue

boolean dimensionMatchesValue(java.lang.String pSourceValue,
                              java.lang.String pTargetValue)

Checks whether or not a given source value matches the given target value.

Parameters:

pSourceValue - String source value to check

pTargetValue - String target value to check.

Returns:

true if pSourceValue matches pTargetValue for this dimension

dimensionMatchesValue

boolean dimensionMatchesValue(RepositoryItem pProfile,
                              java.lang.String pValue)

Checks whether or not a value extracted from the given profile matches the given value.

Parameters:

pProfile - RepositoryItem profile to use

pValue - String vlaue to check.

Returns:

true if pValue matches the dimension value extracted from pProfile

isProfileBased

boolean isProfileBased()

Returns:

true if this dimension can determine the dimension value from a profile.