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

java.lang.Object
  com.adobe.idp.um.api.infomodel.GenericSearchFilter
      com.adobe.idp.um.api.infomodel.PermissionSearchFilter

All Implemented Interfaces:

java.io.Serializable

public class PermissionSearchFilter
extends GenericSearchFilter
implements java.io.Serializable

This filter allows you specify permissions 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	SEARCH_PERM_NAME Search by permission name and sorts by PermissionSearchFilter.SORT_PermissionOverResType in ascending order.
static java.lang.String	SEARCH_RES_TYPE_ID Search by resource type identifier and sorts by PermissionSearchFilter.SORT_PermissionOverResType in ascending order.
static java.lang.Object	SORT_PermissionName This is used to sort the results based upon the common name.
static java.lang.Object	SORT_PermissionOverResType This is used to sort the results based upon the resource type.

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

PermissionSearchFilter()
Default constructor.

Method Summary

java.lang.String	getPermissionName() Retrieves the permission name.
java.lang.String	getResTypeID() Retrieves the resource type identifier.
java.lang.String	getSpecificPermissionName() Retrieves the specific permission name.
void	setPermissionName(java.lang.String permName) Sets the permission name.
void	setSpecificPermissionName(java.lang.String permName) Sets the specific permission name.
void	setSpecificResTypeId(java.lang.String resTypeId) Sets the specific resource type identifier.

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

SEARCH_PERM_NAME

public static final java.lang.String SEARCH_PERM_NAME

Search by permission name and sorts by PermissionSearchFilter.SORT_PermissionOverResType in ascending order.

See Also:

Constant Field Values

SEARCH_RES_TYPE_ID

public static final java.lang.String SEARCH_RES_TYPE_ID

Search by resource type identifier and sorts by PermissionSearchFilter.SORT_PermissionOverResType in ascending order.

See Also:

Constant Field Values

SORT_PermissionName

public static final java.lang.Object SORT_PermissionName

This is used to sort the results based upon the common name. For example, "Copy Permission".

SORT_PermissionOverResType

public static final java.lang.Object SORT_PermissionOverResType

This is used to sort the results based upon the resource type.

Constructor Detail

PermissionSearchFilter

public PermissionSearchFilter()

Default constructor.

Method Detail

setPermissionName

public void setPermissionName(java.lang.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(java.lang.String permName)

Sets the specific permission name. This is used to restrict results to a specific permission identifier.

Parameters:

permName - The specific permission name.

getPermissionName

public java.lang.String getPermissionName()

Retrieves the permission name.

Returns:

The permission name.

getSpecificPermissionName

public java.lang.String getSpecificPermissionName()

Retrieves the specific permission name.

Returns:

The specific permission name.

setSpecificResTypeId

public void setSpecificResTypeId(java.lang.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.

getResTypeID

public java.lang.String getResTypeID()

Retrieves the resource type identifier.

Returns:

The resource type identifier.