|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Realm
Consists of a set of related groups and users. A realm is normally mapped to a directory partition (that is, a namingContext
)
in a directory server. The primary use of a Realm
object
is to retrieve lists of the groups and users in the realm.
You can instantiate a Realm
object by:
Factory.Realm
class. (See the note below.)EntireNetwork.get_MyRealm()
, which returns a Realm
object representing the realm in which the caller resides.RealmSet
collection.Note that when instantiating via the static factory methods, calling getInstance
with a null
realm name returns the
current realm; the behavior is the same as calling Factory.Realm.fetchCurrent()
.
Metadata
Auditable: false
Method Summary | |
---|---|
GroupSet |
findGroups(java.lang.String searchPattern,
PrincipalSearchType searchType,
PrincipalSearchAttribute searchAttribute,
PrincipalSearchSortType sortType,
java.lang.Integer pageSize,
PropertyFilter filter)
Returns a set of groups from this realm that matches the search parameters. |
UserSet |
findUsers(java.lang.String searchPattern,
PrincipalSearchType searchType,
PrincipalSearchAttribute searchAttribute,
PrincipalSearchSortType sortType,
java.lang.Integer pageSize,
PropertyFilter filter)
Returns a set of users, a page at a time, from this realm that matches the search parameters. |
java.lang.String |
get_Name()
Returns the value of the Name property. |
Methods inherited from interface com.filenet.api.core.IndependentObject |
---|
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh |
Methods inherited from interface com.filenet.api.core.EngineObject |
---|
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses |
Method Detail |
---|
java.lang.String get_Name()
UserSet findUsers(java.lang.String searchPattern, PrincipalSearchType searchType, PrincipalSearchAttribute searchAttribute, PrincipalSearchSortType sortType, java.lang.Integer pageSize, PropertyFilter filter)
pageSize
parameter.
Note: Searching is not case sensitive.
The rules that govern the search behavior are:
sortType
has a non-null value (not none), then searchAttribute
must also have a
non-null value. (sortType
needs a value to sort on.)searchPattern
or searchType
has a positive value (not empty or non-null, respectively),
then searchPattern
, searchType
, and searchAttribute
must all have positive values.If you pass in null
for the filter
parameter, this method
returns values for all non-object properties and returns placeholders for all object-valued
properties. For more information, see the description of the filter
parameter.
searchPattern
- A String
expression that specifies the string pattern used for the
search. Case does not matter.searchType
- Specifies how the search pattern is applied; null
indicates no
preference.searchAttribute
- Specifies the User
object property to use for the search;
null
indicates none.sortType
- Specifies the desired sorting; null
indicates no sorting is
to be performed.pageSize
- Specifies the size of each page of User
objects returned;
if null
or zero (0), page size defaults to 499.filter
- A PropertyFilter
object that represents information for
controlling which property values (and with what level of detail and recursion) to return.
If null
, this method returns values for all non-object properties and returns
placeholders for all object-valued properties (PropertyEngineObject
properties with a state of PropertyState.UNEVALUATED
or
PropertyState.REFERENCE
); any subsequent attempts to access an object-valued
property will cause an automatic round-trip to the server to fetch its value.
UserSet
object containing the User
objects matching
the search request.GroupSet findGroups(java.lang.String searchPattern, PrincipalSearchType searchType, PrincipalSearchAttribute searchAttribute, PrincipalSearchSortType sortType, java.lang.Integer pageSize, PropertyFilter filter)
Note: Searching is not case sensitive.
The rules that govern the search behavior are:
sortType
has a non-null value (not none), then searchAttribute
must also have a
non-null value. (sortType
needs a value to sort on.)searchPattern
or searchType
has a positive value (not empty or non-null, respectively),
then searchPattern
, searchType
, and searchAttribute
must all have positive values.If you pass in null
for the filter
parameter, this method
returns values for all non-object properties and returns placeholders for all object-valued
properties. For more information, see the description of the filter
parameter.
searchPattern
- A String
expression that specifies the string pattern used for the
search. Case does not matter.searchType
- Specifies how the search pattern is applied; null
indicates no
preference.searchAttribute
- Specifies the Group
object property to use for the search;
null
indicates none.sortType
- Specifies the desired sorting; null
indicates no sorting is
to be performed.pageSize
- Specifies the size of each page of Group
objects returned;
if null
or zero (0), page size defaults to 499.filter
- A PropertyFilter
object that represents information for
controlling which property values (and with what level of detail and recursion) to return.
If null
, this method returns values for all non-object properties and returns
placeholders for all object-valued properties (PropertyEngineObject
properties with a state of PropertyState.UNEVALUATED
or
PropertyState.REFERENCE
); any subsequent attempts to access an object-valued
property will cause an automatic round-trip to the server to fetch its value.
If null
, this method returns only non-object-valued property values for this object.
GroupSet
object containing the Group
objects matching the search request.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |