001/**
002 * Copyright 2005-2017 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.kew.framework.actionlist;
017
018import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;
019import org.kuali.rice.kew.api.KewApiConstants;
020import org.kuali.rice.kew.api.action.ActionItem;
021import org.kuali.rice.kew.api.action.ActionItemCustomization;
022import org.kuali.rice.kew.framework.KewFrameworkServiceLocator;
023
024import javax.jws.WebMethod;
025import javax.jws.WebParam;
026import javax.jws.WebResult;
027import javax.jws.WebService;
028import javax.jws.soap.SOAPBinding;
029import javax.xml.bind.annotation.XmlElement;
030import javax.xml.bind.annotation.XmlElementWrapper;
031import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
032import java.util.List;
033import java.util.Map;
034
035/**
036 * A remotable service which handles processing of a client application's custom processing of
037 * action list attributes.
038 *
039 * @author Kuali Rice Team (rice.collab@kuali.org)
040 */
041@WebService(name = KewFrameworkServiceLocator.ACTION_LIST_CUSTOMIZATION_HANDLER_SERVICE, targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
042@SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
043public interface ActionListCustomizationMediator {
044
045    /**
046     * Retrieves a Map from ActionItem id to ActionItemCustomization for the ActionItems
047     * provided.  Any ActionItems that don't have customizations will not have entries in
048     * the resulting map.
049     *
050     * @param principalId the id of the principal on whose behalf these customizations are being processed
051     * @param actionItems the list of Action Items to get customizations for.
052     * @return a Map from ActionItem id to ActionItemCustomization. Any ActionItems that don't have customizations will
053     * not have entries in the resulting map.
054     * @throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException if the given principalId is a null or blank value
055     */
056    @WebMethod(operationName = "getActionListCustomizations")
057    @WebResult(name = "actionListCustomizations")
058    @XmlElement(name = "actionListCustomization", required = false)
059    @XmlJavaTypeAdapter(MapStringActionItemCustomizationAdapter.class)
060    Map<String, ActionItemCustomization> getActionListCustomizations(@WebParam(name = "principalId") String principalId,
061            @WebParam(name = "actionItems") List<ActionItem> actionItems)
062            throws RiceIllegalArgumentException;
063}