001    /**
002     * Copyright 2005-2012 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     */
016    package org.kuali.rice.ken.deliverer;
017    
018    import java.util.Collection;
019    
020    import org.kuali.rice.ken.bo.NotificationMessageDelivery;
021    import org.kuali.rice.ken.exception.NotificationAutoRemoveException;
022    import org.kuali.rice.ken.exception.NotificationMessageDeliveryException;
023    
024    /**
025     * A NotificationMessageDeliverer interface specialization that should be implemented
026     * by deliverers which can deliver messages in bulk.  This interface needs to exist
027     * distinct from NotificationMessageDeliverer because processing in the two cases
028     * will be different.  In the bulk case, the deliveries will be performed in a single
029     * transaction.
030     * @author Kuali Rice Team (rice.collab@kuali.org)
031     */
032    public interface BulkNotificationMessageDeliverer extends NotificationMessageDeliverer {
033        /**
034         * This method is responsible for delivering a series of messageDelivery records
035         * @param messageDeliveries The messageDeliveries to process
036         * @throws NotificationMessageDeliveryException
037         */
038        public void deliverMessage(Collection<NotificationMessageDelivery> messageDeliveries) throws NotificationMessageDeliveryException;
039        
040        /**
041         * This method handles auto removing message deliveries
042         * @param messageDelivery The messageDeliveries to auto remove
043         * @throws NotificationAutoRemoveException
044         */
045        public void autoRemoveMessageDelivery(Collection<NotificationMessageDelivery> messageDeliveries) throws NotificationAutoRemoveException;
046    }