com.endeca.portal.data.functions

Class BreadcrumbsConfig

java.lang.Object

com.endeca.portal.data.functions.QueryFunction

com.endeca.portal.data.functions.QueryConfig

com.endeca.portal.data.functions.BreadcrumbsConfig

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class BreadcrumbsConfig
extends QueryConfig

Configure how breadcrumbs will be returned on the QueryState's executed results.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ID

Fields inherited from class com.endeca.portal.data.functions.QueryConfig

id

Fields inherited from class com.endeca.portal.data.functions.QueryFunction

CLASS_PROPERTY, VIEWKEY_PROPERTY

Constructor Summary

Constructors

Constructor and Description
BreadcrumbsConfig()
BreadcrumbsConfig(java.lang.String id) Instantiate the breadcrumbs with the specified ID

Method Summary

Methods

Modifier and Type	Method and Description
void	applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.types.Request query, java.lang.String stateName) Apply this function to a Request.
java.lang.String	toString() This class' toString is abstract: all concrete subclasses are expected to provide an implementation. toString is used in comparing QueryFunction instances for equality, so if you implement a QueryFunction subclass it is important that your toString implementation be consistent and deterministic.

Methods inherited from class com.endeca.portal.data.functions.QueryConfig

getId, setId

Methods inherited from class com.endeca.portal.data.functions.QueryFunction

applyToDiscoveryServiceQuery, beforeQueryStateAdd, beforeQueryStateRemove, clone, equals, equals, getCompareString, getName, getStateNameOverride, getVersion, getViewKey, hashCode, initializeFromJSON, isInvalid, setInvalid, setName, setStateNameOverride, setVersion, setViewKey, upgrade

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_ID

public static final java.lang.String DEFAULT_ID

See Also:

Constant Field Values

Constructor Detail

BreadcrumbsConfig

public BreadcrumbsConfig()

BreadcrumbsConfig

public BreadcrumbsConfig(java.lang.String id)

Instantiate the breadcrumbs with the specified ID

Parameters:

id -

Method Detail

applyToDiscoveryServiceQuery

public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.types.Request query,
                                java.lang.String stateName)
                                  throws QueryFunctionUnsupportedException

Description copied from class: QueryFunction

Apply this function to a Request. Must be implemented by subclass.

Specified by:

applyToDiscoveryServiceQuery in class QueryFunction

Parameters:

query - the CS Request to which this function should be applied

stateName - stateName to use for filters or content element configs

Throws:

QueryFunctionUnsupportedException

toString

public java.lang.String toString()

Description copied from class: QueryFunction

This class' toString is abstract: all concrete subclasses are expected to provide an implementation. toString is used in comparing QueryFunction instances for equality, so if you implement a QueryFunction subclass it is important that your toString implementation be consistent and deterministic.

Specified by:

toString in class QueryFunction