org.apereo.portal.permission.dao

Interface IPermissionOwnerDao

All Known Implementing Classes:

JpaPermissionOwnerDao

public interface IPermissionOwnerDao

IPermissionOwnerDao represents an interface for retrieving and persisting permission owners.

Since:

3.3

Method Summary

Modifier and Type	Method and Description
java.util.List<org.apereo.portal.permission.IPermissionOwner>	getAllPermissionOwners() Retrieve a list of all known permission owners from the data store.
org.apereo.portal.permission.IPermissionActivity	getOrCreatePermissionActivity(org.apereo.portal.permission.IPermissionOwner owner, java.lang.String name, java.lang.String fname, java.lang.String targetProviderKey) Retrieve the permission activity associated with the supplied functional name, under the specified permission owner.
org.apereo.portal.permission.IPermissionOwner	getOrCreatePermissionOwner(java.lang.String name, java.lang.String fname) Retrieve the permission owner associated with the supplied functional name.
org.apereo.portal.permission.IPermissionActivity	getPermissionActivity(long id) Retrieve a permission activity by unique ID.
org.apereo.portal.permission.IPermissionActivity	getPermissionActivity(long ownerId, java.lang.String activityFname) Retrieve a permission activity under the specified permission owner with the provided activity functional name.
org.apereo.portal.permission.IPermissionActivity	getPermissionActivity(java.lang.String ownerFname, java.lang.String activityFname) Retrieve a permission activity under the specified permission owner with the provided activity functional name.
org.apereo.portal.permission.IPermissionOwner	getPermissionOwner(long id) Retrieve the permission owner with the specified unique ID.
org.apereo.portal.permission.IPermissionOwner	getPermissionOwner(java.lang.String fname) Retrieve the permission owner with the specified functional name.
org.apereo.portal.permission.IPermissionOwner	saveOwner(org.apereo.portal.permission.IPermissionOwner owner) Persist a permission owner to the data layer, creating or updating the owner as appropriate.
org.apereo.portal.permission.IPermissionActivity	savePermissionActivity(org.apereo.portal.permission.IPermissionActivity activity) Persist a permission activity to the data layer, creating or updating the activity as appropriate.

Method Detail

getPermissionOwner

org.apereo.portal.permission.IPermissionOwner getPermissionOwner(long id)

Retrieve the permission owner with the specified unique ID.

Parameters:

id -

Returns:

getPermissionOwner

org.apereo.portal.permission.IPermissionOwner getPermissionOwner(java.lang.String fname)

Retrieve the permission owner with the specified functional name.

Parameters:

fname -

Returns:

getOrCreatePermissionOwner

org.apereo.portal.permission.IPermissionOwner getOrCreatePermissionOwner(java.lang.String name,
                                                                         java.lang.String fname)

Retrieve the permission owner associated with the supplied functional name. If no matching permission owner can be found, create a new permission owner instance with the supplied functional name. @Param name Name of the permission owner

Parameters:

fname - functional name of the desired permission owner

Returns:

getAllPermissionOwners

java.util.List<org.apereo.portal.permission.IPermissionOwner> getAllPermissionOwners()

Retrieve a list of all known permission owners from the data store.

Returns:

saveOwner

org.apereo.portal.permission.IPermissionOwner saveOwner(org.apereo.portal.permission.IPermissionOwner owner)

Persist a permission owner to the data layer, creating or updating the owner as appropriate.

Parameters:

owner -

Returns:

getPermissionActivity

org.apereo.portal.permission.IPermissionActivity getPermissionActivity(long id)

Retrieve a permission activity by unique ID.

Parameters:

id -

Returns:

getPermissionActivity

org.apereo.portal.permission.IPermissionActivity getPermissionActivity(long ownerId,
                                                                       java.lang.String activityFname)

Retrieve a permission activity under the specified permission owner with the provided activity functional name.

Parameters:

ownerId - unique ID of the desired activity's owner

activityFname - functional name of the desired activity

Returns:

getPermissionActivity

org.apereo.portal.permission.IPermissionActivity getPermissionActivity(java.lang.String ownerFname,
                                                                       java.lang.String activityFname)

Retrieve a permission activity under the specified permission owner with the provided activity functional name.

Parameters:

ownerFname - functional name of the desired activity's owner

activityFname - functional name of the activity itself

Returns:

getOrCreatePermissionActivity

org.apereo.portal.permission.IPermissionActivity getOrCreatePermissionActivity(org.apereo.portal.permission.IPermissionOwner owner,
                                                                               java.lang.String name,
                                                                               java.lang.String fname,
                                                                               java.lang.String targetProviderKey)

Retrieve the permission activity associated with the supplied functional name, under the specified permission owner. If no matching activity can be found, create a new permission activity instance with the supplied owner and activity functional name.

Parameters:

owner - permission owner

fname - activity fname

Returns:

savePermissionActivity

org.apereo.portal.permission.IPermissionActivity savePermissionActivity(org.apereo.portal.permission.IPermissionActivity activity)

Persist a permission activity to the data layer, creating or updating the activity as appropriate.

Parameters:

activity -

Returns: