|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.idp.um.api.infomodel.GenericSearchFilter com.adobe.idp.um.api.infomodel.RoleSearchFilter
public class RoleSearchFilter
The RoleSearchFilter
class is a filter that allows you to specify role search criteria.
Using an instance of this type, you can search for roles assigned to LiveCycle ES2 users.
For more information on sorting or specifying the number of results, see GenericSearchFilter
.
To see an instance of this type used in a code example, see the Managing roles and permissions using the Java API quick start in Programming with LiveCycle ES4.
Field Summary | |
---|---|
static java.lang.String |
CANNONICAL_NAME
Search according to the canonical name. |
static java.lang.String |
COMMON_NAME
Search according to the common name. |
static java.lang.String |
MUTABLE
Search according to whether the role is mutable. |
static java.lang.String |
ROLE_TYPE_ALL
Search according to all role types. |
static java.lang.String |
ROLE_TYPE_IMMUTABLE
Search according to an immutable role type. |
static java.lang.String |
ROLE_TYPE_MUTABLE
Search according to a mutable role type. |
static java.lang.Object |
SORT_Mutable
Sort according to whether the role is mutable. |
static java.lang.Object |
SORT_RoleId
Sort according to the canonical name. |
static java.lang.Object |
SORT_RoleName
Sort according to the common name. |
Constructor Summary | |
---|---|
RoleSearchFilter()
The default constructor for RoleSearchFilter . |
Method Summary | |
---|---|
java.lang.String |
getRelAppName()
Sets the reliant application name for which the role is being defined. |
java.lang.String |
getRoleId()
Retrieves the role identifier. |
java.lang.String |
getRoleName()
Retrieves the role name. |
java.lang.String |
getRoleType()
Retrieves the role type search scope. |
void |
setRelAppName(java.lang.String relAppName)
Sets the reliant application name. |
void |
setRoleId(java.lang.String roleIdFrag)
Performs a wildcard search on a role identifier (or canonical name). |
void |
setRoleName(java.lang.String roleName)
Performs a wildcard search on the previously localized role name (common name). |
void |
setRoleType(java.lang.String roleType)
Sets the role type search scope. |
void |
setSpecificRoleId(java.lang.String roleId)
Restricts search results based on a specific role identifier (or canonical 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 |
---|
public static final java.lang.String ROLE_TYPE_MUTABLE
public static final java.lang.String ROLE_TYPE_IMMUTABLE
public static final java.lang.String ROLE_TYPE_ALL
public static final java.lang.String COMMON_NAME
public static final java.lang.String CANNONICAL_NAME
public static final java.lang.String MUTABLE
public static final java.lang.Object SORT_RoleId
public static final java.lang.Object SORT_RoleName
public static final java.lang.Object SORT_Mutable
Constructor Detail |
---|
public RoleSearchFilter()
RoleSearchFilter
.
Sorts by RoleSearchFilter.SORT_RoleName
in ascending order.
Method Detail |
---|
public void setRoleName(java.lang.String roleName)
roleName = dmin
matches Administrator Role
.
To see this method used in a code example, see
the Managing roles and permissions using the Java API quick start in
Programming with LiveCycle ES4.
roleName
- A string value that specifies the wildcard characters on which to search for the previously localized role name.public void setSpecificRoleId(java.lang.String roleId)
roleId
- A string value that specifies the specific role identifier.public void setRoleId(java.lang.String roleIdFrag)
roleIdFrag = UMFGACTest_
matches UMFGACTest_ROLE_1137665264546
.
roleIdFrag
- A string value that specifies the role name fragment on which to search for the role identifier.public void setRelAppName(java.lang.String relAppName)
relAppName
- A string value that specifies the reliant application name.public java.lang.String getRelAppName()
public void setRoleType(java.lang.String roleType)
ROLE_TYPE_MUTABLE
, ROLE_TYPE_IMMUTABLE
, and ROLE_TYPE_ALL
.
roleType
- A string value that specifies the role type search scope.public java.lang.String getRoleType()
public java.lang.String getRoleName()
public java.lang.String getRoleId()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |