com.logicaldoc.webservice.search

Class SearchClient

java.lang.Object

com.logicaldoc.webservice.AbstractClient<SearchService>

com.logicaldoc.webservice.search.SearchClient

All Implemented Interfaces:

SearchService

public class SearchClient
extends AbstractClient<SearchService>
implements SearchService

Search Web Service client.

Since:

5.2

Author:

Matteo Caruso - Logical Objects

Field Summary

Fields inherited from class com.logicaldoc.webservice.AbstractClient

client, endpoint

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and 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).
WSDocument[]	findByTag(String sid, String tag) Finds authorized documents for the current user having a specified tag.
WSFolder[]	findFolders(String sid, String name) Finds authorized folders for the current user containing the given name (like operator is used).
WSTagCloud[]	getTagCloud(String sid) Retrieves all tag clouds in the repository.
String[]	getTags(String sid) Retrieves all tags in the repository.

Methods inherited from class com.logicaldoc.webservice.AbstractClient

configureSSL, configureTimeout, initClient

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchClient

public SearchClient(String endpoint,
            int gzipThreshold,
            boolean log,
            int timeout)
             throws IOException

Throws:

IOException

SearchClient

public SearchClient(String endpoint)
             throws IOException

Throws:

IOException

Method Detail

find

public WSSearchResult find(String sid,
                  WSSearchOptions options)
                    throws Exception

Description copied from interface: SearchService

Performs a search by the search options.

Specified by:

find in interface SearchService

Parameters:

sid - Session Identifier

options - Search options

Returns:

The search result

Throws:

Exception

findByFilename

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

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

filename - Filename of the document

Returns:

Collection of found documents.

Throws:

Exception

findByTag

public WSDocument[] findByTag(String sid,
                     String tag)
                       throws Exception

Description copied from interface: SearchService

Finds authorized documents for the current user having a specified tag.

Specified by:

findByTag in interface SearchService

tag - Tag of the document

Returns:

Collection of found folders.

Throws:

Exception

findFolders

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

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

name - Name of the folder

Returns:

Collection of found folders.

Throws:

Exception

getTagCloud

public WSTagCloud[] getTagCloud(String sid)
                         throws Exception

Description copied from interface: SearchService

Retrieves all tag clouds in the repository.

Specified by:

getTagCloud in interface SearchService

Parameters:

sid - Session Identifier

Returns:

The tags in the repository

Throws:

Exception

getTags

public String[] getTags(String sid)
                 throws Exception

Description copied from interface: SearchService

Retrieves all tags in the repository.

Specified by:

getTags in interface SearchService

Parameters:

sid - Session Identifier

Returns:

The tags in the repository

Throws:

Exception