Search

From LogicalDOC Community Wiki

Contents 1 WSSearchResult find(String sid, FulltextSearchOptions options) 2 WSDocument[] findByFilename(String sid, String filename) 3 WSDocument[] findByTag(String sid, String tag) 4 WSFolder[] findFolders(String sid, String name) 5 String[] getTags(String sid) 6 TagCloud[] getTagCloud(String sid)

Methods related to repository search.

WSSearchResult find(String sid, FulltextSearchOptions options)

This operation allows a user to retrieve all documents that are been found through the given query options.

Parameters

• sid - The session identifier.
• options - The query options.

Returns

• A WSSearchResult.

Throws

• Exception - If there is any error during the search operation.

WSDocument[] findByFilename(String sid, String filename)

This operation allows to retrieve all authorized documents having the given file name ('like' operator is used).

Parameters

• sid - The session identifier.
• filename – The file name.

Returns

• An array of WSDocument.

Throws

• Exception - If there is any error during the search operation.

WSDocument[] findByTag(String sid, String tag)

This operation allows to retrieve all authorized documents having the given tag.

Parameters

• sid - The session identifier.
• tag – The tag.

Returns

• An array of WSDocument.

Throws

• Exception - If there is any error during the search operation.

WSFolder[] findFolders(String sid, String name)

This operation allows to retrieve all authorized folders having the given file name ('like' operator is used).

Parameters

• sid - The session identifier.
• name – The folder name.

Returns

• An array of WSFolder.

Throws

• Exception - If there is any error during the search operation.

String[] getTags(String sid)

This operation allows to retrieve all tags into the repository.

Parameters

• sid - The session identifier.

Returns

• The collection of all tags on the repository.

Throws

• Exception - If there is any error during the search operation.

TagCloud[] getTagCloud(String sid)

This operation allows to retrieve all tag clouds into the repository.

Parameters

• sid - The session identifier.

Returns

• The collection of all tag clouds on the repository.

Throws

• Exception - If there is any error during the search operation.