oracle.dss.bicontext
Class BISearchControls

java.lang.Object
  |
  +--javax.naming.directory.SearchControls
        |
        +--oracle.dss.bicontext.BISearchControls

All Implemented Interfaces:

java.io.Serializable

public class BISearchControls

extends javax.naming.directory.SearchControls

Encapsulates factors that control the behavior of a search. This class allows you to specify:

• The scope of the search
• What the search returns in the search results
• The maximum size of the search result set
• The time limit for the search
• Whether to include a subfolder as the returned result
• Whether the search should be case-sensitive
• The sorting criteria
• Custom filter for limiting the search results

See Also:

Serialized Form

Field Summary

static int	DATE Compare the time to date precision.
static int	HOUR Compare the time to hours precision.
static int	MINUTE Compare the time to minutes precision.
static int	ONELEVEL_SCOPE_WITH_FOLDERS Find the objects in the named folder that contain objects that meet the search criteria, as well as all of the subfolders of the named folder.
static int	SECOND Compare the time to seconds precision.
static int	SELECTIVE_ONELEVEL_SCOPE Find the subfolders of the named folder that contain objects that meet the search criteria, as well as objects in the named folder that meet the search criteria.

Fields inherited from class javax.naming.directory.SearchControls

OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE

Constructor Summary

BISearchControls()

Method Summary

BIFilter	getResultFilter() Retrieves the search result filter that is used after the search is finished.
BIComparator	getSortingComparator() Returns a comparator that's used for comparing BISearchResult elements during sorting
int	getTimePrecision() Retrieves the precision that the search uses in comparing time values.
boolean	isCaseSensitive() Retrieves the caseSensitive setting that the search uses in comparing String values.
boolean	isSortingOn() Queries BISearchControls to find out whether the sorting option is turned on.
void	setCaseSensitive(boolean caseSensitive) Specifies where the search on attribute values is case sensitive.
void	setResultFilter(BIFilter filter) Specifies the search result filter to use after the search is finished.
void	setSortingComparator(BIComparator comp) Sets a comparator that's used for comparing BISearchResult elements during sorting
void	setSortingOn(boolean flag) Turns sorting behaviour on or off.
void	setTimePrecision(int precision) Specifies the precision to use when the search compares time values.

Methods inherited from class javax.naming.directory.SearchControls

getCountLimit, getDerefLinkFlag, getReturningAttributes, getReturningObjFlag, getSearchScope, getTimeLimit, setCountLimit, setDerefLinkFlag, setReturningAttributes, setReturningObjFlag, setSearchScope, setTimeLimit

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SELECTIVE_ONELEVEL_SCOPE

public static final int SELECTIVE_ONELEVEL_SCOPE

Find the subfolders of the named folder that contain objects that meet the search criteria, as well as objects in the named folder that meet the search criteria. Besides the objects that meet the search criteria in the named context, the SearchResults will contain subfolders in which objects that meet the search criteria are found.

ONELEVEL_SCOPE_WITH_FOLDERS

public static final int ONELEVEL_SCOPE_WITH_FOLDERS

Find the objects in the named folder that contain objects that meet the search criteria, as well as all of the subfolders of the named folder. This scope differs from SELECTIVE_ONE_LEVEL_SCOPE in that, with this scope, all subfolders are included in the results. With SELECTIVE_ONELEVEL_SCOPE, only the subfolders that contain searched-for objects are included in the results.

See Also:

SELECTIVE_ONELEVEL_SCOPE

DATE

public static final int DATE

Compare the time to date precision.

HOUR

public static final int HOUR

Compare the time to hours precision.

MINUTE

public static final int MINUTE

Compare the time to minutes precision.

SECOND

public static final int SECOND

Compare the time to seconds precision.

Constructor Detail

BISearchControls

public BISearchControls()

Method Detail

setTimePrecision

public void setTimePrecision(int precision)

Specifies the precision to use when the search compares time values. For example, if you are searching by the TIME_DATE_MODIFIED attribute, then this method specifies whether you want to find objects that were modified on a particular day, or at a particular hour, or at a particular minute, or at a particular second.

Parameters:

precision - A constant that represents the precision to use when the search is performed. Valid values are listed in the See Also section.

See Also:

DATE, HOUR, MINUTE, SECOND

getTimePrecision

public int getTimePrecision()

Retrieves the precision that the search uses in comparing time values.

Returns:

A constant that represents the precision used when the search is performed. Possible values are listed in the See Also section.

See Also:

DATE, HOUR, MINUTE, SECOND

setResultFilter

public void setResultFilter(BIFilter filter)

Specifies the search result filter to use after the search is finished. This allows the application to further customize what should be returned from the search method.

Parameters:

A - BIFilter object that is used to filter the search results from the search.

getResultFilter

public BIFilter getResultFilter()

Retrieves the search result filter that is used after the search is finished.

Returns:

A BIFilter object that is used to filter the search results from the search.

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Specifies where the search on attribute values is case sensitive. This applies to the following attributes:

• OBJECT_NAME
• DESCRIPTION
• KEYWORDS
• APPLICATION
• DATABASE
• APPSUBTYPE1
• TITLE
• COMPSUBTYPE1
• COMPSUBTYPE2
• COMPSUBTYPE3

Parameters:

caseSensitive - A boolean that represents whether the search is case sensitive

See Also:

isCaseSensitive(), PSRConstants

isCaseSensitive

public boolean isCaseSensitive()

Retrieves the caseSensitive setting that the search uses in comparing String values.

Returns:

A boolean that represents whether the search is case sensitive.

See Also:

setCaseSensitive(boolean), PSRConstants

setSortingComparator

public void setSortingComparator(BIComparator comp)

Sets a comparator that's used for comparing BISearchResult elements during sorting

Parameters:

comp - implementation of BIComparator interface. This parameter shouldn't be null.

getSortingComparator

public BIComparator getSortingComparator()

Returns a comparator that's used for comparing BISearchResult elements during sorting

Returns:

an implementation of BIComparator interface; null if none is set

isSortingOn

public boolean isSortingOn()

Queries BISearchControls to find out whether the sorting option is turned on.

Returns:

boolean true if the sorting is on, false if sorting is off

setSortingOn

public void setSortingOn(boolean flag)

Turns sorting behaviour on or off. If it's on, search results will be returned sorted.

Parameters:

flag - true to turn sorting on, false to turn sorting off.