org.richfaces.photoalbum.search
Class SearchAction

java.lang.Object
  org.richfaces.photoalbum.search.SearchAction

All Implemented Interfaces:

ISearchAction

public class SearchAction
extends Object
implements ISearchAction

This class is entry point to retrieve search result EJB3 Bean

Author:

Andrey Markhel

Constructor Summary

SearchAction()

Method Summary

List<Album>	searchByAlbum(String searchQuery, boolean searchInMyAlbums, boolean searchInShared) Return List of albums, founded by query Search albums by name and description(like)
List<Image>	searchByImage(String searchQuery, boolean searchInMyAlbums, boolean searchInShared) Return List of images, founded by query Search images by name and description(like)
List<Shelf>	searchByShelves(String searchQuery, boolean searchInMyAlbums, boolean searchInShared) Return List of shelves, founded by query Search images by name and description(like)
List<MetaTag>	searchByTags(String searchQuery, boolean searchInMyAlbums, boolean searchInShared) Return List of metatags, founded by query Search users by tagname(like)
List<User>	searchByUsers(String searchQuery, boolean searchInMyAlbums, boolean searchInShared) Return List of users, founded by query Search users by login, firstname and secondname(like)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchAction

public SearchAction()

Method Detail

searchByAlbum

public List<Album> searchByAlbum(String searchQuery,
                                 boolean searchInMyAlbums,
                                 boolean searchInShared)
                          throws PhotoAlbumException

Return List of albums, founded by query Search albums by name and description(like)

Specified by:

searchByAlbum in interface ISearchAction

Parameters:

searchQuery - - string to search

searchInMyAlbums - - determine is search will be making by only user's albums

searchInShared - - determine is search will be making in only shared albums

Returns:

list of founded albums

Throws:

PhotoAlbumException - if search parameter is wrong

searchByImage

public List<Image> searchByImage(String searchQuery,
                                 boolean searchInMyAlbums,
                                 boolean searchInShared)
                          throws PhotoAlbumException

Return List of images, founded by query Search images by name and description(like)

Specified by:

searchByImage in interface ISearchAction

Parameters:

searchQuery - - string to search

searchInMyAlbums - - determine is search will be making by only user's images

searchInShared - - determine is search will be making in only shared images

Returns:

list of founded images

Throws:

PhotoAlbumException - if search parameter is wrong

searchByUsers

public List<User> searchByUsers(String searchQuery,
                                boolean searchInMyAlbums,
                                boolean searchInShared)
                         throws PhotoAlbumException

Return List of users, founded by query Search users by login, firstname and secondname(like)

Specified by:

searchByUsers in interface ISearchAction

Parameters:

searchQuery - - string to search

searchInMyAlbums - - unused

searchInShared - - unused

Returns:

list of founded users

Throws:

PhotoAlbumException - if search parameter is wrong

searchByTags

public List<MetaTag> searchByTags(String searchQuery,
                                  boolean searchInMyAlbums,
                                  boolean searchInShared)
                           throws PhotoAlbumException

Return List of metatags, founded by query Search users by tagname(like)

Specified by:

searchByTags in interface ISearchAction

Parameters:

searchQuery - - string to search

searchInMyAlbums - - unused

searchInShared - - unused

Returns:

list of founded metatags

Throws:

PhotoAlbumException - if search parameter is wrong

searchByShelves

public List<Shelf> searchByShelves(String searchQuery,
                                   boolean searchInMyAlbums,
                                   boolean searchInShared)
                            throws PhotoAlbumException

Return List of shelves, founded by query Search images by name and description(like)

Specified by:

searchByShelves in interface ISearchAction

Parameters:

searchQuery - - string to search

searchInMyAlbums - - determine is search will be making by only user's shelves

searchInShared - - determine is search will be making in only shared shelves

Returns:

list of founded images

Throws:

PhotoAlbumException - if search parameter is wrong