Package com.logicaldoc.webservice.soap.endpoint

Class SoapSearchService

java.lang.Object

com.logicaldoc.webservice.AbstractService

com.logicaldoc.webservice.soap.endpoint.SoapSearchService

All Implemented Interfaces:

SearchService

Direct Known Subclasses:

RestSearchService

public class SoapSearchService
extends AbstractService
implements SearchService

Search Web Service Implementation

Since:

5.2

Author:

Matteo Caruso - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapSearchService()

Method Summary

Modifier and Type	Method	Description
WSSearchResult	find(String sid, WSSearchOptions opt)	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 com.logicaldoc.webservice.AbstractService

convertDateToString, convertStringToDate, getCurrentMessage, isValidateSession, setCurrentMessage, setValidateSession

Methods inherited from class java.lang.Object

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

Constructor Details

SoapSearchService

public SoapSearchService()

Method Details

find

public WSSearchResult find(String sid,
 WSSearchOptions opt)
                    throws PersistenceException,
AuthenticationException,
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

opt - Search options

Returns:

The search result

Throws:

PersistenceException - Error in the database

AuthenticationException - Invalid session

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