Package com.logicaldoc.webservice.soap
Interface SearchService
- All Known Implementing Classes:
RestSearchService
,RestSearchSwagger
,SoapSearchClient
,SoapSearchService
public interface SearchService
Search Web Service definition interface
- Since:
- 5.2
- Author:
- Matteo Caruso - LogicalDOC
-
Method Summary
Modifier and TypeMethodDescriptionfind
(String sid, WSSearchOptions options) Performs a search by the search options.findByFilename
(String sid, String filename) Finds authorized documents for the current user the given filename (like operator is used)findFolders
(String sid, String name) Finds authorized folders for the current user containing the given name (like operator is used)
-
Method Details
-
find
WSSearchResult find(String sid, WSSearchOptions options) throws PersistenceException, AuthenticationException, WebserviceException, SearchException Performs a search by the search options.- Parameters:
sid
- identifier of the sessionoptions
- Search options- Returns:
- The search result
- Throws:
SearchException
- Eror in the searchPersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
findByFilename
List<WSDocument> findByFilename(String sid, String filename) throws AuthenticationException, WebserviceException, PersistenceException Finds authorized documents for the current user the given filename (like operator is used)- Parameters:
sid
- identifier of the sessionfilename
- Filename of the document- Returns:
- Collection of found documents
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
findFolders
List<WSFolder> findFolders(String sid, String name) throws AuthenticationException, WebserviceException, PersistenceException Finds authorized folders for the current user containing the given name (like operator is used)- Parameters:
sid
- identifier of the sessionname
- Name of the folder- Returns:
- Collection of found folders
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-