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.kew.framework.actionlist;
017
018import java.util.List;
019import java.util.Map;
020
021import javax.jws.WebMethod;
022import javax.jws.WebParam;
023import javax.jws.WebResult;
024import javax.jws.WebService;
025import javax.jws.soap.SOAPBinding;
026import javax.xml.bind.annotation.XmlElement;
027import javax.xml.bind.annotation.XmlElementWrapper;
028import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
029
030import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;
031import org.kuali.rice.kew.api.KewApiConstants;
032import org.kuali.rice.kew.api.action.ActionItem;
033import org.kuali.rice.kew.api.action.ActionItemCustomization;
034import org.kuali.rice.kew.framework.KewFrameworkServiceLocator;
035
036/**
037 * A remotable service which handles processing of a client application's custom processing of
038 * action list attributes.
039 *
040 * @author Kuali Rice Team (rice.collab@kuali.org)
041 */
042@WebService(name = KewFrameworkServiceLocator.ACTION_LIST_CUSTOMIZATION_HANDLER_SERVICE, targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
043@SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
044public interface ActionListCustomizationHandlerService {
045    
046    /**
047     * <p>Returns a list of Action Item Customizations from the given list of Action Items and Principal ID.
048     * </p>
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 the list of Action Item Customizations
053     * @throws RiceIllegalArgumentException if the given principalId is a null or blank value
054     */
055    @WebMethod(operationName = "customizeActionList")
056    @WebResult(name = "actionListCustomizations")
057    @XmlElementWrapper(name = "actionListCustomizations", required = false)
058    @XmlElement(name = "actionListCustomization", required = false)
059    List<ActionItemCustomization> customizeActionList(
060            @WebParam(name = "principalId") String principalId,
061            @WebParam(name = "actionItems") List<ActionItem> actionItems)
062        throws RiceIllegalArgumentException;
063
064}