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.api.peopleflow;
017
018import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;
019import org.kuali.rice.core.api.exception.RiceIllegalStateException;
020import org.kuali.rice.kew.api.KewApiConstants;
021
022import javax.jws.WebMethod;
023import javax.jws.WebParam;
024import javax.jws.WebResult;
025import javax.jws.WebService;
026import javax.jws.soap.SOAPBinding;
027
028@WebService(name = "peopleFlowService", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
029@SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
030public interface PeopleFlowService {
031
032    @WebMethod(operationName = "getPeopleFlow")
033    @WebResult(name = "peopleFlow")
034    PeopleFlowDefinition getPeopleFlow(@WebParam(name = "peopleFlowId") String peopleFlowId)
035            throws RiceIllegalArgumentException;
036
037    @WebMethod(operationName = "getPeopleFlowByName")
038    @WebResult(name = "peopleFlow")
039    PeopleFlowDefinition getPeopleFlowByName(
040            @WebParam(name = "namespaceCode") String namespaceCode,
041            @WebParam(name = "name") String name)
042        throws RiceIllegalArgumentException;
043
044    /**
045     * TODO...
046     *
047     * @param peopleFlow
048     *
049     * @return
050     *
051     * @throws RiceIllegalArgumentException if the given PeopleFlow definition is null
052     * @throws RiceIllegalArgumentException if the given PeopleFlow definition has a non-null id.  When creating a new
053     * PeopleFlow definition, the ID will be generated.
054     * @throws RiceIllegalStateException if a PeopleFlow with the given namespace code and name already exists
055     */
056    @WebMethod(operationName = "createPeopleFlow")
057    @WebResult(name = "peopleFlow")
058    PeopleFlowDefinition createPeopleFlow(@WebParam(name = "peopleFlow") PeopleFlowDefinition peopleFlow)
059        throws RiceIllegalArgumentException, RiceIllegalStateException;
060
061    /**
062     *
063     * @param peopleFlow
064     *
065     * @return
066     *
067     * @throws RiceIllegalArgumentException
068     * @throws RiceIllegalStateException if the PeopleFlow does not exist in the system under the given peopleFlowId
069     */
070    @WebMethod(operationName = "updatePeopleFlow")
071    @WebResult(name = "peopleFlow")
072    PeopleFlowDefinition updatePeopleFlow(@WebParam(name = "peopleFlow") PeopleFlowDefinition peopleFlow)
073        throws RiceIllegalArgumentException, RiceIllegalStateException;
074
075
076}