public class ReadOptions extends OperationOptions
OperationOptions
containing options for entity read operation. Read options include Locale and Requested Attributes settings.Modifier and Type | Class and Description |
---|---|
static class |
ReadOptions.SearchScope
Search scope
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ALL_LOCALES |
Constructor and Description |
---|
ReadOptions() |
Modifier and Type | Method and Description |
---|---|
ReadOptions |
clone()
Clones this object
|
java.lang.String |
getIdentityDomainName()
Gets the Identity Domain Name
|
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
|
boolean |
isStaticMembershipOnly()
Gets the Group memberhsip type
|
void |
setGroupMembershipType(boolean staticMembershipOnly)
Sets the Group membership type.
|
void |
setIdentityDomainName(java.lang.String iddName)
Sets the Identity Domain Name for the operation.
|
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
|
getAuthUser, getParameter, getParameters, setAuthUser, setAuthUser, setParameter
public static final java.lang.String ALL_LOCALES
public void setLocale(java.lang.String locale)
ALL_LOCALES
fetches all the locale values.locale
- Locale string value to be setpublic void setLocale(java.util.Locale locale)
locale
- Locale value to be setpublic java.lang.String getLocale()
public void setRequestedAttrs(java.util.List<java.lang.String> requestedAttrs)
requestedAttrs
- List of attributes to be fetchedpublic java.util.List<java.lang.String> getRequestedAttrs()
public void setTimeLimit(int timeLimit)
timeLimit
- operation time limitpublic int getTimeLimit()
public void setSearchBase(java.lang.String searchBase, boolean absolute)
searchBase
- entity search baseabsolute
- true if the search base is absolute; false if the search base is relative to the search base configured in Identity Directorypublic void setSearchBase(java.lang.String searchBase)
searchBase
- entity search basepublic java.lang.String getSearchBase()
public boolean isSearchBaseAbsolute()
public void setSearchScope(ReadOptions.SearchScope searchScope)
searchScope
- entity search scopepublic ReadOptions.SearchScope getSearchScope()
public void setGroupMembershipType(boolean staticMembershipOnly)
staticMembershipOnly
- true for static membership only; false (default) for static/dynamic membershippublic boolean isStaticMembershipOnly()
public void setIdentityDomainName(java.lang.String iddName)
iddName
- name of the Identity Domainpublic java.lang.String getIdentityDomainName()
public ReadOptions clone()
clone
in class OperationOptions