org.kuali.kpme.core.service.role

Interface KPMERoleService

All Known Implementing Classes:

KPMERoleServiceImpl

public interface KPMERoleService

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getDepartmentsForPrincipalInRole(String principalId, String namespaceCode, String roleName, org.joda.time.DateTime asOfDate, boolean isActiveOnly) Gets the departments for the given principalId in the role roleName.
List<String>	getDepartmentsForPrincipalInRoles(String principalId, List<String> roleIds, org.joda.time.DateTime asOfDate, boolean activeOnly) Gets the departments for the given principalId in the roles roleIds.
List<String>	getLocationsForPrincipalInRole(String principalId, String namespaceCode, String roleName, org.joda.time.DateTime asOfDate, boolean isActiveOnly) Gets the locations for the given principalId in the role roleName.
List<String>	getLocationsForPrincipalInRoles(String principalId, List<String> roleIds, org.joda.time.DateTime asOfDate, boolean activeOnly) Gets the locations for the given principalId in the roles roleIds.
List<org.kuali.rice.kim.api.role.RoleMember>	getPrimaryRoleMembersInWorkArea(String namespaceCode, String roleName, Long workArea, org.joda.time.DateTime asOfDate, boolean isActiveOnly) Gets the primary (first-level) members of the role roleName for the given work area.
List<org.kuali.rice.kim.api.role.RoleMember>	getRoleMembers(String namespaceCode, String roleName, org.joda.time.DateTime asOfDate, boolean activeOnly) Gets the members of the role roleName.
List<org.kuali.rice.kim.api.role.RoleMember>	getRoleMembers(String namespaceCode, String roleName, Map<String,String> qualification, org.joda.time.DateTime asOfDate, boolean activeOnly) Gets the members of the role roleName for the given role qualifiers.
List<org.kuali.rice.kim.api.role.RoleMember>	getRoleMembersInDepartment(String namespaceCode, String roleName, String department, String groupKeyCode, org.joda.time.DateTime asOfDate, boolean activeOnly) Gets the members of the role roleName for the given department.
List<org.kuali.rice.kim.api.role.RoleMember>	getRoleMembersInLocation(String namespaceCode, String roleName, String location, org.joda.time.DateTime asOfDate, boolean activeOnly) Gets the members of the role roleName for the given location.
List<org.kuali.rice.kim.api.role.RoleMember>	getRoleMembersInWorkArea(String namespaceCode, String roleName, Long workArea, org.joda.time.DateTime asOfDate, boolean activeOnly) Gets the members of the role roleName for the given work area.
List<Long>	getWorkAreasForPrincipalInRole(String principalId, String namespaceCode, String roleName, org.joda.time.DateTime asOfDate, boolean activeOnly) Gets the work areas for the given principalId in the role roleName.
List<Long>	getWorkAreasForPrincipalInRoles(String principalId, List<String> roleIds, org.joda.time.DateTime asOfDate, boolean activeOnly) Gets the work areas for the given principalId in the role roleName.
boolean	principalHasRole(String principalId, String namespaceCode, String roleName, org.joda.time.DateTime asOfDate) Checks whether the given principalId has the role roleName.
boolean	principalHasRole(String principalId, String namespaceCode, String roleName, Map<String,String> qualification, org.joda.time.DateTime asOfDate) Checks whether the given principalId has the role roleName depending on the given role qualifications.
boolean	principalHasRoleInDepartment(String principalId, String namespaceCode, String roleName, String department, String groupKeyCode, org.joda.time.DateTime asOfDate) Checks whether the given principalId has the role roleName depending on the given department.
boolean	principalHasRoleInLocation(String principalId, String namespaceCode, String roleName, String location, org.joda.time.DateTime asOfDate) Checks whether the given principalId has the role roleName depending on the given location.
boolean	principalHasRoleInWorkArea(String principalId, String namespaceCode, String roleName, Long workArea, org.joda.time.DateTime asOfDate) Checks whether the given principalId has the role roleName depending on the given work area.

Method Detail

principalHasRole

@Cacheable(value="http://rice.kuali.org/kim/v2_0/RoleMemberType",
           key="\'{principalHasRole}\' + \'principal=\' + #p0 + \'|\' + \'namespace=\' + #p1 + \'|\' + \'roleName=\' + #p2  + \'|\' + \'asOfDate=\' + #p3")
boolean principalHasRole(String principalId,
                                 String namespaceCode,
                                 String roleName,
                                 org.joda.time.DateTime asOfDate)

Checks whether the given principalId has the role roleName.

Parameters:

principalId - The person to check the role for

namespaceCode - The namespace of the role

roleName - The name of the role

asOfDate - The effective date of the role

Returns:

true if principalId has the role roleName, false otherwise.

principalHasRole

@Cacheable(value="http://rice.kuali.org/kim/v2_0/RoleMemberType",
           key="\'{principalHasRole}\' + \'principal=\' + #p0 + \'|\' + \'namespace=\' + #p1 + \'|\' + \'roleName=\' + #p2 + \'|\' + \'qualification=\' + T(org.kuali.rice.core.api.cache.CacheKeyUtils).mapKey(#p3)  + \'|\' + \'asOfDate=\' + #p4")
boolean principalHasRole(String principalId,
                                 String namespaceCode,
                                 String roleName,
                                 Map<String,String> qualification,
                                 org.joda.time.DateTime asOfDate)

Checks whether the given principalId has the role roleName depending on the given role qualifications.

Parameters:

principalId - The person to check the role for

namespaceCode - The namespace of the role

roleName - The name of the role

qualification - The map of role qualifiers for the person

asOfDate - The effective date of the role

Returns:

true if principalId has the role roleName, false otherwise.

principalHasRoleInWorkArea

@Cacheable(value="http://rice.kuali.org/kim/v2_0/RoleMemberType",
           key="\'{principalHasRoleInWorkArea}\' + \'principal=\' + #p0 + \'|\' + \'namespace=\' + #p1 + \'|\' + \'roleName=\' + #p2  + \'|\' + \'workArea=\' + #p3 + \'|\' + \'asOfDate=\' + #p4")
boolean principalHasRoleInWorkArea(String principalId,
                                           String namespaceCode,
                                           String roleName,
                                           Long workArea,
                                           org.joda.time.DateTime asOfDate)

Checks whether the given principalId has the role roleName depending on the given work area.

Parameters:

principalId - The person to check the role for

namespaceCode - The namespace of the role

roleName - The name of the role

workArea - The work area qualifier

asOfDate - The effective date of the role

Returns:

true if principalId has the role roleName for the given work area, false otherwise.

principalHasRoleInDepartment

@Cacheable(value="http://rice.kuali.org/kim/v2_0/RoleMemberType",
           key="\'{principalHasRoleInDepartment}\' + \'principal=\' + #p0 + \'|\' + \'namespace=\' + #p1 + \'|\' + \'roleName=\' + #p2  + \'|\' + \'department=\' + #p3 + \'|\' + \'groupKeyCode=\' + #p4 + \'|\' +\'asOfDate=\' + #p5")
boolean principalHasRoleInDepartment(String principalId,
                                             String namespaceCode,
                                             String roleName,
                                             String department,
                                             String groupKeyCode,
                                             org.joda.time.DateTime asOfDate)

Checks whether the given principalId has the role roleName depending on the given department.

Parameters:

principalId - The person to check the role for

namespaceCode - The namespace of the role

roleName - The name of the role

department - The department qualifier

groupKeyCode - The group key code qualifier

asOfDate - The effective date of the role

Returns:

true if principalId has the role roleName for the given department, false otherwise.

principalHasRoleInLocation

@Cacheable(value="http://rice.kuali.org/kim/v2_0/RoleMemberType",
           key="\'{principalHasRoleInLocation}\' + \'principal=\' + #p0 + \'|\' + \'namespace=\' + #p1 + \'|\' + \'roleName=\' + #p2  + \'|\' + \'location=\' + #p3 + \'|\' + \'asOfDate=\' + #p4")
boolean principalHasRoleInLocation(String principalId,
                                           String namespaceCode,
                                           String roleName,
                                           String location,
                                           org.joda.time.DateTime asOfDate)

Checks whether the given principalId has the role roleName depending on the given location.

Parameters:

principalId - The person to check the role for

namespaceCode - The namespace of the role

roleName - The name of the role

location - The location qualifier

asOfDate - The effective date of the role

Returns:

true if principalId has the role roleName for the given location, false otherwise.

getRoleMembers

List<org.kuali.rice.kim.api.role.RoleMember> getRoleMembers(String namespaceCode,
                                                          String roleName,
                                                          org.joda.time.DateTime asOfDate,
                                                          boolean activeOnly)

Gets the members of the role roleName.

Parameters:

namespaceCode - The namespace of the role

roleName - The name of the role

asOfDate - The effective date of the role

activeOnly - Whether or not to get only active role members

Returns:

the list of role members in the role roleName.

getRoleMembers

List<org.kuali.rice.kim.api.role.RoleMember> getRoleMembers(String namespaceCode,
                                                          String roleName,
                                                          Map<String,String> qualification,
                                                          org.joda.time.DateTime asOfDate,
                                                          boolean activeOnly)

Gets the members of the role roleName for the given role qualifiers.

Parameters:

namespaceCode - The namespace of the role

roleName - The name of the role

qualification - The map of role qualifiers

asOfDate - The effective date of the role

activeOnly - Whether or not to get only active role members

Returns:

the list of role members in the role roleName.

getRoleMembersInWorkArea

@Cacheable(value="http://rice.kuali.org/kim/v2_0/RoleMemberType",
           key="\'{getRoleMembersInWorkArea}\' + \'namespaceCode=\' + #p0 + \'|\' + \'roleName=\' + #p1 + \'|\' + \'workArea=\' + #p2  + \'|\' + \'asOfDate=\' + T(org.kuali.kpme.core.api.cache.KpmeCacheKeyUtils).dateTimeAtStartOfDate(#p3) + \'|\' + \'activeOnly=\' + #p4")
List<org.kuali.rice.kim.api.role.RoleMember> getRoleMembersInWorkArea(String namespaceCode,
                                                                              String roleName,
                                                                              Long workArea,
                                                                              org.joda.time.DateTime asOfDate,
                                                                              boolean activeOnly)

Gets the members of the role roleName for the given work area.

Parameters:

namespaceCode - The namespace of the role

roleName - The name of the role

workArea - The work area qualifier

asOfDate - The effective date of the role

activeOnly - Whether or not to get only active role members

Returns:

the list of role members in the role roleName for the given work area.

getRoleMembersInDepartment

List<org.kuali.rice.kim.api.role.RoleMember> getRoleMembersInDepartment(String namespaceCode,
                                                                      String roleName,
                                                                      String department,
                                                                      String groupKeyCode,
                                                                      org.joda.time.DateTime asOfDate,
                                                                      boolean activeOnly)

Gets the members of the role roleName for the given department.

Parameters:

namespaceCode - The namespace of the role

roleName - The name of the role

department - The department qualifier

groupKeyCode - The group key code qualifier

asOfDate - The effective date of the role

activeOnly - Whether or not to get only active role members

Returns:

the list of role members in the role roleName for the given department.

getRoleMembersInLocation

List<org.kuali.rice.kim.api.role.RoleMember> getRoleMembersInLocation(String namespaceCode,
                                                                    String roleName,
                                                                    String location,
                                                                    org.joda.time.DateTime asOfDate,
                                                                    boolean activeOnly)

Gets the members of the role roleName for the given location.

Parameters:

namespaceCode - The namespace of the role

roleName - The name of the role

location - The location qualifier

asOfDate - The effective date of the role

activeOnly - Whether or not to get only active role members

Returns:

the list of role members in the role roleName for the given location.

getWorkAreasForPrincipalInRole

@Cacheable(value="http://rice.kuali.org/kim/v2_0/RoleMemberType",
           key="\'{getWorkAreasForPrincipalInRole}\' + \'principal=\' + #p0 + \'|\' + \'namespace=\' + #p1 + \'|\' + \'roleName=\' + #p2  + \'|\' + \'asOfDate=\' + #p3 + \'|\' + \'activeOnly=\' + #p4")
List<Long> getWorkAreasForPrincipalInRole(String principalId,
                                                  String namespaceCode,
                                                  String roleName,
                                                  org.joda.time.DateTime asOfDate,
                                                  boolean activeOnly)

Gets the work areas for the given principalId in the role roleName.

Parameters:

principalId - The person to check the role for

namespaceCode - The namespace of the role

roleName - The name of the role

asOfDate - The effective date of the role

activeOnly - Whether or not to get only active role members

Returns:

the list of work areas for the given principalId in the role roleName.

getWorkAreasForPrincipalInRoles

@Cacheable(value="http://rice.kuali.org/kim/v2_0/RoleMemberType",
           key="\'{getWorkAreasForPrincipalInRoles}\' + \'principal=\' + #p0 + \'|\' + \'roleIds=\' + T(org.kuali.rice.core.api.cache.CacheKeyUtils).key(#p1) + \'|\' + \'asOfDate=\' + #p3 + \'|\' + \'activeOnly=\' + #p4")
List<Long> getWorkAreasForPrincipalInRoles(String principalId,
                                                   List<String> roleIds,
                                                   org.joda.time.DateTime asOfDate,
                                                   boolean activeOnly)

Gets the work areas for the given principalId in the role roleName.

Parameters:

principalId - The person to check the role for

roleIds - The list of roleIds

asOfDate - The effective date of the role

activeOnly - Whether or not to get only active role members

