com.sap.workspaces.directory

Class SearchFilter

java.lang.Object
  extended by com.sap.workspaces.directory.SearchFilter

public final class SearchFilter
extends Object

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


Constructor Summary
SearchFilter()
           
 
Method Summary
 String getDescription()
          Returns the workspace description to search for
 Locale getLocale()
          Returns the search language according to the user's locale
 String getName()
          Returns the workspace name to search for
 String getOwner()
          Returns the workspace owner to search for
 String[] getOwners()
          Returns the list of login names of the workspace owners
 SearchMethod getSearchMethod()
          Returns the search method
 void setDescription(String description)
          Defines the workspace description to search for
 void setLocale(Locale locale)
          Defines the search language according to the user's locale
 void setName(String name)
          Defines the workspace name to search for
 void setOwner(String owner)
          Defines the workspace owner to search for
 void setOwners(String[] owners)
          Defines the list of login names of the workspace owners
 void setSearchMethod(SearchMethod searchMethod)
          Defines the search method, either SearchMethod.AND (default) or SearchMethod.OR
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SearchFilter

public SearchFilter()
Method Detail

getLocale

public Locale getLocale()
Returns the search language according to the user's locale

Returns:
the search language according to the user's locale

setLocale

public void setLocale(Locale locale)
Defines the search language according to the user's locale

Parameters:
locale - the locale of the current user

getName

public String getName()
Returns the workspace name to search for

Returns:
the workspace name to search for

setName

public void setName(String name)
Defines the workspace name to search for

Parameters:
name - workspace name. Can include asterisks. By default, an asterisk is automatically added at the beginning and the end

getDescription

public String getDescription()
Returns the workspace description to search for

Returns:
the workspace description to search for

setDescription

public void setDescription(String description)
Defines the workspace description to search for

Parameters:
description - the workspace description. Can include asterisks. By default, an asterisk is automatically added at the beginning and the end

getOwner

public String getOwner()
Returns the workspace owner to search for

Returns:
the workspace owner to search for

setOwner

public void setOwner(String owner)
Defines the workspace owner to search for

Parameters:
owner - workspace owner name. Can include asterisks. By default, an asterisk is automatically added at the beginning and the end

getOwners

public String[] getOwners()
Returns the list of login names of the workspace owners

Returns:
the list of login names of the workspace owners

setOwners

public void setOwners(String[] owners)
Defines the list of login names of the workspace owners

Parameters:
owners - the list of login names of the workspace owners

getSearchMethod

public SearchMethod getSearchMethod()
Returns the search method

Returns:
the search method

setSearchMethod

public void setSearchMethod(SearchMethod searchMethod)
Defines the search method, either SearchMethod.AND (default) or SearchMethod.OR

Parameters:
searchMethod - the search method

toString

public String toString()
Overrides:
toString in class Object


Copyright 2010 SAP AG Complete Copyright Notice