|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.idp.um.api.infomodel.GenericSearchFilter com.adobe.idp.um.api.infomodel.PrincipalSearchFilter
public class PrincipalSearchFilter
The PrincipalSearchFilter
class allows you to specify principal search criteria.
The principal search criteria is used while searching for principals.
To see an object of this type used in a code example, see the Managing users and groups using the Java API quick start
in Programming with LiveCycle ES4.
Field Summary | |
---|---|
static java.lang.String |
SEARCH_canonicalName
Search according to the canonical name. |
static java.lang.String |
SEARCH_commonName
Search according to the common name. |
static java.lang.String |
SEARCH_domain_oids
Search according to the domain oid. |
static java.lang.String |
SEARCH_domain_status
Search according to the domain status. |
static java.lang.String |
SEARCH_domainId
Search according to the domain identifier. |
static java.lang.String |
SEARCH_domainName
Search according to the domain name. |
static java.lang.String |
SEARCH_email
Search according to the email identifier. |
static java.lang.String |
SEARCH_isLocal
Search according to the whether the principal is local. |
static java.lang.String |
SEARCH_principal_status
Search according to the principal status. |
static java.lang.String |
SEARCH_principalOid
Search according to the principal type. |
static java.lang.String |
SEARCH_principalType
Search according to the principal type. |
static java.lang.String |
SEARCH_userid
Search according to the user identifier. |
static java.lang.String |
SEARCH_visibility
Search according to the visibility level. |
static java.lang.Object |
SORT_CommonName
Sort according to the common name. |
static java.lang.Object |
SORT_Email
Sort according to the primary email. |
static java.lang.Object |
SORT_Organization
Sort according to the organization. |
static java.lang.String |
STATUS_CURRENT
The principal is current (active). |
Constructor Summary | |
---|---|
PrincipalSearchFilter()
|
Method Summary | |
---|---|
java.lang.String |
getCanonicalName()
Retrieves the canonical name used to search for principals. |
java.lang.String |
getCommonName()
Retrieves the common name on which to base the search. |
java.util.Set |
getDomainOids()
Retrieves the domain identifiers. |
java.lang.String |
getEmail()
Retrieves the wildcard characters on which to search for email addresses. |
java.lang.String |
getPrincipalOid()
Retrieves the principal oid on which to base the search. |
java.lang.String |
getPrincipalType()
Retrieves the principal type on which to base the search. |
java.lang.String |
getSpecificDomain()
Retrieve the specific domain identifier used to search for principals. |
java.lang.String |
getUserId()
Retrieves the user identifier on which to base the search. |
java.lang.Boolean |
isLocal()
Determines whether local results will be returned. |
boolean |
obtainCompletePrincipal()
Determines whether to search using the complete principal. |
void |
setCanonicalName(java.lang.String canonicalName)
Search for principals based on a canonical name. |
void |
setCommonName(java.lang.String cn)
Perform a wildcard search on the common name associated with the principal. |
void |
setDomainOids(java.util.Set domainOids)
Search for principals belonging to selective domains. |
void |
setEmail(java.lang.String e)
Perform a wildcard search on the various email addresses associated with the principal. |
void |
setIsLocal(boolean restrictIsLocal)
Sets whether local results will be returned. |
void |
setObtainCompletePrincipal(boolean obtainCompletePrincipal)
Search using the complete principal |
void |
setPrincipalOid(java.lang.String principalOid)
Set the principal oid on which to base the search. |
void |
setPrincipalType(java.lang.String principalType)
Sets the principal type on which to base the search. |
void |
setRetrieveOnlyActive()
Search for active principals only. |
void |
setRetrieveOnlyActive(boolean retrieveActive)
An overloaded version of PrincipalSearchFilter.setRetrieveOnlyActive() . |
void |
setSpecificDomain(java.lang.String domainOid)
Search for principals based on a specific domain identifier. |
void |
setSpecificDomainName(java.lang.String domainName)
Searches for principals in a specific domain, given the domain name (for example, adobe.com ). |
void |
setUserid(java.lang.String userId)
Deprecated. Use setUserId() instead. |
void |
setUserId(java.lang.String userId)
Perform a wildcard search on the user identifier associated with the principal. |
void |
setUserIdAbsolute(java.lang.String userId)
Perform a wildcard search on an exact match with the user identifier associated with the principal. |
void |
setVisibility(int visibility)
Searches for principals based on the visibility level. |
Methods inherited from class com.adobe.idp.um.api.infomodel.GenericSearchFilter |
---|
getResultsMax, getResultsOffset, getSearches, getSearchType, getSearchVal, getSortField, isSearch, isSortAscending, setResultsMax, setResultsOffset, setSort, setSortAscending, setSortField |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SEARCH_principalOid
public static final java.lang.String SEARCH_principalType
public static final java.lang.String SEARCH_email
public static final java.lang.String SEARCH_userid
public static final java.lang.String SEARCH_visibility
public static final java.lang.String SEARCH_commonName
public static final java.lang.String SEARCH_isLocal
public static final java.lang.String SEARCH_domainName
public static final java.lang.String SEARCH_domainId
public static final java.lang.String SEARCH_canonicalName
public static final java.lang.String SEARCH_principal_status
public static final java.lang.String SEARCH_domain_status
public static final java.lang.String SEARCH_domain_oids
public static final java.lang.String STATUS_CURRENT
public static final java.lang.Object SORT_CommonName
public static final java.lang.Object SORT_Email
public static final java.lang.Object SORT_Organization
Constructor Detail |
---|
public PrincipalSearchFilter()
Method Detail |
---|
public void setEmail(java.lang.String e)
e = "doe"
will match "john_doe@adobe.com"
.
e
- The wildcard characters on which to search for email addresses.public void setPrincipalOid(java.lang.String principalOid)
principalOid
- The principal oid on which to base the search.public java.lang.String getPrincipalOid()
public java.lang.String getEmail()
public void setPrincipalType(java.lang.String principalType)
principalType
- The principal type on which to base the search.public java.lang.String getPrincipalType()
public void setUserid(java.lang.String userId)
setUserId()
instead.
public void setUserId(java.lang.String userId)
userId
- The wildcard characters on which to search for the user identifier.public void setUserIdAbsolute(java.lang.String userId)
userId
- The wildcard characters on which to search for the user identifier.public java.lang.String getUserId()
public void setCommonName(java.lang.String cn)
cn = oe
will match John Doe
.
cn
- The wildcard characters on which to search for the common name.public java.lang.String getCommonName()
public void setIsLocal(boolean restrictIsLocal)
restrictIsLocal
- The value true
returns local results, false
returns directory results.public java.lang.Boolean isLocal()
true
if local results are returned, false
if directory results are returned.public void setSpecificDomainName(java.lang.String domainName)
adobe.com
).
Searches within specific domains can be accomplished using the following methods:
Using more than one of above specified ways can lead to a conflict. In case of a conflict, the last set criterion shall apply.
domainName
- The domain name in which to search for principals.public void setSpecificDomain(java.lang.String domainOid)
domainOid
- The domain identifier.public java.lang.String getSpecificDomain()
public void setCanonicalName(java.lang.String canonicalName)
canonicalName
- A string value that specifies the canonical name on which to base the search.public java.lang.String getCanonicalName()
public void setVisibility(int visibility)
visibility
- The visibility level on which to base the search.public void setRetrieveOnlyActive()
public void setRetrieveOnlyActive(boolean retrieveActive)
PrincipalSearchFilter.setRetrieveOnlyActive()
. It is added so as to expose this as attribute
so that client using web services can access it. Client's using sdk should continue using
PrincipalSearchFilter.setRetrieveOnlyActive()
retrieveActive
- if true
then it would only retrieve active userspublic boolean obtainCompletePrincipal()
true
if searching using the complete principal, false
otherwise.public void setObtainCompletePrincipal(boolean obtainCompletePrincipal)
public void setDomainOids(java.util.Set domainOids)
domainOids
- containing domain oids.public java.util.Set getDomainOids()
java.util.Set
containing the domain identifiers.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |