jet.server.api.rmi

Interface RemoteSearchHelper

All Superinterfaces:

java.rmi.Remote

public interface RemoteSearchHelper
extends java.rmi.Remote

The node set is present the object which present the nodes in the specified path, and the nodes can be accessed by the specified user. In search condition, the nodes are searched by the specified key word and case sensitive. From the NodeSet object, user can get the total number of the nodes, can sort the sub-nodes according to the specified column and sort direction, or can get the sub-nodes page by page.

Method Summary

Modifier and Type	Method and Description
int	getId() Gets the id of NodeSet object.
java.util.Vector<PathInfo>	getPage(int rowsPerPage, int pageIndex) Gets the sub-nodes by page.
int	getTotalNode() Gets the total number of sub-nodes.
boolean	isSearching() Gets whether the SearchHelper object is searching.
RemoteSearchHelper	search(java.lang.String path, boolean isSearch, java.lang.String keyword, boolean caseSensitive, boolean matchWhole) Search/Get the sub-nodes contained in the specified path.
RemoteSearchHelper	setFilterCatalog(boolean isFilterCatalog) Sets whether filter catalog
RemoteSearchHelper	setLocale(java.util.Locale locale) Sets the locale which used in front-ground UI.
RemoteSearchHelper	setMyFoldersUser(java.lang.String userid) When perform search(String, boolean, String, boolean, boolean) method, if parameter path is empty, we may return my folder (My Components, My Reports) nodes of other user instead of user set by setUserId(String).
RemoteSearchHelper	setUserId(java.lang.String userId) Sets the user represent the user who operates in front-ground UI.
RemoteSearchHelper	sort(java.lang.String sortColumn, boolean isAsc, boolean isFolderFirst) Sort the sub-nodes according to the specified column and sort direction.

Method Detail

getId

int getId()
   throws java.rmi.RemoteException

Gets the id of NodeSet object.

Returns:

the id of NodeSet object.

Throws:

java.rmi.RemoteException - if communication-related error occurs during RMI call execution.

getTotalNode

int getTotalNode()
          throws java.rmi.RemoteException

Gets the total number of sub-nodes.

Returns:

The total number of sub-nodes when the all sub-nodes are accessed, otherwise return -1 indicates the access process have not finished yet.

Throws:

java.rmi.RemoteException - if communication-related error occurs during RMI call execution.

sort

RemoteSearchHelper sort(java.lang.String sortColumn,
                        boolean isAsc,
                        boolean isFolderFirst)
                 throws java.rmi.RemoteException

Sort the sub-nodes according to the specified column and sort direction.

Parameters:

sortColumn - The sort column name, APIConst.COLUMN_NAME_REPORTS_NAME, APIConst.COLUMN_NAME_REPORTS_TYPE, APIConst.COLUMN_NAME_REPORTS_DESCRIPTION, APIConst.COLUMN_NAME_REPORTS_STATUS, APIConst.COLUMN_NAME_REPORTS_LAST_MODIFIED

isAsc - The sort direction, true: ascending, false: descending

isFolderFirst - Indicates whether the folder was first when sort.

Throws:

java.rmi.RemoteException - if communication-related error occurs during RMI call execution.

getPage

java.util.Vector<PathInfo> getPage(int rowsPerPage,
                                   int pageIndex)
                            throws java.rmi.RemoteException

Gets the sub-nodes by page.

Parameters:

rowsPerPage - The rows number per page.

pageIndex - The page index.

Returns:

A vector, which contains sub-nodes.

Throws:

java.rmi.RemoteException - if communication-related error occurs during RMI call execution.

setUserId

RemoteSearchHelper setUserId(java.lang.String userId)
                      throws java.rmi.RemoteException

Sets the user represent the user who operates in front-ground UI.

Parameters:

userId -

Returns:

the SearchHelper object.

Throws:

java.rmi.RemoteException - if communication-related error occurs during RMI call execution.

setLocale

RemoteSearchHelper setLocale(java.util.Locale locale)
                      throws java.rmi.RemoteException

Sets the locale which used in front-ground UI.

Parameters:

locale -

Returns:

the SearchHelper object.

Throws:

java.rmi.RemoteException - if communication-related error occurs during RMI call execution.

setFilterCatalog

RemoteSearchHelper setFilterCatalog(boolean isFilterCatalog)
                             throws java.rmi.RemoteException

Sets whether filter catalog

Parameters:

isFilterCatalog -

Returns:

the SearchHelper object.

Throws:

java.rmi.RemoteException - if communication-related error occurs during RMI call execution.

search

RemoteSearchHelper search(java.lang.String path,
                          boolean isSearch,
                          java.lang.String keyword,
                          boolean caseSensitive,
                          boolean matchWhole)
                   throws java.rmi.RemoteException

Search/Get the sub-nodes contained in the specified path. When the isSearch is false, the keyword, caseSensitive and matchWhole are ignored.

Parameters:

path - The specified path to search/get.

isSearch - Indicates whether is search operation.

keyword - The search keyword.

caseSensitive - Indicates whether is case sensitive.

matchWhole - Indicates whether match whole keyword.

Returns:

the RemoteSearchHelper object itself

Throws:

java.rmi.RemoteException

setMyFoldersUser

RemoteSearchHelper setMyFoldersUser(java.lang.String userid)
                             throws java.rmi.RemoteException

When perform search(String, boolean, String, boolean, boolean) method, if parameter path is empty, we may return my folder (My Components, My Reports) nodes of other user instead of user set by setUserId(String). This method is used to set such user, which is different with user set by setUserId(String). Only when value of server.security.expose_my_folders in /bin/server.properties is true, and parmeter path of method search(String, boolean, String, boolean, boolean) is empty, SearchHelper will load sub-nodes under my folders of this user.

Parameters:

userid - the user id, who is different with SearchHelper operator.

Returns:

the RemoteSearchHelper object itself

Throws:

java.rmi.RemoteException - if communication-related error occurs during RMI call execution.

isSearching

boolean isSearching()
             throws java.rmi.RemoteException

Gets whether the SearchHelper object is searching.

Returns:

true if the SearchHelper object is searching, otherwise false.

Throws:

java.rmi.RemoteException - if communication-related error occurs during RMI call execution.