Package com.webmethods.caf.faces.search.options

Class SimpleWebAppSearchResultsOptionsManager

java.lang.Object

com.webmethods.caf.faces.search.options.SimpleWebAppSearchResultsOptionsManager

All Implemented Interfaces:

ISearchResultsOptionsManager, Serializable

public class SimpleWebAppSearchResultsOptionsManager
extends Object
implements ISearchResultsOptionsManager, Serializable

A simple implementation of ISearchResultsOptionsManager that can be used in a standalone WebApp. (i.e. not a portlet app)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PAGE_SIZE_ENV_KEY	Name of web app environment variable which controls default page size for results portlet

Fields inherited from interface com.webmethods.caf.faces.search.options.ISearchResultsOptionsManager

KEY_COLUMN_DISPLAY, KEY_COLUMN_WIDTH, KEY_INITIAL_EXPORT_PAGE_SIZE, KEY_INITIAL_PAGE_SIZE, KEY_INITIAL_SORT_ASCENDING, KEY_INITIAL_SORT_BY

Constructor Summary

Constructors

Constructor	Description
SimpleWebAppSearchResultsOptionsManager()

Method Summary

Modifier and Type	Method	Description
String	getColumnWidthsPreference()	Return the column widths preference.
String[]	getDisplayColumnsPreference()	Return the display column preference.
int	getInitialExportPageSize()	Returns page size for export table
int	getInitialPageSize()	Returns page size for search results display
boolean	getInitialSortAscendingPreference()	Return the initialSortBy preference.
String	getInitialSortByPreference()	Return the initialSortBy preference.
protected static ServletContext	getServletContext()
protected static String	getStorageKey()
void	setColumnWidthsPreference(String columnWidths)	Sets the column widths preference.
void	setDisplayColumnsPreference(String[] columnDisplay)	Sets the display column preference.
void	setInitialExportPageSize(int pageSize)	Sets initialExportPageSize preference
void	setInitialPageSize(int pageSize)	Sets initialPageSize preference
void	setInitialSortAscendingPreference(boolean ascending)	Sets initialSortBy preference.
void	setInitialSortByPreference(String sortBy)	Sets initial sortBy preference

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PAGE_SIZE_ENV_KEY

public static final String DEFAULT_PAGE_SIZE_ENV_KEY

Name of web app environment variable which controls default page size for results portlet

See Also:

• Constant Field Values

Constructor Details

SimpleWebAppSearchResultsOptionsManager

public SimpleWebAppSearchResultsOptionsManager()

Method Details

getColumnWidthsPreference

public String getColumnWidthsPreference()

Description copied from interface: ISearchResultsOptionsManager

Return the column widths preference. Usually via a portlet property that is configured from the portlet edit mode.

Specified by:

getColumnWidthsPreference in interface ISearchResultsOptionsManager

Returns:

csv-style map of column ids to column widths (ie "colOne=60%,colTwo=40%,colThree=20px")

getDisplayColumnsPreference

public String[] getDisplayColumnsPreference()

Description copied from interface: ISearchResultsOptionsManager

Return the display column preference. Usually via a portlet property that is configured from the portlet edit mode.

Specified by:

getDisplayColumnsPreference in interface ISearchResultsOptionsManager

Returns:

array of column ids that should be displayed in the given order

getInitialSortAscendingPreference

public boolean getInitialSortAscendingPreference()

Description copied from interface: ISearchResultsOptionsManager

Return the initialSortBy preference. Usually via a portlet property that is configured from the portlet edit mode.

Specified by:

getInitialSortAscendingPreference in interface ISearchResultsOptionsManager

Returns:

id of the column to sort by initially

getInitialSortByPreference

public String getInitialSortByPreference()

Description copied from interface: ISearchResultsOptionsManager

Return the initialSortBy preference. Usually via a portlet property that is configured from the portlet edit mode.

Specified by:

getInitialSortByPreference in interface ISearchResultsOptionsManager

Returns:

id of the column to sort by initially

getInitialPageSize

public int getInitialPageSize()

Description copied from interface: ISearchResultsOptionsManager

Returns page size for search results display

Specified by:

getInitialPageSize in interface ISearchResultsOptionsManager

Returns:

the number of rows to display on each page of results

getInitialExportPageSize

public int getInitialExportPageSize()

Description copied from interface: ISearchResultsOptionsManager

Returns page size for export table

Specified by:

getInitialExportPageSize in interface ISearchResultsOptionsManager

Returns:

the number of rows to export

setInitialExportPageSize

public void setInitialExportPageSize(int pageSize)

Description copied from interface: ISearchResultsOptionsManager

Sets initialExportPageSize preference

Specified by:

setInitialExportPageSize in interface ISearchResultsOptionsManager

Parameters:

pageSize - the number of rows to export

setColumnWidthsPreference

public void setColumnWidthsPreference(String columnWidths)

Description copied from interface: ISearchResultsOptionsManager

Sets the column widths preference. Usually via a portlet property that is configured from the portlet edit mode. param csv-style map of column ids to column widths (ie "colOne=60%,colTwo=40%,colThree=20px")

Specified by:

setColumnWidthsPreference in interface ISearchResultsOptionsManager

setDisplayColumnsPreference

public void setDisplayColumnsPreference(String[] columnDisplay)

Description copied from interface: ISearchResultsOptionsManager

Sets the display column preference. Usually via a portlet property that is configured from the portlet edit mode. param array of column ids that should be displayed in the given order

Specified by:

setDisplayColumnsPreference in interface ISearchResultsOptionsManager

setInitialSortAscendingPreference

public void setInitialSortAscendingPreference(boolean ascending)

Description copied from interface: ISearchResultsOptionsManager

Sets initialSortBy preference.

Specified by:

setInitialSortAscendingPreference in interface ISearchResultsOptionsManager

Parameters:

ascending - true for ascending sort, false for descening sort

setInitialSortByPreference

public void setInitialSortByPreference(String sortBy)

Description copied from interface: ISearchResultsOptionsManager

Sets initial sortBy preference

Specified by:

setInitialSortByPreference in interface ISearchResultsOptionsManager

Parameters:

sortBy - the column id to sort by

setInitialPageSize

public void setInitialPageSize(int pageSize)

Description copied from interface: ISearchResultsOptionsManager

Sets initialPageSize preference

Specified by:

setInitialPageSize in interface ISearchResultsOptionsManager

Parameters:

pageSize - the number of rows to display on each page of results

getServletContext

protected static ServletContext getServletContext()

getStorageKey

protected static String getStorageKey()