Packagecom.adobe.idp.um.api.infomodel
Classpublic class RoleMembershipSearchFilter
InheritanceRoleMembershipSearchFilter Inheritance GenericSearchFilter

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.


Public Methods
 MethodDefined By
  
RoleMembershipSearchFilter()
Default constructor.
RoleMembershipSearchFilter
 Inherited
int getResultsMax()
Retrieves the maximum number of results.
 Inherited
int getResultsOffset()
Retrieves the offset index.
  
String getRoleId()
Retrieves the role identifier.
RoleMembershipSearchFilter
 Inherited
Iterator getSearches()
For internal use only.
 Inherited
int getSearchType(Object searchKey)
For internal use only.
 Inherited
Object getSearchVal(Object searchKey)
For internal use only.
 Inherited
Object getSortField()
Retrieves the sorting field.
 Inherited
boolean isSearch(Object searchKey)
For internal use only.
 Inherited
boolean isSortAscending()
Determines whether the sorting results will occur in ascending order.
 Inherited
void setResultsMax(int resultsMax)
Sets the total number of desired results.
 Inherited
void setResultsOffset(int resultsOffset)
Sets the offset index.
  
void setRoleId(String roleName)
Perform a search on an exact match with the specified role name.
RoleMembershipSearchFilter
 Inherited
void setSort(Object sortField, boolean sortAscending)
Sets the sort order of the returned results.
 Inherited
void setSortAscending(boolean sortAscending)
Sets the sort order of the returned results.
 Inherited
void setSortField(Object sortField)
Set the field name.
Public Constants
 ConstantDefined By
  DOMAIN_STATUS_CURRENT
[static] Current (active) domain.
RoleMembershipSearchFilter
  DOMAIN_STATUS_FIELD
[static] Domain status.
RoleMembershipSearchFilter
  FLD_SPC_PRINCIPAL_COMMON_NAME
[static] Principal common name.
RoleMembershipSearchFilter
  FLD_SPC_PRINCIPAL_EMAIL
[static] Principal email identifier.
RoleMembershipSearchFilter
  FLD_SPC_PRINCIPAL_ORG
[static] Principal organization.
RoleMembershipSearchFilter
  PRINCIPAL_STATUS_CURRENT
[static] Current (active) principal.
RoleMembershipSearchFilter
  PRINCIPAL_STATUS_FIELD
[static] Principal status.
RoleMembershipSearchFilter
  SORT_CommonName
[static] Sort according to the common name.
RoleMembershipSearchFilter
Constructor Detail
RoleMembershipSearchFilter()
public RoleMembershipSearchFilter()

Default constructor. Sorts by SORT_CommonName in ascending order.

Method Detail
getRoleId()
public String getRoleId()

Retrieves the role identifier.

Returns
The role identifier.
setRoleId() 
public void setRoleId(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.

Constant Detail
DOMAIN_STATUS_CURRENTConstant
public static final DOMAIN_STATUS_CURRENT

Current (active) domain.

DOMAIN_STATUS_FIELDConstant 
public static final DOMAIN_STATUS_FIELD

Domain status.

FLD_SPC_PRINCIPAL_COMMON_NAMEConstant 
public static final FLD_SPC_PRINCIPAL_COMMON_NAME

Principal common name.

FLD_SPC_PRINCIPAL_EMAILConstant 
public static final FLD_SPC_PRINCIPAL_EMAIL

Principal email identifier.

FLD_SPC_PRINCIPAL_ORGConstant 
public static final FLD_SPC_PRINCIPAL_ORG

Principal organization.

PRINCIPAL_STATUS_CURRENTConstant 
public static final PRINCIPAL_STATUS_CURRENT

Current (active) principal.

PRINCIPAL_STATUS_FIELDConstant 
public static final PRINCIPAL_STATUS_FIELD

Principal status.

SORT_CommonNameConstant 
public static final SORT_CommonName

Sort according to the common name.




© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Wed Oct 1 2008, 10:46 PM -04:00

 

Send me an e-mail when comments are added to this page | Comment Report

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