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

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

All Implemented Interfaces:

java.io.Serializable

public class RoleMembershipSearchFilter
extends GenericSearchFilter
implements java.io.Serializable

The RoleMembershipSearchFilter class represents a filter that allows you to specify role membership search criteria. For more information on sorting or specifying the number of results, see GenericSearchFilter.

See Also:

Serialized Form

Field Summary

static java.lang.String	DOMAIN_STATUS_CURRENT Represents the current (active) domain.
static java.lang.String	DOMAIN_STATUS_FIELD Represents domain status.
static java.lang.String	FLD_SPC_PRINCIPAL_COMMON_NAME Represents the principal common name.
static java.lang.String	FLD_SPC_PRINCIPAL_EMAIL Represents the principal email identifier.
static java.lang.String	FLD_SPC_PRINCIPAL_ORG Represents the principal organization.
static java.lang.String	PRINCIPAL_STATUS_CURRENT Represents the current (active) principal.
static java.lang.String	PRINCIPAL_STATUS_FIELD Represents the principal status.
static java.lang.Object	SORT_CommonName Sort according to the common name.

Constructor Summary

RoleMembershipSearchFilter()
The default constructor.

Method Summary

java.lang.String	getRoleId() Retrieves the role identifier.
void	setRoleId(java.lang.String roleName) Performs a search on an exact match with the specified role name.

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

DOMAIN_STATUS_FIELD

public static final java.lang.String DOMAIN_STATUS_FIELD

Represents domain status.

See Also:

Constant Field Values

DOMAIN_STATUS_CURRENT

public static final java.lang.String DOMAIN_STATUS_CURRENT

Represents the current (active) domain.

See Also:

Constant Field Values

PRINCIPAL_STATUS_FIELD

public static final java.lang.String PRINCIPAL_STATUS_FIELD

Represents the principal status.

See Also:

Constant Field Values

PRINCIPAL_STATUS_CURRENT

public static final java.lang.String PRINCIPAL_STATUS_CURRENT

Represents the current (active) principal.

See Also:

Constant Field Values

FLD_SPC_PRINCIPAL_COMMON_NAME

public static final java.lang.String FLD_SPC_PRINCIPAL_COMMON_NAME

Represents the principal common name.

See Also:

Constant Field Values

FLD_SPC_PRINCIPAL_EMAIL

public static final java.lang.String FLD_SPC_PRINCIPAL_EMAIL

Represents the principal email identifier.

See Also:

Constant Field Values

FLD_SPC_PRINCIPAL_ORG

public static final java.lang.String FLD_SPC_PRINCIPAL_ORG

Represents the principal organization.

See Also:

Constant Field Values

SORT_CommonName

public static final java.lang.Object SORT_CommonName

Sort according to the common name.

Constructor Detail

RoleMembershipSearchFilter

public RoleMembershipSearchFilter()

The default constructor. Sorts by RoleMembershipSearchFilter.SORT_CommonName in ascending order.

Method Detail

setRoleId

public void setRoleId(java.lang.String roleName)

Performs a search on an exact match with the specified role name.

Parameters:

roleName - The role name on which to base the search.

getRoleId

public java.lang.String getRoleId()

Retrieves the role identifier.

Returns:

A string value that specifies the role identifier.