org.richfaces.photoalbum.ui.search

Class SearchOptionByShelf

java.lang.Object

org.richfaces.photoalbum.ui.search.ISearchOption

org.richfaces.photoalbum.ui.search.SearchOptionByShelf

public class SearchOptionByShelf
extends ISearchOption

Class, that encapsulate functionality related to search by shelf entity.

Author:

Andrey Markavtsov

Constructor Summary

Constructors

Constructor and Description
SearchOptionByShelf()

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Abstract method, that return name of particular search option.
String	getSearchResultName() Abstract method, that return description of particular search option.
String	getSearchResultTemplate() Abstract method, that return template to render of particular search option.
void	search(ISearchAction action, String searchQuery, boolean searchInMyAlbums, boolean searchInShared) Abstract method, that perform search in given option.

Methods inherited from class org.richfaces.photoalbum.ui.search.ISearchOption

getSearchResult, getSelected, setSearchResult, setSelected, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchOptionByShelf

public SearchOptionByShelf()

Method Detail

getName

public String getName()

Description copied from class: ISearchOption

Abstract method, that return name of particular search option. This name used in UI as header of r:tab. Must be implemented in sub-classes

Specified by:

getName in class ISearchOption

Returns:

name

getSearchResultName

public String getSearchResultName()

Description copied from class: ISearchOption

Abstract method, that return description of particular search option. This description used in UI as header of page with search result. Must be implemented in sub-classes

Specified by:

getSearchResultName in class ISearchOption

Returns:

description of search option

getSearchResultTemplate

public String getSearchResultTemplate()

Description copied from class: ISearchOption

Abstract method, that return template to render of particular search option. Must be implemented in sub-classes

Specified by:

getSearchResultTemplate in class ISearchOption

Returns:

template to render

search

public void search(ISearchAction action,
          String searchQuery,
          boolean searchInMyAlbums,
          boolean searchInShared)
            throws PhotoAlbumException

Description copied from class: ISearchOption

Abstract method, that perform search in given option. Must be implemented in sub-classes

Specified by:

search in class ISearchOption

Parameters:

action - - action will be performed

searchQuery - - query to search

searchInMyAlbums - - is search in users albums will be performed

searchInShared - - is search in shared albums will be performed

Throws:

PhotoAlbumException - - in case of wrong search parameters