001/**
002 * Copyright 2005-2018 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.api.service;
017
018import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;
019import org.kuali.rice.ken.api.KenApiConstants;
020import org.kuali.rice.ken.api.notification.Notification;
021import org.kuali.rice.ken.api.notification.NotificationResponse;
022
023import javax.jws.WebMethod;
024import javax.jws.WebParam;
025import javax.jws.WebResult;
026import javax.jws.WebService;
027import javax.jws.soap.SOAPBinding;
028
029/**
030 * Service that enables publishing a KEN notification document.
031 */
032@WebService(name= KenApiConstants.ServiceNames.SEND_NOTIFICATION_SERVICE, targetNamespace = KenApiConstants.Namespaces.KEN_NAMESPACE_2_0)
033@SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.BARE)
034public interface SendNotificationService {
035    /**
036     * This method invokes a notification with the given message.  This particular service
037     * accepts the actual business object.
038     * @param message
039     * @return NotificationResponse
040     */
041    @WebMethod(operationName = "invoke")
042    @WebResult(name = "response")
043    NotificationResponse invoke(@WebParam(name = "message") String message) throws RiceIllegalArgumentException;
044
045    /**
046     * This method allows consumers to send notification messages.
047     * @since 2.0.1
048     * @param notification
049     * @return NotificationResponse
050     */
051    @WebMethod(operationName = "sendNotification")
052    @WebResult(name = "response")
053    NotificationResponse sendNotification(Notification notification);
054}