com.logicaldoc.webservice.search

Interface SearchService

All Known Implementing Classes:

SearchClient, SearchServiceImpl

public interface SearchService

Search Web Service definition interface

Since:

5.2

Author:

Matteo Caruso - Logical Objects

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.

Method Detail

find

WSSearchResult find(String sid,
                  WSSearchOptions options)
                    throws Exception

Performs a search by the search options.

Parameters:

sid - Session Identifier

options - Search options

Returns:

The search result

Throws:

Exception

getTags

String[] getTags(String sid)
                 throws Exception

Retrieves all tags in the repository.

Parameters:

sid - Session Identifier

Returns:

The tags in the repository

Throws:

Exception

getTagCloud

WSTagCloud[] getTagCloud(String sid)
                         throws Exception

Retrieves all tag clouds in the repository.

Parameters:

sid - Session Identifier

Returns:

The tags in the repository

Throws:

Exception

findByTag

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

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

Parameters:

tag - Tag of the document

Returns:

Collection of found folders.

Throws:

Exception

findByFilename

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

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

Parameters:

filename - Filename of the document

Returns:

Collection of found documents.

Throws:

Exception

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:

name - Name of the folder

Returns:

Collection of found folders.

Throws:

Exception