com.adobe.idp.um.api.infomodel.PrincipalSearchFilter (Livecycle)

	Constant	Defined By
		SEARCH_canonicalName [static] Search according to the canonical name.	PrincipalSearchFilter
		SEARCH_commonName [static] Search according to the common name.	PrincipalSearchFilter
		SEARCH_domainId [static] Search according to the domain identifier.	PrincipalSearchFilter
		SEARCH_domainName [static] Search according to the domain name.	PrincipalSearchFilter
		SEARCH_domain_oids [static] Search according to the domain oid.	PrincipalSearchFilter
		SEARCH_domain_status [static] Search according to the domain status.	PrincipalSearchFilter
		SEARCH_email [static] Search according to the email identifier.	PrincipalSearchFilter
		SEARCH_isLocal [static] Search according to the whether the principal is local.	PrincipalSearchFilter
		SEARCH_principalOid [static] Search according to the principal type.	PrincipalSearchFilter
		SEARCH_principal_status [static] Search according to the principal status.	PrincipalSearchFilter
		SEARCH_principalType [static] Search according to the principal type.	PrincipalSearchFilter
		SEARCH_userid [static] Search according to the user identifier.	PrincipalSearchFilter
		SEARCH_visibility [static] Search according to the visibility level.	PrincipalSearchFilter
		SORT_CommonName [static] Sort according to the common name.	PrincipalSearchFilter
		SORT_Email [static] Sort according to the primary email.	PrincipalSearchFilter
		SORT_Organization [static] Sort according to the organization.	PrincipalSearchFilter
		STATUS_CURRENT [static] The principal is current (active).	PrincipalSearchFilter

Constructor Detail

PrincipalSearchFilter

()

public PrincipalSearchFilter()

Method Detail

getCanonicalName

()

public String getCanonicalName()

Retrieve the canonical name used to search for principals.

Returns

The canonical name.

getCommonName

()

public String getCommonName()

Retrieves the common name on which to base the search.

Returns

The common name on which to base the search.

getDomainOids

()

public Set getDomainOids()

Retrieves the domain identifiers.

Returns

A java.util.Set containing the domain identifiers.

getEmail

()

public String getEmail()

Retrieves the wildcard characters on which to search for email addresses.

Returns

getPrincipalOid

()

public String getPrincipalOid()

Retrieves the principal oid on which to base the search.

Returns

The principal oid on which to base the search.

getPrincipalType

()

public String getPrincipalType()

Retrieves the principal type on which to base the search.

Returns

The principal type on which to base the search.

getSpecificDomain

()

public String getSpecificDomain()

Retrieve the specific domain identifier used to search for principals.

Returns

The domain identifier.

getUserId

()

public String getUserId()

Retrieves the user identifier on which to base the search.

Returns

The user identifier on which to base the search.

isLocal

()

public Boolean isLocal()

Determines whether local results will be returned.

Returns

true if local results are returned, false if directory results are returned.

obtainCompletePrincipal

()

public boolean obtainCompletePrincipal()

Determines whether to search using the complete principal.

Returns

true if searching using the complete principal, false otherwise.

setCanonicalName

()

public void setCanonicalName(String canonicalName)

Search for principals based on a canonical name.

Parameters

canonicalName — The canonical name on which to base the search.

setCommonName

()

public void setCommonName(String cn)

Perform a wildcard search on the common name associated with the principal.

Parameters

cn — The wildcard characters on which to search for the common name.

Example
How to use examples
cn = "oe" will match "John Doe".

setDomainOids

()

public void setDomainOids(Set domainOids)

Search for principals belonging to selective domains. 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.

Parameters

domainOids — containing domain oids.

setEmail

()

public void setEmail(String e)

Perform a wildcard search on the various email addresses associated with the principal.

Parameters

e — The wildcard characters on which to search for email addresses.

Example
How to use examples
e = "doe" will match "john_doe@adobe.com".

setIsLocal

()

public void setIsLocal(boolean restrictIsLocal)

