ogre.dms.service
Interface SearchService

All Superinterfaces:

Remote

public interface SearchService
extends Remote

Service that provides the document searching.

Author:

Docpedia team.

Method Summary

Vector	commitAttributeSearch(Vector columns, Vector values)
Vector	commitBasicSearch(SearchItem search)
Vector	commitBasicSearch(SearchItem search, String queryString)
Vector	commitBasicSearch(String searchField, String searchValue) comit basic search for document, folder and shortcut
Vector	commitBasicSearch(String searchField, String searchValue, String folder)
Vector	commitBasicSearch(Vector fields, Vector values) Search document with multiple parameters.
Vector	commitBasicSearch(Vector fields, Vector values, Vector statusList) commit basic search for fileds about date for documents, folders and shortcuts
Vector	commitBasicSearchForDate(String searchField, long startDate, long endDate)
Vector	commitBasicSearchLightForDocument(String searchType, Vector fields, Vector values, Vector StatusList, Vector dateQueryList, int numbers) commit basic search with specified parameters, however this method only returns a list of keys as search result to reduce load of DMS server and Web Server
Vector	commitBasicSearchLightForFolder(String searchType, Vector fields, Vector values, Vector StatusList, Vector dateQueryList, int numbers)
Vector	commitBasicSearchLightForShortcut(String searchType, Vector fields, Vector values, Vector StatusList, Vector dateQueryList, int numbers)
Vector	commitFullTextSearch(String userID, String queryString) commit full text search with openfind search engine through this method
Vector	commitFullTextSearch(String userID, String queryString, String folder)
Vector	commitSearchForADMGlobalView(String docType, String statusType, Vector orders)
int	getMaxSearchResult() The row count limitation for each searching.
boolean	isAlive()
List	search(String userID, String[] fields, String[] values) Search by the given fileds and the values

Method Detail

commitBasicSearch

Vector commitBasicSearch(Vector fields,
                         Vector values)
                         throws RemoteException

Search document with multiple parameters. These fields are used "AND" operator to search.

Parameters:

fields -

values -

Returns:

Throws:

RemoteException

commitBasicSearch

Vector commitBasicSearch(String searchField,
                         String searchValue)
                         throws RemoteException

comit basic search for document, folder and shortcut

Parameters:

searchField - - the field to search For Document: "DocumentName", "Status", "AuthorName", "Description", "Keywords" For Folder: "FolderName", "Status", "Description" For Shortcut: "ShortcutName", "OwnerName", "Description"

searchValue - - the value to search For Document Status: "Released", "Deleted", "Locked" For Folder, Shortcut Status: "Normal", "Deleted"

Returns:

a list of UnitItems

Throws:

RemoteException

commitBasicSearch

Vector commitBasicSearch(String searchField,
                         String searchValue,
                         String folder)
                         throws RemoteException

Throws:

RemoteException

commitBasicSearch

Vector commitBasicSearch(SearchItem search)
                         throws RemoteException

Throws:

RemoteException

commitBasicSearch

Vector commitBasicSearch(SearchItem search,
                         String queryString)
                         throws RemoteException

Throws:

RemoteException

commitBasicSearch

Vector commitBasicSearch(Vector fields,
                         Vector values,
                         Vector statusList)
                         throws RemoteException

commit basic search for fileds about date for documents, folders and shortcuts

Parameters:

searchField - - the field to search For document: LastUpdateDate, CreationDate, ExpiryDate For folder and shortcut: LastUpdateDate, CreationDate

Throws:

RemoteException

commitBasicSearchForDate

Vector commitBasicSearchForDate(String searchField,
                                long startDate,
                                long endDate)
                                throws RemoteException

Throws:

RemoteException

search

List search(String userID,
            String[] fields,
            String[] values)
            throws RemoteException

Search by the given fileds and the values

Parameters:

userID - who performing the query. It could be null.

fields - must mathc the name in VirtualDocumentInfo

values - paired with the fields

Returns:

List each element is VirtualDocumentInfo

Throws:

RemoteException

Since:

V3.0

commitFullTextSearch

Vector commitFullTextSearch(String userID,
                            String queryString)
                            throws RemoteException

commit full text search with openfind search engine through this method

Parameters:

queryString - the string used to query the physical documents

Returns:

a list of UnitItems

Throws:

RemoteException

commitFullTextSearch

Vector commitFullTextSearch(String userID,
                            String queryString,
                            String folder)
                            throws RemoteException

Throws:

RemoteException

isAlive

boolean isAlive()
                throws RemoteException

Throws:

RemoteException

commitBasicSearchLightForDocument

Vector commitBasicSearchLightForDocument(String searchType,
                                         Vector fields,
                                         Vector values,
                                         Vector StatusList,
                                         Vector dateQueryList,
                                         int numbers)
                                         throws RemoteException

commit basic search with specified parameters, however this method only returns a list of keys as search result to reduce load of DMS server and Web Server

Parameters:

searchType - clarify the fields and values are searched by "AND" or "OR"

fields - the target searching fields Name: VD, Folder, Shortcut Author: VD, Shortcut Description: VD, Folder, Shortcut Keyword: VD Category: VD

values - the searching values for each fields

statusList - the list of status of the target searching items

dateQueryList - list of DateQuery to clarify the date of the

number - number of return items (not implemented yet)

Returns:

a list of IDs (DocumentKey, ShortcutID, FolderID)

Throws:

RemoteException

commitBasicSearchLightForFolder

Vector commitBasicSearchLightForFolder(String searchType,
                                       Vector fields,
                                       Vector values,
                                       Vector StatusList,
                                       Vector dateQueryList,
                                       int numbers)
                                       throws RemoteException

Throws:

RemoteException

commitBasicSearchLightForShortcut

Vector commitBasicSearchLightForShortcut(String searchType,
                                         Vector fields,
                                         Vector values,
                                         Vector StatusList,
                                         Vector dateQueryList,
                                         int numbers)
                                         throws RemoteException

Throws:

RemoteException

commitSearchForADMGlobalView

Vector commitSearchForADMGlobalView(String docType,
                                    String statusType,
                                    Vector orders)
                                    throws RemoteException

Throws:

RemoteException

commitAttributeSearch

Vector commitAttributeSearch(Vector columns,
                             Vector values)
                             throws RemoteException

Throws:

RemoteException

getMaxSearchResult

int getMaxSearchResult()
                       throws RemoteException

The row count limitation for each searching.

Returns:

row count the default is 300.

Throws:

RemoteException

Since:

V2.2 HotFix_39