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. This config only works on discovery service data sources, and resolves to a no-op on ENE presentation API data sources.

See Also:

Serialized Form

Field Summary

static java.lang.String	DEFAULT_ID
static java.lang.String	HANDLER_FUNCTION

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

id

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

CLASS_PROPERTY

Constructor Summary

BreadcrumbsConfig()

BreadcrumbsConfig(boolean returnFullPath)
Instantiate the breadcrumbs with the default ID and the given value for the returnFullPath property.

BreadcrumbsConfig(java.lang.String id)
Instantiate the breadcrumbs with the specified ID. returnFullPath will be true.

BreadcrumbsConfig(java.lang.String id, boolean returnFullPath)
Instantiate the breadcrumbs with the specified ID and the specified value for the returnFullPath property.

Method Summary

void	applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query) Apply this function to a Request.
boolean	isReturnFullPath()
void	setReturnFullPath(boolean returnFullPath)
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

beforeQueryStateAdd, clone, equals, equals, getName, hashCode, initializeFromJSON, setName

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

HANDLER_FUNCTION

public static final java.lang.String HANDLER_FUNCTION

See Also:

Constant Field Values

Constructor Detail

BreadcrumbsConfig

public BreadcrumbsConfig()

BreadcrumbsConfig

public BreadcrumbsConfig(boolean returnFullPath)

Instantiate the breadcrumbs with the default ID and the given value for the returnFullPath property.

Parameters:

returnFullPath -

BreadcrumbsConfig

public BreadcrumbsConfig(java.lang.String id)

Instantiate the breadcrumbs with the specified ID. returnFullPath will be true.

Parameters:

id -

BreadcrumbsConfig

public BreadcrumbsConfig(java.lang.String id,
                         boolean returnFullPath)

Instantiate the breadcrumbs with the specified ID and the specified value for the returnFullPath property.

Parameters:

id -

returnFullPath -

Method Detail

isReturnFullPath

public boolean isReturnFullPath()

setReturnFullPath

public void setReturnFullPath(boolean returnFullPath)

applyToDiscoveryServiceQuery

public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
                                  throws QueryFunctionUnsupportedException

Description copied from class: QueryFunction

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

Specified by:

applyToDiscoveryServiceQuery in class QueryFunction

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