| Package | com.adobe.idp.um.api.infomodel |
| Class | public class RoleSearchFilter |
| Inheritance | RoleSearchFilter  GenericSearchFilter |
AND-ed together. For more information on sorting or specifying the number of results, see GenericSearchFilter.| Method | Defined By | ||
|---|---|---|---|
Default constructor. | RoleSearchFilter | ||
String getRelAppName() Sets the reliant application name for which the role is being defined. | RoleSearchFilter | ||
 | int getResultsMax() Retrieves the maximum number of results. | ||
| int getResultsOffset() Retrieves the offset index. | ||
String getRoleId() Retrieves the role identifier. | RoleSearchFilter | ||
String getRoleName() Retrieves the role name. | RoleSearchFilter | ||
String getRoleType() Retrieves the role type search scope. | RoleSearchFilter | ||
| 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. | ||
| boolean isSearch(Object searchKey) For internal use only. | ||
| boolean isSortAscending() Determines whether the sorting results will occur in ascending order. | ||
void setRelAppName(String relAppName) Sets the reliant application name. | RoleSearchFilter | ||
| void setResultsMax(int resultsMax) Sets the total number of desired results. | ||
| void setResultsOffset(int resultsOffset) Sets the offset index. | ||
void setRoleId(String roleIdFrag) Perform a wildcard search on a role identifier (or canonical name). | RoleSearchFilter | ||
void setRoleName(String roleName) Perform a wildcard search on the previously localized role name (common name). | RoleSearchFilter | ||
void setRoleType(String roleType) Sets the role type search scope. | RoleSearchFilter | ||
| 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 setSpecificRoleId(String roleId) Restrict search results based on a specific role identifier (or canonical name). | RoleSearchFilter | ||
| Constant | Defined By | ||
|---|---|---|---|
| CANNONICAL_NAME [static] Search according to the canonical name. | RoleSearchFilter | ||
| COMMON_NAME [static] Search according to the common name. | RoleSearchFilter | ||
| MUTABLE [static] Search according to whether the role is mutable. | RoleSearchFilter | ||
| ROLE_TYPE_ALL [static] Search according to all role types. | RoleSearchFilter | ||
| ROLE_TYPE_IMMUTABLE [static] Search according to an immutable role type. | RoleSearchFilter | ||
| ROLE_TYPE_MUTABLE [static] Search according to a mutable role type. | RoleSearchFilter | ||
| SORT_Mutable [static] Sort according to whether the role is mutable. | RoleSearchFilter | ||
| SORT_RoleId [static] Sort according to the canonical name. | RoleSearchFilter | ||
| SORT_RoleName [static] Sort according to the common name. | RoleSearchFilter | ||
| RoleSearchFilter | () |
Hide Inherited Public Methods
Show Inherited Public Methodspublic RoleSearchFilter()Default constructor. Sorts by SORT_RoleName in ascending order.
| getRelAppName | () |
public String getRelAppName()Sets the reliant application name for which the role is being defined.
Returns| The reliant application name. |
| getRoleId | () |
public String getRoleId()Retrieves the role identifier.
Returns| The role identifier. |
| getRoleName | () |
public String getRoleName()Retrieves the role name.
Returns| The role name. |
| getRoleType | () |
public String getRoleType()Retrieves the role type search scope.
Returns| The role type search scope. |
| setRelAppName | () |
public void setRelAppName(String relAppName)Sets the reliant application name.
Parameters
relAppName — The reliant application name. |
| setRoleId | () |
public void setRoleId(String roleIdFrag)Perform a wildcard search on a role identifier (or canonical name).
Parameters
roleIdFrag — The role name fragment on which to search for the role identifier. |
roleIdFrag = "UMFGACTest_" will match "UMFGACTest_ROLE_1137665264546".| setRoleName | () |
public void setRoleName(String roleName)Perform a wildcard search on the previously localized role name (common name).
Parameters
roleName — The wildcard characters on which to search for the previously localized role name. |
roleName = "dmin" will match "Administrator Role".| setRoleType | () |
public void setRoleType(String roleType)Sets the role type search scope.
Parameters
roleType — The role type search scope. |
ROLE_TYPE_MUTABLE, ROLE_TYPE_IMMUTABLE, ROLE_TYPE_ALL| setSpecificRoleId | () |
public void setSpecificRoleId(String roleId)Restrict search results based on a specific role identifier (or canonical name).
Parameters
roleId — The specific role identifier. |
| CANNONICAL_NAME | Constant |
public static final CANNONICAL_NAMESearch according to the canonical name.
| COMMON_NAME | Constant |
public static final COMMON_NAMESearch according to the common name.
| MUTABLE | Constant |
public static final MUTABLESearch according to whether the role is mutable.
| ROLE_TYPE_ALL | Constant |
public static final ROLE_TYPE_ALLSearch according to all role types.
| ROLE_TYPE_IMMUTABLE | Constant |
public static final ROLE_TYPE_IMMUTABLESearch according to an immutable role type.
| ROLE_TYPE_MUTABLE | Constant |
public static final ROLE_TYPE_MUTABLESearch according to a mutable role type.
| SORT_Mutable | Constant |
public static final SORT_MutableSort according to whether the role is mutable.
| SORT_RoleId | Constant |
public static final SORT_RoleIdSort according to the canonical name.
| SORT_RoleName | Constant |
public static final SORT_RoleNameSort according to the common name.
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/RoleSearchFilter.html