com.endeca.infront.cartridge.model

Class SearchBreadcrumb

java.lang.Object

com.endeca.infront.cartridge.model.SearchBreadcrumb

All Implemented Interfaces:

Breadcrumb

public class SearchBreadcrumb
extends Object
implements Breadcrumb

SearchBreadcrumb is a Breadcrumbs element that contains information about an active keyword search.

Constructor Summary

Constructors

Constructor and Description
SearchBreadcrumb()

Method Summary

Methods

Modifier and Type	Method and Description
String	getCorrectedTerms()
String	getKey()
MatchMode	getMatchMode()
NavigationAction	getRemoveAction() Returns a navigation action with the necessary information to remove this breadcrumb.
String	getTerms()
void	setCorrectedTerms(String terms) Sets the terms that were corrected.
void	setKey(String key) Sets the search key of this SearchBreadcrumb.
void	setMatchMode(MatchMode matchMode) Sets the match mode of this SearchBreadcrumb.
void	setRemoveAction(NavigationAction removeAction) Sets the remove action of this SearchBreadcrumb.
void	setTerms(String terms) Sets the term of this SearchBreadcrumb.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchBreadcrumb

public SearchBreadcrumb()

Method Detail

getRemoveAction

public NavigationAction getRemoveAction()

Returns a navigation action with the necessary information to remove this breadcrumb.

Specified by:

getRemoveAction in interface Breadcrumb

Returns:

A NavigationAction that will remove this Breadcrumb.

setRemoveAction

public void setRemoveAction(NavigationAction removeAction)

Sets the remove action of this SearchBreadcrumb.

Parameters:

removeAction - the action that will remove this SearchBreadcrumb

getKey

public String getKey()

Returns:

The search key (property or dimension) to be searched upon.

setKey

public void setKey(String key)

Sets the search key of this SearchBreadcrumb.

Parameters:

key - the search key for this breadcrumb

getMatchMode

public MatchMode getMatchMode()

Returns:

The match mode to be used.

setMatchMode

public void setMatchMode(MatchMode matchMode)

Sets the match mode of this SearchBreadcrumb.

Parameters:

matchMode - the match mode

See Also:

MatchMode

getTerms

public String getTerms()

Returns:

The terms that were searched.

setTerms

public void setTerms(String terms)

Sets the term of this SearchBreadcrumb.

Parameters:

terms - The terms of the search

getCorrectedTerms

public String getCorrectedTerms()

Returns:

The corrected terms. If no terms were corrected, returns null.

setCorrectedTerms

public void setCorrectedTerms(String terms)

Sets the terms that were corrected.

Parameters:

terms - The corrected terms