org.richfaces.photoalbum.search

Class ISearchOption

java.lang.Object

org.richfaces.photoalbum.search.ISearchOption

Direct Known Subclasses:

SearchOptionByAlbum, SearchOptionByImage, SearchOptionByShelf, SearchOptionByTag, SearchOptionByUser

public abstract class ISearchOption
extends Object

Abstract class, that represent base functionality for particular search option(album, shelf, etc..)

Author:

Andrey Markavtsov

Constructor Summary

Constructors

Constructor and Description
ISearchOption()

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	getName() Abstract method, that return name of particular search option.
List<?>	getSearchResult()
abstract String	getSearchResultName() Abstract method, that return description of particular search option.
abstract String	getSearchResultTemplate() Abstract method, that return template to render of particular search option.
boolean	getSelected()
abstract void	search(ISearchAction action, String searchQuery, boolean searchInMyAlbums, boolean searchInShared) Abstract method, that perform search in given option.
void	setSearchResult(List<?> searchResult)
void	setSelected(boolean selected)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ISearchOption

public ISearchOption()

Method Detail

getName

public abstract String getName()

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

Returns:

name

getSearchResultName

public abstract String getSearchResultName()

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

Returns:

description of search option

search

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

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

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

getSelected

public boolean getSelected()

setSelected

public void setSelected(boolean selected)

toString

public String toString()

Overrides:

toString in class Object

getSearchResultTemplate

public abstract String getSearchResultTemplate()

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

Returns:

template to render

getSearchResult

public List<?> getSearchResult()

setSearchResult

public void setSearchResult(List<?> searchResult)