| Package | com.adobe.idp.um.api.infomodel |
| Class | public class PermissionSearchFilter |
| Inheritance | PermissionSearchFilter  GenericSearchFilter |
AND-ed together. For more information on sorting or specifying the number of results, see GenericSearchFilter.| Method | Defined By | ||
|---|---|---|---|
Default constructor. | PermissionSearchFilter | ||
String getPermissionName() Retrieves the permission name. | PermissionSearchFilter | ||
String getResTypeID() Retrieves the resource type identifier. | PermissionSearchFilter | ||
 | int getResultsMax() Retrieves the maximum number of results. | ||
| int getResultsOffset() Retrieves the offset index. | ||
| 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. | ||
String getSpecificPermissionName() Retrieves the specific permission name. | PermissionSearchFilter | ||
| boolean isSearch(Object searchKey) For internal use only. | ||
| boolean isSortAscending() Determines whether the sorting results will occur in ascending order. | ||
void setPermissionName(String permName) Sets the permission name. | PermissionSearchFilter | ||
| void setResultsMax(int resultsMax) Sets the total number of desired results. | ||
| void setResultsOffset(int resultsOffset) Sets the offset index. | ||
| 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 setSpecificPermissionName(String permName) Sets the specific permission name. | PermissionSearchFilter | ||
void setSpecificResTypeId(String resTypeId) Sets the specific resource type identifier. | PermissionSearchFilter | ||
| Constant | Defined By | ||
|---|---|---|---|
| SEARCH_PERM_NAME [static] Search by permission name and sorts by #SORT_PermissionOverResType in ascending order. | PermissionSearchFilter | ||
| SEARCH_RES_TYPE_ID [static] Search by resource type identifier and sorts by #SORT_PermissionOverResType in ascending order. | PermissionSearchFilter | ||
| SORT_PermissionName [static] This is used to sort the results based upon the common name. | PermissionSearchFilter | ||
| SORT_PermissionOverResType [static] This is used to sort the results based upon the resource type. | PermissionSearchFilter | ||
| PermissionSearchFilter | () |
Hide Inherited Public Methods
Show Inherited Public Methodspublic PermissionSearchFilter()Default constructor.
| getPermissionName | () |
public String getPermissionName()Retrieves the permission name.
Returns| The permission name. |
| getResTypeID | () |
public String getResTypeID()Retrieves the resource type identifier.
Returns| The resource type identifier. |
| getSpecificPermissionName | () |
public String getSpecificPermissionName()Retrieves the specific permission name.
Returns| The specific permission name. |
| setPermissionName | () |
public void setPermissionName(String permName)Sets the permission name. This can be used for searching over system resource types.
Parameters
permName — The permission name. |
| setSpecificPermissionName | () |
public void setSpecificPermissionName(String permName)Sets the specific permission name. This is used to restrict results to a specific permission identifier.
Parameters
permName — The specific permission name. |
| setSpecificResTypeId | () |
public void setSpecificResTypeId(String resTypeId)Sets the specific resource type identifier. This is used to restrict results to a specific resource type identifier.
Parameters
resTypeId — The specific resource type identifier. |
| SEARCH_PERM_NAME | Constant |
public static final SEARCH_PERM_NAMESearch by permission name and sorts by SORT_PermissionOverResType in ascending order.
| SEARCH_RES_TYPE_ID | Constant |
public static final SEARCH_RES_TYPE_IDSearch by resource type identifier and sorts by SORT_PermissionOverResType in ascending order.
| SORT_PermissionName | Constant |
public static final SORT_PermissionNameThis is used to sort the results based upon the common name. For example, "Copy Permission".
| SORT_PermissionOverResType | Constant |
public static final SORT_PermissionOverResTypeThis is used to sort the results based upon the resource type.
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/PermissionSearchFilter.html