org.kuali.kra.common.notification.service

Interface KcNotificationModuleRoleService

All Known Implementing Classes:

KcNotificationModuleRoleServiceImpl

public interface KcNotificationModuleRoleService

Method Summary

Methods

Modifier and Type	Method and Description
NotificationModuleRole	addNotificationModuleRole(String moduleCode, String roleName) This method allows you to add a relationship between a coeus module code and a role name.
List<NotificationModuleRole>	getNotificationModuleRoles(String moduleCode) This method retrieves all notification module roles for a given coeus module code.
List<NotificationModuleRole>	getNotificationModuleRolesForKimRole(String moduleCode, String roleName) This method retrieves all notification module roles for a given coeus module code and role name.
String	getNotificationModuleRolesString(String moduleCode) This method retrieves all notification module roles for a given coeus module code as a String.
void	saveNotificationModuleRoles(List<NotificationModuleRole> notificationModuleRoles) This method saves a list of notification module roles.

Method Detail

addNotificationModuleRole

NotificationModuleRole addNotificationModuleRole(String moduleCode,
                                               String roleName)

This method allows you to add a relationship between a coeus module code and a role name.

Parameters:

moduleCode - The module code as defined in the CoeusModule object

roleName - The KIM namespace and role name, combined with a semicolon, ie. namespace:rolename

Returns:

The newly created module role association

See Also:

CoeusModule

getNotificationModuleRoles

List<NotificationModuleRole> getNotificationModuleRoles(String moduleCode)

This method retrieves all notification module roles for a given coeus module code.

Parameters:

moduleCode - The module code as defined in the CoeusModule object

Returns:

The list of matching notification modules roles for the given code

See Also:

CoeusModule

getNotificationModuleRolesString

String getNotificationModuleRolesString(String moduleCode)

This method retrieves all notification module roles for a given coeus module code as a String.

Parameters:

moduleCode - The module code as defined in the CoeusModule object

Returns:

The String representation of the list of matching notification modules roles for the given code

See Also:

CoeusModule

getNotificationModuleRolesForKimRole

List<NotificationModuleRole> getNotificationModuleRolesForKimRole(String moduleCode,
                                                                String roleName)

This method retrieves all notification module roles for a given coeus module code and role name.

Parameters:

moduleCode - The module code as defined in the CoeusModule object

roleName - The KIM namespace and role name, combined with a semicolon, ie. namespace:rolename

Returns:

The list of matching notification modules roles for the given code and role name

See Also:

CoeusModule

saveNotificationModuleRoles

void saveNotificationModuleRoles(List<NotificationModuleRole> notificationModuleRoles)

This method saves a list of notification module roles.

Parameters:

notificationModuleRoles - The list of module roles to save