no.sesat.search.view.config
Class SearchTab

java.lang.Object
  no.sesat.search.view.config.SearchTab

All Implemented Interfaces:

Serializable

public final class SearchTab
extends Object
implements Serializable

Immutable POJO holding the view configuration for a given tab.

Version:

$Id: SearchTab.java 7225 2009-04-09 00:32:20Z ssmiweve $

See Also:

Serialized Form

Nested Class Summary

static class	SearchTab.EnrichmentHint Immutable POJO holding Enrichment properties from a given tab.
static class	SearchTab.EnrichmentPlacementHint Immutable POJO holdng Enrichment Placement properties for a given placement on a given tab.
static class	SearchTab.Layout POJO holding defaultLayout information for the given tab.
static class	SearchTab.Scope

Field Summary

static String

PARAMETER_KEY

Constructor Summary

SearchTab(SearchTab inherit, String id, String mode, String key, String parentKey, String rssResultName, boolean rssHidden, NavigationConfig navConf, Collection<SearchTab.EnrichmentPlacementHint> placements, Collection<SearchTab.EnrichmentHint> enrichments, String adCommand, int adLimit, int adOnTop, List<String> css, List<String> javascript, boolean displayCss, boolean executeOnBlank, SearchTab.Layout defaultLayout, Map<String,SearchTab.Layout> layouts, SearchTab.Scope scope)
Creates a new instance of SearchTab

Method Summary

String	getAdCommand() Getter for property adCommand.
int	getAdLimit() Getter for property adsLimit.
int	getAdOnTop() Getter for property adOnTop.
List<SearchTab>	getAncestry()
List<String>	getCss() Deprecated. css definitions belong against the layout.
SearchTab.Layout	getDefaultLayout() Getter for property defaultLayout.
SearchTab.EnrichmentHint	getEnrichmentByCommand(String command)
SearchTab.EnrichmentPlacementHint	getEnrichmentPlacement(String id)
Collection<SearchTab.EnrichmentHint>	getEnrichments() Getter for property enrichments.
String	getId() Getter for property id.
SearchTab	getInherit() Getter for property inherit.
List<String>	getJavascript() Deprecated. javascript definitions belong against the layout.
String	getKey() Getter for property key.
Map<String,SearchTab.Layout>	getLayouts()
String	getMode() Getter for property mode.
NavigationConfig	getNavigationConfiguration()
String	getParentKey() Getter for property parentKey.
String	getRealKey() Getter for the property key.
String[]	getRssCommands() Getter for property rssResultName.
boolean	getRssHidden() Deprecated. Not JavaBean compatable. Use isRssHidden() instead.
String	getRssResultName() Getter for property rssResultName.
SearchTab.Scope	getScope()
boolean	getShowRss() Deprecated. Not JavaBean compatable. Use isShowRss() instead.
boolean	isDisplayCss() Deprecated. css definitions belong against the layout.
boolean	isExecuteOnBlank() Getter for property executeOnFront
boolean	isRssHidden() Returns true if there should be no visible links to the rss version of this tab.
boolean	isShowRss() Getter for property showRss
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_KEY

public static final String PARAMETER_KEY

See Also:

Constant Field Values

Constructor Detail

SearchTab

public SearchTab(SearchTab inherit,
                 String id,
                 String mode,
                 String key,
                 String parentKey,
                 String rssResultName,
                 boolean rssHidden,
                 NavigationConfig navConf,
                 Collection<SearchTab.EnrichmentPlacementHint> placements,
                 Collection<SearchTab.EnrichmentHint> enrichments,
                 String adCommand,
                 int adLimit,
                 int adOnTop,
                 List<String> css,
                 List<String> javascript,
                 boolean displayCss,
                 boolean executeOnBlank,
                 SearchTab.Layout defaultLayout,
                 Map<String,SearchTab.Layout> layouts,
                 SearchTab.Scope scope)

Creates a new instance of SearchTab

Parameters:

inherit -

id -

mode -

key -

parentKey -

rssResultName -

rssHidden -

navConf -

placements -

enrichments -

adCommand -

adLimit -

adOnTop -

css -

javascript -

defaultLayout -

displayCss -

executeOnBlank -

layouts -

scope -

Method Detail

getId

public String getId()

Getter for property id.

Returns:

Value of property id.

getAdCommand

public String getAdCommand()

Getter for property adCommand.

Returns:

Value of property adCommand.

getAdLimit

public int getAdLimit()

Getter for property adsLimit.

Returns:

Value of property adsLimit.

getAdOnTop

public int getAdOnTop()

Getter for property adOnTop.

Returns:

Value of property adOnTop.

getInherit

public SearchTab getInherit()

Getter for property inherit.

Returns:

Value of property inherit.

getKey

public String getKey()

Getter for property key. Implicitly favours parent-key if it exists.

Returns:

Value of property key.

getRealKey

public String getRealKey()

Getter for the property key. Does not give prefence to parent-key like "getKey()" does.

Returns:

Valaue of property key.

getParentKey

public String getParentKey()

Getter for property parentKey.

Returns:

Value of property parentKey.

getRssResultName

public String getRssResultName()

Getter for property rssResultName. If it is an (comma seperated) array return the first element.

Returns:

Value of property rssResultName.

getRssCommands

public String[] getRssCommands()

Getter for property rssResultName. Returns the whole array, indicated the list of commands to run.

Returns:

Value of property rssResultName.

getRssHidden

public boolean getRssHidden()

Deprecated. Not JavaBean compatable. Use isRssHidden() instead.

Returns true if there should be no visible links to the rss version of this tab.

Returns:

true if hidden.

isRssHidden

public boolean isRssHidden()

Returns true if there should be no visible links to the rss version of this tab.

Returns:

true if hidden.

getShowRss

public boolean getShowRss()

Deprecated. Not JavaBean compatable. Use isShowRss() instead.

Getter for property showRss

Returns:

isShowRss

public boolean isShowRss()

Getter for property showRss

Returns:

isExecuteOnBlank

public boolean isExecuteOnBlank()

Getter for property executeOnFront

Returns:

isDisplayCss

public boolean isDisplayCss()

Deprecated. css definitions belong against the layout.

Getter for property displayCss

Returns:

getEnrichmentPlacement

public SearchTab.EnrichmentPlacementHint getEnrichmentPlacement(String id)

getEnrichments

public Collection<SearchTab.EnrichmentHint> getEnrichments()

Getter for property enrichments.

Returns:

Value of property enrichments.

getEnrichmentByCommand

public SearchTab.EnrichmentHint getEnrichmentByCommand(String command)

Parameters:

command -

Returns:

getMode

public String getMode()

Getter for property mode.

Returns:

Value of property mode.

toString

public String toString()

Overrides:

toString in class Object

getAncestry

public List<SearchTab> getAncestry()

Returns:

getCss

public List<String> getCss()

Deprecated. css definitions belong against the layout.

Getter for property css.

Returns:

Value of property css.

getJavascript

public List<String> getJavascript()

Deprecated. javascript definitions belong against the layout.

Getter for property javascript.

Returns:

Value of property javascript.

getDefaultLayout

public SearchTab.Layout getDefaultLayout()

Getter for property defaultLayout.

Returns:

Value of property defaultLayout.

getLayouts

public Map<String,SearchTab.Layout> getLayouts()

getNavigationConfiguration

public NavigationConfig getNavigationConfiguration()

getScope

public SearchTab.Scope getScope()