Package com.logicaldoc.gui.frontend.client.services

Interface SearchService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

SearchServiceImpl

@RemoteServiceRelativePath("search")
public interface SearchService
extends com.google.gwt.user.client.rpc.RemoteService

Service responsible of Searches

Since:

6.0

Author:

Marco Meschieri - LogicalDOC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SearchService.Instance

Method Summary

Modifier and Type	Method	Description
void	delete(List<String> names)	Deletes a previously saved search
GUISearchOptions	load(String name)	Loads a saved search
void	save(GUISearchOptions options)	Saves the search options in the user's working dir
GUIResult	search(GUISearchOptions options)	Performs a search against the database
void	shareSearch(String name, List<Long> userIds, List<Long> groupIds)	Shares a search among a set of users and groups

Method Details

search

GUIResult search(GUISearchOptions options)
          throws ServerException

Performs a search against the database

Parameters:

options - The search options

Returns:

Result hits and statistics

Throws:

ServerException - error in the server application

save

void save(GUISearchOptions options)
   throws ServerException

Saves the search options in the user's working dir

Parameters:

options - The search options

Throws:

ServerException - error in the server application

shareSearch

void shareSearch(String name,
 List<Long> userIds,
 List<Long> groupIds)
          throws ServerException

Shares a search among a set of users and groups

Parameters:

name - the name of the search

userIds - direct ids of users to share the search to

groupIds - the groups of users to share the search to

Throws:

ServerException - share the search to

delete

void delete(List<String> names)
     throws ServerException

Deletes a previously saved search

Parameters:

names - The saved search names

Throws:

ServerException - error in the server application

load

GUISearchOptions load(String name)
               throws ServerException

Loads a saved search

Parameters:

name - The saved search name

Returns:

the options

Throws:

ServerException - error in the server application