com.sap.workspaces.directory

Class SearchControl

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

public final class SearchControl
extends Object

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

Field Summary

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

Constructor Summary

SearchControl()

Method Summary

WorkspaceInfo[]	getExcludedWorkspaces() Returns the workspaces to be excluded from the search
int	getMaxResults() Returns the maximum number of workspaces to return as search results
PermissionPolicy[]	getPermissionPolicies() Returns workspace permission policies, such as public or restricted, to include in the search,
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
Status[]	getStatuses() Returns an array of workspace statuses to include in the search, such as published, draft, closed or pending
Type[]	getTypes() Returns an array of workspace types to include in the search, such as shared or personal
void	setExcludedWorkspaces(WorkspaceInfo[] excludedWorkspaces) Defines workspaces to be excluded from the search
void	setMaxResults(int maxResults) Defines the maximum number of workspaces to return as search results
void	setPermissionPolicies(PermissionPolicy[] permissionPolicies) Defines which workspace permission policies to include in the search
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
void	setStatuses(Status[] statuses) Defines which workspace statuses to include in the search, such as published, draft, closed or pending
void	setTypes(Type[] types) Defines which workspace types to include in the search, such as shared or personal
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

Max value of max search results

See Also:

Constant Field Values

Constructor Detail

SearchControl

public SearchControl()

Method Detail

getPermissionPolicies

public PermissionPolicy[] getPermissionPolicies()

Returns workspace permission policies, such as public or restricted, to include in the search,

Returns:

An array of workspace permission policies to include in the search,

setPermissionPolicies

public void setPermissionPolicies(PermissionPolicy[] permissionPolicies)

Defines which workspace permission policies to include in the search

Parameters:

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

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()

Returns the maximum number of workspaces to return as search results

Returns:

The maximum number of workspaces to return as search results

setMaxResults

public void setMaxResults(int maxResults)

Defines the maximum number of workspaces to return as search results

Parameters:

maxResults - the maximum number of workspaces to return

getExcludedWorkspaces

public WorkspaceInfo[] getExcludedWorkspaces()

Returns the workspaces to be excluded from the search

Returns:

An array of workspaces to exclude from the search

setExcludedWorkspaces

public void setExcludedWorkspaces(WorkspaceInfo[] excludedWorkspaces)

Defines workspaces to be excluded from the search

Parameters:

excludedWorkspaces - an array of workspaces to be excluded from the search

getStatuses

public Status[] getStatuses()

Returns an array of workspace statuses to include in the search, such as published, draft, closed or pending

Returns:

An array of workspace statuses to include in the search, such as Status.PUBLISHED, Status.DRAFT, Status.CLOSED or Status.PENDING

setStatuses

public void setStatuses(Status[] statuses)

Defines which workspace statuses to include in the search, such as published, draft, closed or pending

Parameters:

statuses - An array of workspace statuses to include in the search, such as Status.PUBLISHED, Status.DRAFT, Status.CLOSED or Status.PENDING

getTypes

public Type[] getTypes()

Returns an array of workspace types to include in the search, such as shared or personal

Returns:

An array of workspace types to include in the search, such as as Type.SHARED or Type.PERSONAL

setTypes

public void setTypes(Type[] types)

Defines which workspace types to include in the search, such as shared or personal

Parameters:

types - an array of workspace types to include in the search, such as Type.SHARED or Type.PERSONAL.

toString

public String toString()

Overrides:

toString in class Object