Package com.logicaldoc.webservice.rest

Interface SearchService

All Known Implementing Classes:

RestSearchService, RestSearchSwagger

@Consumes("application/json")
@Produces("application/json")
public interface SearchService

Method Summary

Modifier and Type	Method	Description
WSSearchResult	find(WSSearchOptions opt)
List<WSDocument>	findByFilename(String filename)	Finds authorized documents for the current user the given filename (like operator is used)
List<WSFolder>	findFolders(String name)	Finds authorized folders for the current user containing the given name (like operator is used)

Method Details

find

@POST
@Path("/find")
WSSearchResult find(WSSearchOptions opt)
             throws AuthenticationException,
PersistenceException,
WebserviceException,
SearchException

Throws:

AuthenticationException

PersistenceException

WebserviceException

SearchException

findByFilename

@GET
@Path("/findByFilename")
List<WSDocument> findByFilename(String filename)
                         throws AuthenticationException,
WebserviceException,
PersistenceException

Finds authorized documents for the current user the given filename (like operator is used)

Parameters:

filename - Filename of the document

Returns:

Collection of found documents

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

findFolders

@GET
@Path("/findFolders")
List<WSFolder> findFolders(String name)
                    throws AuthenticationException,
WebserviceException,
PersistenceException

Finds authorized folders for the current user containing the given name (like operator is used)

Parameters:

name - Name of the folder

Returns:

Collection of found folders

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session