org.kuali.kra.service

Interface UnitAuthorizationService

All Known Implementing Classes:

UnitAuthorizationServiceImpl

public interface UnitAuthorizationService

The Unit Authorization Service handles users and their permissions within units.

Author:

Kuali Research Administration Team (kualidev@oncourse.iu.edu)

Method Summary

Methods

Modifier and Type	Method and Description
List<Unit>	getUnits(String userId, String namespaceCode, String permissionName) Get the units that the user has the given permission in.
boolean	hasMatchingQualifiedUnits(String userId, String namespaceCode, String permissionName, String unitNumber)
boolean	hasPermission(String userId, String namespaceCode, String permissionName) Does the user have the given permission? If the user has the permission in the global space, this method will return true.
boolean	hasPermission(String userId, String unitNumber, String namespaceCode, String permissionName) Does the user have the given permission in the specified unit? Along with checking the specific unit, if the user has the permission in the global space, this method will also return true.

Method Detail

hasPermission

boolean hasPermission(String userId,
                    String namespaceCode,
                    String permissionName)

Does the user have the given permission? If the user has the permission in the global space, this method will return true. Likewise, true will be returned in the user has this permission in any qualified role.

Parameters:

username - the user's username

permissionName - the name of the permission

Returns:

true if the user has permission; otherwise false

hasPermission

boolean hasPermission(String userId,
                    String unitNumber,
                    String namespaceCode,
                    String permissionName)

Does the user have the given permission in the specified unit? Along with checking the specific unit, if the user has the permission in the global space, this method will also return true.

Parameters:

username - the user's username

unitNumber - the Unit's unique number

permissionName - the name of the permission

Returns:

true if the user has permission; otherwise false

getUnits

List<Unit> getUnits(String userId,
                  String namespaceCode,
                  String permissionName)

Get the units that the user has the given permission in. If the user has the permission in the global space, all of the units will be returned. If the user doesn't have permission in any unit, an empty list is returned.

Parameters:

username - the user's username

permissionName - the name of the permission

Returns:

the list of units the user has this permission in

hasMatchingQualifiedUnits

boolean hasMatchingQualifiedUnits(String userId,
                                String namespaceCode,
                                String permissionName,
                                String unitNumber)