org.kuali.rice.ken.service

Interface NotificationRecipientService

All Known Implementing Classes:

NotificationRecipientServiceKimImpl

public interface NotificationRecipientService

The NotificationRecipientService class is responsible for housing user/group related services.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Modifier and Type	Method and Description
String[]	getGroupMembers(String groupRecipientId) This service method will retrieve all of the user recipients ids that belong to a group.
String	getUserDisplayName(String userId) This method retrieves the display name for a user.
boolean	isGroupRecipientValid(String groupRecipientId) This service method checks to make sure that the group recipient is a valid group in the system.
boolean	isRecipientValid(String recipientId, String recipientType) This method handles figuring out which recipient type that you are deling with and calls the appropriate validation method.
boolean	isUserRecipientValid(String userRecipientId) This service method checks to make sure that the user recipient is a valid user in the system.

Method Detail

isRecipientValid

boolean isRecipientValid(String recipientId,
                         String recipientType)

This method handles figuring out which recipient type that you are deling with and calls the appropriate validation method.

Parameters:

recipientId -

recipientType -

Returns:

boolean

isUserRecipientValid

boolean isUserRecipientValid(String userRecipientId)

This service method checks to make sure that the user recipient is a valid user in the system.

Parameters:

userRecipientId -

Returns:

boolean

isGroupRecipientValid

boolean isGroupRecipientValid(String groupRecipientId)

This service method checks to make sure that the group recipient is a valid group in the system.

Parameters:

groupRecipientId -

Returns:

boolean

getGroupMembers

String[] getGroupMembers(String groupRecipientId)

This service method will retrieve all of the user recipients ids that belong to a group.

Parameters:

groupRecipientId -

Returns:

A String array of user recipient ids that belong to the specified recipient group id.

getUserDisplayName

String getUserDisplayName(String userId)

This method retrieves the display name for a user.

Parameters:

userId -

Returns:

String