com.sap.workspaces.directory

Class SearchControl

java.lang.Object
  com.sap.workspaces.directory.SearchControl

public final class SearchControl
extends Object

Defines search conditions of the IWorkspaceDirectory.search(SearchControl) method.

Field Summary

static int	DEFAULT_MAX_RESULTS Default value of max search results
static int	MAX_RESULTS Maximal value of max search results

Constructor Summary

SearchControl()

Method Summary

WorkspaceInfo[]	getExcludedWorkspaces() Returns the workspaces that should be excluded from the search results.
int	getMaxResults() Retrieves the maximum number of workspaces to return as a result of the search.
PermissionPolicy[]	getPermissionPolicies() Returns an array of workspace permission policies to include in the search, such as public or restricted.
SearchFilter	getSearchFilter() Returns a SearchFilter object that defines additional search parameters.
SortBy	getSortBy() Returns the sort order of the search results.
int	getStartFrom() Returns the sequential number of the search result from which to start returning results.
void	setExcludedWorkspaces(WorkspaceInfo[] excludedWorkspaces) Defines the workspaces that should be excluded from the search results.
void	setMaxResults(int maxResults) Defines the maximum number of workspaces to return as a result of the search.
void	setPermissionPolicies(PermissionPolicy[] permissionPolicies) Defines which workspace permission policies to include in the search, such as PermissionPolicy.PUBLIC or PermissionPolicy.RESTRICTED.
void	setSearchFilter(SearchFilter searchFilter) Sets a SearchFilter object that defines additional search parameters.
void	setSortBy(SortBy sortBy) Defines the sort order of the search results.
void	setStartFrom(int startFrom) Defines the sequential number of the search result from which to start returning results.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_RESULTS

public static final int DEFAULT_MAX_RESULTS

Default value of max search results

See Also:

Constant Field Values

MAX_RESULTS

public static final int MAX_RESULTS

Maximal value of max search results

See Also:

Constant Field Values

Constructor Detail

SearchControl

public SearchControl()

Method Detail

getPermissionPolicies

public PermissionPolicy[] getPermissionPolicies()

Returns an array of workspace permission policies to include in the search, such as public or restricted.

Returns:

An array of workspace permission policies to include in the search, such as public or restricted.

setPermissionPolicies

public void setPermissionPolicies(PermissionPolicy[] permissionPolicies)

Defines which workspace permission policies to include in the search, such as PermissionPolicy.PUBLIC or PermissionPolicy.RESTRICTED.

Parameters:

permissionPolicies - - permission policies to include in the search, such as PermissionPolicy.PUBLIC or PermissionPolicy.RESTRICTED.

getSortBy

public SortBy getSortBy()

Returns the sort order of the search results.

Returns:

The sort order of the search results.

setSortBy

public void setSortBy(SortBy sortBy)

Defines the sort order of the search results.

Parameters:

sortBy - - The sort order of the search results.

getSearchFilter

public SearchFilter getSearchFilter()

Returns a SearchFilter object that defines additional search parameters.

Returns:

A SearchFilter object that defines additional search parameters.

setSearchFilter

public void setSearchFilter(SearchFilter searchFilter)

Sets a SearchFilter object that defines additional search parameters.

Parameters:

searchFilter - - SearchFilter object that defines additional search parameters.

getStartFrom

public int getStartFrom()

Returns the sequential number of the search result from which to start returning results.

Returns:

The sequential number of the search result from which to start returning results.

setStartFrom

public void setStartFrom(int startFrom)

Defines the sequential number of the search result from which to start returning results.

Parameters:

startFrom - - start number

getMaxResults

public int getMaxResults()

Retrieves the maximum number of workspaces to return as a result of the search.

Returns:

The maximum number of workspaces to return as a result of the search.

setMaxResults

public void setMaxResults(int maxResults)

Defines the maximum number of workspaces to return as a result of the search.

Parameters:

maxResults - The maximum number of workspaces that will be returned.

getExcludedWorkspaces

public WorkspaceInfo[] getExcludedWorkspaces()

Returns the workspaces that should be excluded from the search results.

Returns:

The workspaces that should be excluded from the search results.

setExcludedWorkspaces

public void setExcludedWorkspaces(WorkspaceInfo[] excludedWorkspaces)

Defines the workspaces that should be excluded from the search results.

Parameters:

excludedWorkspaces - - workspaces to be excluded from the search results

toString

public String toString()

Overrides:

toString in class Object