org.apereo.portal.permission.target

Interface IPermissionTargetProvider

All Known Implementing Classes:

EntityTargetProviderImpl, PortalDataTypeTargetProviderImpl, PortletTypeTargetProviderImpl, SimpleStringTargetProviderImpl, UserAttributesTargetProviderImpl

public interface IPermissionTargetProvider

IPermissionTargetProvider provides an interface for retrieving and validating potential targets for a permission activity.

Since:

3.3

Method Summary

Modifier and Type	Method and Description
org.apereo.portal.permission.target.IPermissionTarget	getTarget(java.lang.String key) Return the permission target associated with the specified key under this provider.
java.util.Collection<org.apereo.portal.permission.target.IPermissionTarget>	searchTargets(java.lang.String term) Search this provider for a particular target using a single string search term.

Method Detail

getTarget

org.apereo.portal.permission.target.IPermissionTarget getTarget(java.lang.String key)

Return the permission target associated with the specified key under this provider. If no target with the given key is valid for this provider, return null.

Parameters:

key -

Returns:

searchTargets

java.util.Collection<org.apereo.portal.permission.target.IPermissionTarget> searchTargets(java.lang.String term)

Search this provider for a particular target using a single string search term. Each target provider implementation is responsible for determining the definition a "matching" target.

Parameters:

term - search term

Returns:

collection of matching targets