Package org.kuali.rice.ken.api.service

Interface KENAPIService

public interface KENAPIService
KEN API service internal to Rice, for use by KCB
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Details

    • getAllChannelNames

      Collection<String> getAllChannelNames()
      Returns names of all channels defined in KEN
      Returns:
      names of all channels defined in KEN

    • getDeliverersForRecipientAndChannel

      Collection<String> getDeliverersForRecipientAndChannel(String recipient, String channel) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Returns the names of all deliverers the recipient has configured for a given channel
      Returns:
      the names of all deliverers the recipient has configured for a given channel
      Throws:
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the recipient, channel is null or blank.

    • getRecipientPreference

      String getRecipientPreference(String recipient, String prefKey) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Returns the specified recipient preference for the user
      Parameters:
      recipient - the recipient
      prefKey - the preference key
      Returns:
      the specified recipient preference for the user
      Throws:
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the recipient, prefKey is null or blank