Skip navigation links

oracle.igf.ids
Class ReadOptions

java.lang.Object
oracle.igf.ids.OperationOptions
oracle.igf.ids.ReadOptions

Direct Known Subclasses:

SearchOptions

public class ReadOptions

extends OperationOptions

This class extends OperationOptions containing options for entity read operation. Read options include Locale and Requested Attributes settings.

Nested Class Summary

static class

ReadOptions.SearchScope Search scope

Field Summary

static java.lang.String

ALL_LOCALES

Constructor Summary

ReadOptions()

Method Summary

ReadOptions	clone() Clones this object
java.lang.String	getLocale() Gets the locale string value
java.util.List<java.lang.String>	getRequestedAttrs() Gets the requested attributes specified
java.lang.String	getSearchBase() Gets the entity search base
ReadOptions.SearchScope	getSearchScope() Gets the entity search scope
int	getTimeLimit() Gets the time limit
boolean	isSearchBaseAbsolute() Gets the entity search base Absolute flag
void	setLocale(java.util.Locale locale) Sets the locale option.
void	setLocale(java.lang.String locale) Sets the locale option.
void	setRequestedAttrs(java.util.List<java.lang.String> requestedAttrs) Sets requested attributes to be fetched from the repository
void	setSearchBase(java.lang.String searchBase) Sets the entity search base where the entities need to be searched under.
void	setSearchBase(java.lang.String searchBase, boolean absolute) Sets the entity search base where the entities need to be searched under.
void	setSearchScope(ReadOptions.SearchScope searchScope) Sets the entity search scope - base / onelevel / subtree, where default is subtree search
void	setTimeLimit(int timeLimit) Sets the time limit (in seconds), time in which the search operation to be performed

Methods inherited from class oracle.igf.ids.OperationOptions

getAuthUser, getParameter, getParameters, setAuthUser, setAuthUser, setParameter

Methods inherited from class java.lang.Object

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

Field Detail

ALL_LOCALES

public static final java.lang.String ALL_LOCALES

See Also:

Constant Field Values

Constructor Detail

ReadOptions

public ReadOptions()

Method Detail

setLocale

public void setLocale(java.lang.String locale)

Sets the locale option. If the entity has different locale values, read operation fetches only the specified locale value instead of some default. Setting the locale vlaue ALL_LOCALES fetches all the locale values.

Parameters:

locale - Locale string value to be set

setLocale

public void setLocale(java.util.Locale locale)

Sets the locale option. If the entity has different locale values, read operation fetches only the specified locale value instead of some default.

Parameters:

locale - Locale value to be set

getLocale

public java.lang.String getLocale()

Gets the locale string value

Returns:

locale string value

setRequestedAttrs

public void setRequestedAttrs(java.util.List<java.lang.String> requestedAttrs)

Sets requested attributes to be fetched from the repository

Parameters:

requestedAttrs - List of attributes to be fetched

getRequestedAttrs

public java.util.List<java.lang.String> getRequestedAttrs()

Gets the requested attributes specified

Returns:

list of requested attribute names

setTimeLimit

public void setTimeLimit(int timeLimit)

Sets the time limit (in seconds), time in which the search operation to be performed

Parameters:

timeLimit - operation time limit

getTimeLimit

public int getTimeLimit()

Gets the time limit

Returns:

time limit

setSearchBase

public void setSearchBase(java.lang.String searchBase,
                          boolean absolute)

Sets the entity search base where the entities need to be searched under. This search base overrides the search base configured in the Identity Directory.

Parameters:

searchBase - entity search base

absolute - true if the search base is absolute; false if the search base is relative to the search base configured in Identity Directory

setSearchBase

public void setSearchBase(java.lang.String searchBase)

Sets the entity search base where the entities need to be searched under. This search base overrides the search base configured in the Identity Directory and this is relative to entity search base configured in Identity Directory.

Parameters:

searchBase - entity search base

getSearchBase

public java.lang.String getSearchBase()

Gets the entity search base

Returns:

search base

isSearchBaseAbsolute

public boolean isSearchBaseAbsolute()

Gets the entity search base Absolute flag

Returns:

true if the searchBase is absolute not relative to search base configured in Identity Directory

setSearchScope

public void setSearchScope(ReadOptions.SearchScope searchScope)

Sets the entity search scope - base / onelevel / subtree, where default is subtree search

Parameters:

searchScope - entity search scope

getSearchScope

public ReadOptions.SearchScope getSearchScope()

Gets the entity search scope

Returns:

search scope

clone

public ReadOptions clone()

Clones this object

Overrides:

clone in class OperationOptions

Returns:

cloned object

Skip navigation links