class SearchControls
extends anvil.lang.object

This class encapsultes factors that determine scope of search and what gets returned as a result of the search.

Constructor

SearchControls(flags...)

Creates search controller.

Parameters

flags - Zero or more of following expressions:

"scope" => typeOfScope: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE
"countlimit" => limit: Max number of entries to return
"timelimit" => limit: Timelimit, in milliseconds
"attributes" => sequence: Sequence of names of attributes to return
"returnobject" => flag: Should the objects be returned as part of result
"dereflinks" => flag: Should the links be dereference during the search
"returnobject": Same as "returnObject" => true
"dereflinks": Same as "dereflinks" => true
sequence: Sequence of name of attributes to return

Methods

int getCountLimit()

Retrieves the maximum number of entries that will be returned as a result of the search.

boolean getDerefLinks()

Determines whether links will be dereferenced during the search.

StringArray getReturningAttributes()

Retrieves the attributes that will be returned as part of the search.

boolean getReturnObject()

Determines whether objects will be returned as part of the result.

int getSearchScope()

Returns the scope of search.

int getTimeLimit()

Retrieves the time limit of these Controls in milliseconds.

SearchControls setCountLimit(int limit)

Sets the maximum number of entries to be returned as a result of search.

SearchControls setDerefLinks(boolean flag)

Enables/disables link dereferencing during the search.

SearchControls setReturningAttributes()
SearchControls setReturningAttributes(sequence attributes)

Specifies the attributes that will be returned as part of the search. null indicates that all attributes will be returned. An empty sequence indicates no attributes are returned.

SearchControls setReturnObject(boolean flag)

Enables/disables returning objects returned as part of the result.

SearchControls setSearchScope(int scope)

Sets the search scope.

Parameters scope - One of OBJECT_SCOPE, ONLEVEL_SCOPE, SUBTREE_SCOPE

SearchControls setTimeLimit(int limit)

Sets the time limit for searches.

Parameters limit - Limit, in milliseconds