001    /**
002     * Copyright 2005-2013 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.kew.routemodule;
017    
018    import java.util.List;
019    
020    import org.kuali.rice.kew.actionrequest.ActionRequestValue;
021    import org.kuali.rice.kew.api.exception.WorkflowException;
022    import org.kuali.rice.kew.engine.RouteContext;
023    import org.kuali.rice.kew.util.ResponsibleParty;
024    
025    
026    /**
027     * A RouteModule is responsible for generating Action Requests for a given Route Header document.
028     * Implementations of this class are potentially remotable, so this interface uses value objects.
029     *
030     * @author Kuali Rice Team (rice.collab@kuali.org)
031     */
032    public interface RouteModule {
033    
034        /**
035         * Generate action requests for the given RouteContext.
036         *
037         * @return A List of the generated ActionRequestValue objects.
038         */
039        List<ActionRequestValue> findActionRequests(RouteContext context) throws Exception;
040    
041        /**
042         * The route module will re-resolve the given responsibilityId and return an object that contains the key to either
043         * a user, group, or role.  The original responsibility associated with the given id will then be swapped with the
044         * new ResponsibleParty when routing is resolved.
045         *
046         * <p>This method is intended to allow for the calling code to be able to "switch-out" one responsibility for
047         * another (in the case of a change to an assigned reponsibility).</p>
048         *
049         * <p>Returning null from this method will indicate that the original responsibile party should remain unchanged.
050         * This is typically the recommended default for implementation of this method and covers most use cases.</p>
051         *
052         * @param responsibilityId the id of the responsibility to be resolved
053         * @return the responsibility party with which to replace the original responsibility, or null if the responsibility
054         * should remain unchanged.
055         */
056        ResponsibleParty resolveResponsibilityId(String responsibilityId) throws WorkflowException;
057    
058        /**
059         * Returns true if this RouteModule has more requests available which it can generate.  This method will only be
060         * called after the first set of action requests returned by the first invocation of findActionRequests have been
061         * fully activated.  If this method returns true, findActionRequests will be invoked again and those requests will
062         * all be activated before the cycle continues until this method returns false;
063         *
064         * @param context the route context
065         * @return true if this route module has more requests it can generate, false otherwise
066         */
067        boolean isMoreRequestsAvailable(RouteContext context);
068    
069    }