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

java.lang.Object
  extended by com.adobe.idp.um.api.infomodel.GenericSearchFilter
      extended by com.adobe.idp.um.api.infomodel.RoleMembershipSearchFilter
All Implemented Interfaces:
java.io.Serializable

public class RoleMembershipSearchFilter
extends GenericSearchFilter
implements java.io.Serializable

This filter allows you specify role membership search criteria to be AND-ed together. 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
          Current (active) domain.
static java.lang.String DOMAIN_STATUS_FIELD
          Domain status.
static java.lang.String FLD_SPC_PRINCIPAL_COMMON_NAME
          Principal common name.
static java.lang.String FLD_SPC_PRINCIPAL_EMAIL
          Principal email identifier.
static java.lang.String FLD_SPC_PRINCIPAL_ORG
          Principal organization.
static java.lang.String PRINCIPAL_STATUS_CURRENT
          Current (active) principal.
static java.lang.String PRINCIPAL_STATUS_FIELD
          Principal status.
static java.lang.Object SORT_CommonName
          Sort according to the common name.
 
Fields inherited from class com.adobe.idp.um.api.infomodel.GenericSearchFilter
SEARCHTYPE_EQUALS, SEARCHTYPE_GREATER, SEARCHTYPE_GREATER_EQUALS, SEARCHTYPE_LESS, SEARCHTYPE_LESS_EQUALS, SEARCHTYPE_LIKE, SEARCHTYPE_LIKE_ENDS_WITH, SEARCHTYPE_LIKE_STARTS_WITH
 
Constructor Summary
RoleMembershipSearchFilter()
          Default constructor.
 
Method Summary
 java.lang.String getRoleId()
          Retrieves the role identifier.
 void setRoleId(java.lang.String roleName)
          Perform 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, isMatchExactCriteria, isSearch, isSortAscending, setMatchExactCriteria, 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
Domain status.

See Also:
Constant Field Values

DOMAIN_STATUS_CURRENT

public static final java.lang.String DOMAIN_STATUS_CURRENT
Current (active) domain.

See Also:
Constant Field Values

PRINCIPAL_STATUS_FIELD

public static final java.lang.String PRINCIPAL_STATUS_FIELD
Principal status.

See Also:
Constant Field Values

PRINCIPAL_STATUS_CURRENT

public static final java.lang.String PRINCIPAL_STATUS_CURRENT
Current (active) principal.

See Also:
Constant Field Values

FLD_SPC_PRINCIPAL_COMMON_NAME

public static final java.lang.String FLD_SPC_PRINCIPAL_COMMON_NAME
Principal common name.

See Also:
Constant Field Values

FLD_SPC_PRINCIPAL_EMAIL

public static final java.lang.String FLD_SPC_PRINCIPAL_EMAIL
Principal email identifier.

See Also:
Constant Field Values

FLD_SPC_PRINCIPAL_ORG

public static final java.lang.String FLD_SPC_PRINCIPAL_ORG
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()
Default constructor. Sorts by RoleMembershipSearchFilter.SORT_CommonName in ascending order.

Method Detail

setRoleId

public void setRoleId(java.lang.String roleName)
Perform a search on an exact match with the specified role name. You are strongly advised to call this method.

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

getRoleId

public java.lang.String getRoleId()
Retrieves the role identifier.

Returns:
The role identifier.