Returns:

the list of work areas for the given principalId in the role roleName.

getDepartmentsForPrincipalInRoles

@Cacheable(value="http://rice.kuali.org/kim/v2_0/RoleMemberType",
           key="\'{getDepartmentsForPrincipalInRoles}\' + \'principal=\' + #p0 + \'|\' + \'roleIds=\' + T(org.kuali.rice.core.api.cache.CacheKeyUtils).key(#p1) + \'|\' + \'asOfDate=\' + #p3 + \'|\' + \'activeOnly=\' + #p4")
List<String> getDepartmentsForPrincipalInRoles(String principalId,
                                                       List<String> roleIds,
                                                       org.joda.time.DateTime asOfDate,
                                                       boolean activeOnly)

Gets the departments for the given principalId in the roles roleIds.

Parameters:

principalId - The person to check the role for

roleIds - The list of roleIds

asOfDate - The effective date of the role

activeOnly - Whether or not to get only active role members

Returns:

the list of work areas for the given principalId in the roles roleIds.

getLocationsForPrincipalInRoles

@Cacheable(value="http://rice.kuali.org/kim/v2_0/RoleMemberType",
           key="\'{getLocationsForPrincipalInRoles}\' + \'principal=\' + #p0 + \'|\' + \'roleIds=\' + T(org.kuali.rice.core.api.cache.CacheKeyUtils).key(#p1) + \'|\' + \'asOfDate=\' + #p3 + \'|\' + \'activeOnly=\' + #p4")
List<String> getLocationsForPrincipalInRoles(String principalId,
                                                     List<String> roleIds,
                                                     org.joda.time.DateTime asOfDate,
                                                     boolean activeOnly)

Gets the locations for the given principalId in the roles roleIds.

Parameters:

principalId - The person to check the role for

roleIds - The list of roleIds

asOfDate - The effective date of the role

activeOnly - Whether or not to get only active role members

Returns:

the list of work areas for the given principalId in the roles roleIds.

getDepartmentsForPrincipalInRole

@Cacheable(value="http://rice.kuali.org/kim/v2_0/RoleMemberType",
           key="\'{getDepartmentsForPrincipalInRole}\' + \'principal=\' + #p0 + \'|\' + \'namespace=\' + #p1 + \'|\' + \'roleName=\' + #p2  + \'|\' + \'asOfDate=\' + #p3 + \'|\' + \'isActiveOnly=\' + #p4")
List<String> getDepartmentsForPrincipalInRole(String principalId,
                                                      String namespaceCode,
                                                      String roleName,
                                                      org.joda.time.DateTime asOfDate,
                                                      boolean isActiveOnly)

Gets the departments for the given principalId in the role roleName.

Parameters:

principalId - The person to check the role for

namespaceCode - The namespace of the role

roleName - The name of the role

asOfDate - The effective date of the role

isActiveOnly - Whether or not to get only active role members

Returns:

the list of groupKeyCode and department values delimited by '|' for the given principalId in the role roleName.

getLocationsForPrincipalInRole

@Cacheable(value="http://rice.kuali.org/kim/v2_0/RoleMemberType",
           key="\'{getLocationsForPrincipalInRole}\' + \'principal=\' + #p0 + \'|\' + \'namespace=\' + #p1 + \'|\' + \'roleName=\' + #p2  + \'|\' + \'asOfDate=\' + #p3 + \'|\' + \'isActiveOnly=\' + #p4")
List<String> getLocationsForPrincipalInRole(String principalId,
                                                    String namespaceCode,
                                                    String roleName,
                                                    org.joda.time.DateTime asOfDate,
                                                    boolean isActiveOnly)

Gets the locations for the given principalId in the role roleName.

Parameters:

principalId - The person to check the role for

namespaceCode - The namespace of the role

roleName - The name of the role

asOfDate - The effective date of the role

isActiveOnly - Whether or not to get only active role members

Returns:

the list of locations for the given principalId in the role roleName.

getPrimaryRoleMembersInWorkArea

List<org.kuali.rice.kim.api.role.RoleMember> getPrimaryRoleMembersInWorkArea(String namespaceCode,
                                                                           String roleName,
                                                                           Long workArea,
                                                                           org.joda.time.DateTime asOfDate,
                                                                           boolean isActiveOnly)

Gets the primary (first-level) members of the role roleName for the given work area.

Parameters:

namespaceCode - The namespace of the role

roleName - The name of the role

workArea - The work area qualifier

asOfDate - The effective date of the role

isActiveOnly - Whether or not to get only active role members

Returns:

the list of role members in the role roleName for the given work area.