001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.ken.core;
017
018import org.kuali.rice.core.framework.persistence.dao.GenericDao;
019import org.kuali.rice.ken.api.service.KENAPIService;
020import org.kuali.rice.ken.service.NotificationAuthorizationService;
021import org.kuali.rice.ken.service.NotificationChannelService;
022import org.kuali.rice.ken.service.NotificationContentTypeService;
023import org.kuali.rice.ken.service.NotificationMessageContentService;
024import org.kuali.rice.ken.service.NotificationMessageDeliveryAutoRemovalService;
025import org.kuali.rice.ken.service.NotificationMessageDeliveryResolverService;
026import org.kuali.rice.ken.service.NotificationMessageDeliveryService;
027import org.kuali.rice.ken.service.NotificationRecipientService;
028import org.kuali.rice.ken.service.NotificationService;
029import org.kuali.rice.ken.service.NotificationWorkflowDocumentService;
030import org.kuali.rice.ken.service.UserPreferenceService;
031import org.quartz.Scheduler;
032
033/**
034 * Interface for obtaining Notification System services
035 * @author Kuali Rice Team (rice.collab@kuali.org)
036 */
037public interface NotificationServiceLocator {
038    /**
039     * This method returns an instance of the Spring configured impl for the KENAPIService.
040     * @return KENAPIService
041     */
042    public KENAPIService getKENAPIService();
043
044    /**
045     * This method returns an instance of the Spring configured impl for the NotificationService.
046     * @return NotificationService
047     */
048    public NotificationService getNotificationService();
049
050    /**
051     * This method returns an instance of the Spring configured impl for the NotificationContentTypeService.
052     * @return NotificationContentTypeService
053     */
054    public NotificationContentTypeService getNotificationContentTypeService();
055
056    /**
057     * This method returns an instance of the Spring configured impl for the NotificationMessageContentService.
058     * @return NotificationMessageContentService
059     */
060    public NotificationMessageContentService getNotificationMessageContentService();
061    
062    /**
063     * This method returns an instance of the Spring configured impl for the BusinessObjectDao.
064     * @return GenericDao
065     */
066    public GenericDao getGenericDao();
067    
068    /**
069     * This method returns an instance of the Spring configured impl for the NotificationAuthorizationService.
070     * @return NotificationAuthorizationService
071     */
072    public NotificationAuthorizationService getNotificationAuthorizationService();
073    
074    /**
075     * This method returns an instance of the Spring configured impl for the NotificationWorkflowDocumentService.
076     * @return NotificationWorkflowDocumentService
077     */
078    public NotificationWorkflowDocumentService getNotificationWorkflowDocumentService();
079    
080    /**
081     * This method returns an instance of the Spring configured impl for the NotificationMessageDeliveryAutoRemovalService.
082     * @return NotificationMessageDeliveryAutoRemovalService
083     */
084    public NotificationMessageDeliveryAutoRemovalService getNotificationMessageDeliveryAutoRemovalService();
085
086    /**
087     * This method returns an instance of the Spring configured impl for the getNotificationMessageDeliveryResolverService.
088     * @return NotificationMessageDeliveryResolverService
089     */
090    public NotificationMessageDeliveryResolverService getNotificationMessageDeliveryResolverService();
091    
092    /**
093     * This method returns an instance of the Spring configured impl for the NotificationRecipientService.
094     * @return NotificationRecipientService
095     */
096    public NotificationRecipientService getNotificationRecipientService();
097    
098    /**
099     * This method returns an instance of the Spring configured impl for the NotificationMessageDeliveryService.
100     * @return NotificationMessageDeliveryService
101     */
102    public NotificationMessageDeliveryService getNotificationMessageDeliveryService();
103    
104    /**
105     * This method returns an instance of the Spring configured impl for the UserPreferenceService.
106     * @return UserPreferenceService
107     */
108    public UserPreferenceService getUserPreferenceService();
109    
110    /**
111     * This method returns an instance of the Spring configured impl for the NotificationChannelService.
112     * @return NotificationChannelService
113     */
114    public NotificationChannelService getNotificationChannelService();
115    
116    /**
117     * Returns the Quartz scheduler used by the Notification system
118     * @return the Quartz scheduler used by the Notification system
119     */
120    public Scheduler getScheduler();
121}