com.adobe.idp.um.api.infomodel
Class GroupMembershipSearchFilter

java.lang.Object
  com.adobe.idp.um.api.infomodel.GenericSearchFilter
      com.adobe.idp.um.api.infomodel.GroupMembershipSearchFilter

All Implemented Interfaces:

java.io.Serializable

public class GroupMembershipSearchFilter
extends GenericSearchFilter
implements java.io.Serializable

The GroupMembershipSearchFilter class represents a filter that allows you to specify search criteria to use when searching for LiveCycle ES2 groups.

See Also:

Serialized Form

Field Summary

static java.lang.String	SEARCH_domain_status Domain status.
static java.lang.String	SEARCH_member_type_group MemberType :Groups only
static java.lang.String	SEARCH_member_type_users MemberType :Users only
static java.lang.String	SEARCH_member_type_users_and_groups MemberType :Users and Groups
static java.lang.String	SEARCH_principal_status Principal status.
static java.lang.String	SORT_CommonName Indicates you want to sort the results based upon the common name.
static java.lang.String	SORT_Email Indicates that you want to sort the results based upon the primary email.
static java.lang.String	SORT_Organization Indicates that you want to sort the results based upon the organization.
static java.lang.String	STATUS_CURRENT Current status.

Constructor Summary

GroupMembershipSearchFilter()
A constructor that sorts by common name in an ascending order.

Method Summary

java.lang.String	getGroupOid() Retrieves the group identifier.
java.lang.String	getSearchMemberType() Retrieves the search member type.
void	setGroupOid(java.lang.String r) Allows you to do an exact match search for a group.
void	setSearchMemberType(java.lang.String searchMemberType) Sets the search member type.

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

STATUS_CURRENT

public static final java.lang.String STATUS_CURRENT

Current status.

See Also:

Constant Field Values

SEARCH_principal_status

public static final java.lang.String SEARCH_principal_status

Principal status.

See Also:

Constant Field Values

SEARCH_domain_status

public static final java.lang.String SEARCH_domain_status

Domain status.

See Also:

Constant Field Values

SEARCH_member_type_users_and_groups

public static final java.lang.String SEARCH_member_type_users_and_groups

MemberType :Users and Groups

See Also:

Constant Field Values

SEARCH_member_type_users

public static final java.lang.String SEARCH_member_type_users

MemberType :Users only

See Also:

Constant Field Values

SEARCH_member_type_group

public static final java.lang.String SEARCH_member_type_group

MemberType :Groups only

See Also:

Constant Field Values

SORT_CommonName

public static final java.lang.String SORT_CommonName

Indicates you want to sort the results based upon the common name. For example, "John Doe".

See Also:

Constant Field Values

SORT_Email

public static final java.lang.String SORT_Email

Indicates that you want to sort the results based upon the primary email. For example, "jdoe@adobe.com".

See Also:

Constant Field Values

SORT_Organization

public static final java.lang.String SORT_Organization

Indicates that you want to sort the results based upon the organization.

See Also:

Constant Field Values

Constructor Detail

GroupMembershipSearchFilter

public GroupMembershipSearchFilter()

A constructor that sorts by common name in an ascending order.

Method Detail

setGroupOid

public void setGroupOid(java.lang.String r)

Allows you to do an exact match search for a group.

Parameters:

r - The identifier of the group to search for.

getGroupOid

public java.lang.String getGroupOid()

Retrieves the group identifier.

Returns:

The group identifier.

getSearchMemberType

public java.lang.String getSearchMemberType()

Retrieves the search member type.

Returns:

The search member type

setSearchMemberType

public void setSearchMemberType(java.lang.String searchMemberType)

Sets the search member type.

Parameters:

searchMemberType - The search member type