Sets whether local results will be returned. The default is that the search will not discriminate between local principals and directory principals.

Parameters

restrictIsLocal — true returns local results, false returns directory results.

setObtainCompletePrincipal

()

public void setObtainCompletePrincipal(boolean obtainCompletePrincipal)

Search using the complete principal

Parameters

obtainCompletePrincipal

setPrincipalOid

()

public void setPrincipalOid(String principalOid)

Set the principal oid on which to base the search.

Parameters

principalOid — The principal oid on which to base the search.

setPrincipalType

()

public void setPrincipalType(String principalType)

Set the principal type on which to base the search.

Parameters

principalType — The principal type on which to base the search.

setRetrieveOnlyActive

()

public void setRetrieveOnlyActive()

Search for active principals only. The default is that both active and deleted principals will be returned.

setRetrieveOnlyActive

()

public void setRetrieveOnlyActive(boolean retrieveActive)

An overloaded version of 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 setRetrieveOnlyActive()

Parameters

retrieveActive — if true then it would only retrieve active users

setSpecificDomain

()

public void setSpecificDomain(String domainOid)

Search for principals based on a specific domain identifier. 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.

Parameters

domainOid — The domain identifier.

setSpecificDomainName

()

public void setSpecificDomainName(String domainName)

Searches for principals in a specific domain, given the domain name (for example, "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.

Parameters

domainName — The domain name in which to search for principals.

setUserid

()

public void setUserid(String userId)

Deprecated: Use setUserId() instead.

Do not use.

Parameters

userId

setUserId

()

public void setUserId(String userId)

Perform a wildcard search on the user identifier associated with the principal.

Parameters

userId — The wildcard characters on which to search for the user identifier.

setUserIdAbsolute

()

public void setUserIdAbsolute(String userId)

Perform a wildcard search on an exact match with the user identifier associated with the principal.

Parameters

userId — The wildcard characters on which to search for the user identifier.

setVisibility

()

public void setVisibility(int visibility)

Search for principals based on the visibility level.

Parameters

visibility — The visibility level on which to base the search.

Constant Detail

SEARCH_canonicalName

Constant

public static final SEARCH_canonicalName

Search according to the canonical name.

SEARCH_commonName

Constant

public static final SEARCH_commonName

Search according to the common name.

SEARCH_domain_oids

Constant

public static final SEARCH_domain_oids

Search according to the domain oid.

SEARCH_domain_status

Constant

public static final SEARCH_domain_status

Search according to the domain status.

SEARCH_domainId

Constant

public static final SEARCH_domainId

Search according to the domain identifier.

SEARCH_domainName

Constant

public static final SEARCH_domainName

Search according to the domain name.

SEARCH_email

Constant

public static final SEARCH_email

Search according to the email identifier.

SEARCH_isLocal

Constant

public static final SEARCH_isLocal

Search according to the whether the principal is local.

SEARCH_principal_status

Constant

public static final SEARCH_principal_status

Search according to the principal status.

SEARCH_principalOid

Constant

public static final SEARCH_principalOid

Search according to the principal type.

SEARCH_principalType

Constant

public static final SEARCH_principalType

Search according to the principal type.

SEARCH_userid

Constant

public static final SEARCH_userid

Search according to the user identifier.

SEARCH_visibility

Constant

public static final SEARCH_visibility

Search according to the visibility level.

SORT_CommonName

Constant

public static final SORT_CommonName

Sort according to the common name.

SORT_Email

Constant

public static final SORT_Email

Sort according to the primary email.

SORT_Organization

Constant

public static final SORT_Organization

Sort according to the organization.

STATUS_CURRENT

Constant

public static final STATUS_CURRENT

The principal is current (active).

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/idp/um/api/infomodel/PrincipalSearchFilter.html

LiveCycle ES Java API Reference	All Packages \| All Classes \| Index \| Frames No Frames
PrincipalSearchFilter	Properties \| Methods \| Events \| Styles \| Effects \| Constants \| Examples

Package	com.adobe.idp.um.api.infomodel
Class	public class PrincipalSearchFilter
Inheritance	PrincipalSearchFilter GenericSearchFilter

	Method		Defined By
		PrincipalSearchFilter()	PrincipalSearchFilter
		String getCanonicalName() Retrieve the canonical name used to search for principals.	PrincipalSearchFilter
		String getCommonName() Retrieves the common name on which to base the search.	PrincipalSearchFilter
		Set getDomainOids() Retrieves the domain identifiers.	PrincipalSearchFilter
		String getEmail() Retrieves the wildcard characters on which to search for email addresses.	PrincipalSearchFilter
		String getPrincipalOid() Retrieves the principal oid on which to base the search.	PrincipalSearchFilter
		String getPrincipalType() Retrieves the principal type on which to base the search.	PrincipalSearchFilter
		int getResultsMax() Retrieves the maximum number of results.
		int getResultsOffset() Retrieves the offset index.
		Iterator getSearches() For internal use only.
		int getSearchType(Object searchKey) For internal use only.
		Object getSearchVal(Object searchKey) For internal use only.
		Object getSortField() Retrieves the sorting field.
		String getSpecificDomain() Retrieve the specific domain identifier used to search for principals.	PrincipalSearchFilter
		String getUserId() Retrieves the user identifier on which to base the search.	PrincipalSearchFilter
		Boolean isLocal() Determines whether local results will be returned.	PrincipalSearchFilter
		boolean isSearch(Object searchKey) For internal use only.
		boolean isSortAscending() Determines whether the sorting results will occur in ascending order.
		boolean obtainCompletePrincipal() Determines whether to search using the complete principal.	PrincipalSearchFilter
		void setCanonicalName(String canonicalName) Search for principals based on a canonical name.	PrincipalSearchFilter
		void setCommonName(String cn) Perform a wildcard search on the common name associated with the principal.	PrincipalSearchFilter
		void setDomainOids(Set domainOids) Search for principals belonging to selective domains.	PrincipalSearchFilter
		void setEmail(String e) Perform a wildcard search on the various email addresses associated with the principal.	PrincipalSearchFilter
		void setIsLocal(boolean restrictIsLocal) Sets whether local results will be returned.	PrincipalSearchFilter
		void setObtainCompletePrincipal(boolean obtainCompletePrincipal) Search using the complete principal	PrincipalSearchFilter
		void setPrincipalOid(String principalOid) Set the principal oid on which to base the search.	PrincipalSearchFilter
		void setPrincipalType(String principalType) Set the principal type on which to base the search.	PrincipalSearchFilter
		void setResultsMax(int resultsMax) Sets the total number of desired results.
		void setResultsOffset(int resultsOffset) Sets the offset index.
		void setRetrieveOnlyActive() Search for active principals only.	PrincipalSearchFilter
		void setRetrieveOnlyActive(boolean retrieveActive) An overloaded version of #setRetrieveOnlyActive().	PrincipalSearchFilter
		void setSort(Object sortField, boolean sortAscending) Sets the sort order of the returned results.
		void setSortAscending(boolean sortAscending) Sets the sort order of the returned results.
		void setSortField(Object sortField) Set the field name.
		void setSpecificDomain(String domainOid) Search for principals based on a specific domain identifier.	PrincipalSearchFilter
		void setSpecificDomainName(String domainName) Searches for principals in a specific domain, given the domain name (for example, `"adobe.com"`).	PrincipalSearchFilter
		void setUserid(String userId) Do not use.	PrincipalSearchFilter
		void setUserId(String userId) Perform a wildcard search on the user identifier associated with the principal.	PrincipalSearchFilter
		void setUserIdAbsolute(String userId) Perform a wildcard search on an exact match with the user identifier associated with the principal.	PrincipalSearchFilter
		void setVisibility(int visibility) Search for principals based on the visibility level.	PrincipalSearchFilter