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 Type	Method	Description
WSSearchResult	find(String sid, WSSearchOptions options)	Performs a search by the search options.
WSDocument[]	findByFilename(String sid, String filename)	Finds authorized documents for the current user the given filename (like operator is used)
WSFolder[]	findFolders(String sid, String name)	Finds authorized folders for the current user containing the given name (like operator is used)

Method Detail

find

WSSearchResult find(String sid,
                    WSSearchOptions options)
             throws Exception

Performs a search by the search options.

Parameters:

sid - identifier of the session

options - Search options

Returns:

The search result

Throws:

Exception - error in the server application

findByFilename

WSDocument[] findByFilename(String sid,
                            String filename)
                     throws Exception

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

Parameters:

sid - identifier of the session

filename - Filename of the document

Returns:

Collection of found documents

Throws:

Exception - error in the server application

findFolders

WSFolder[] findFolders(String sid,
                       String name)
                throws Exception

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

Parameters:

sid - identifier of the session

name - Name of the folder

Returns:

Collection of found folders

Throws:

Exception - error in the server application