Package com.logicaldoc.webservice.soap.client

Class SoapSearchClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<SearchService>

com.logicaldoc.webservice.soap.client.SoapSearchClient

All Implemented Interfaces:

SearchService

public class SoapSearchClient
extends SoapClient<SearchService>
implements SearchService

Search Web Service client.

Since:

7.5

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapSearchClient(String endpoint)
SoapSearchClient(String endpoint, int gzipThreshold, boolean log, int timeout)

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)

Methods inherited from class java.lang.Object

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

Constructor Details

SoapSearchClient

public SoapSearchClient(String endpoint,
 int gzipThreshold,
 boolean log,
 int timeout)

SoapSearchClient

public SoapSearchClient(String endpoint)

Method Details

find

public WSSearchResult find(String sid,
 WSSearchOptions options)
                    throws AuthenticationException,
PersistenceException,
WebserviceException,
SearchException

Description copied from interface: SearchService

Performs a search by the search options.

Specified by:

find in interface SearchService

Parameters:

sid - identifier of the session

options - Search options

Returns:

The search result

Throws:

AuthenticationException - Invalid session

PersistenceException - Error in the database

WebserviceException - Error in the webservice

SearchException - Eror in the search

findByFilename

public WSDocument[] findByFilename(String sid,
 String filename)
                            throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: SearchService

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

Specified by:

findByFilename in interface SearchService

Parameters:

sid - identifier of the session

filename - Filename of the document

Returns:

Collection of found documents

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

findFolders

public WSFolder[] findFolders(String sid,
 String name)
                       throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: SearchService

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

Specified by:

findFolders in interface SearchService

Parameters:

sid - identifier of the session

name - Name of the folder

Returns:

Collection of found folders

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database