Interface StoreSearchRequest
-
- All Superinterfaces:
StoreRequest
@NotExtensible public interface StoreSearchRequest extends StoreRequest
Represents a search request to retrieve entries from a Store Adapter.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getSCIMFilter()
Retrieves the SCIM Filter associated with this search request.int
getSizeLimit()
Retrieves the maximum number of objects the store adapter should return for the search.StoreSearchResultListener
getStoreSearchResultListener()
Retrieve the result listener that will be used to return results to the caller.-
Methods inherited from interface com.unboundid.directory.sdk.broker.types.StoreRequest
getHttpServletRequest
-
-
-
-
Method Detail
-
getStoreSearchResultListener
StoreSearchResultListener getStoreSearchResultListener()
Retrieve the result listener that will be used to return results to the caller.- Returns:
- The result listener that will be used to return results to the caller.
-
getSCIMFilter
java.lang.String getSCIMFilter()
Retrieves the SCIM Filter associated with this search request. The UnboundID scim2 SDK Filter class can be used to parse a SCIM filter.- Returns:
- The SCIM Filter that should be used. This may be
null
if no filtering is required.
-
getSizeLimit
int getSizeLimit()
Retrieves the maximum number of objects the store adapter should return for the search. A value of zero or less indicates that there should be no limit.- Returns:
- The maximum number of objects the store adapter should return for the search. A value of zero or less indicates that there should be no limit.
-
-