View Javadoc

1   package org.apache.fulcrum.osworkflow;
2   
3   
4   /*
5    * Licensed to the Apache Software Foundation (ASF) under one
6    * or more contributor license agreements.  See the NOTICE file
7    * distributed with this work for additional information
8    * regarding copyright ownership.  The ASF licenses this file
9    * to you under the Apache License, Version 2.0 (the
10   * "License"); you may not use this file except in compliance
11   * with the License.  You may obtain a copy of the License at
12   *
13   *   http://www.apache.org/licenses/LICENSE-2.0
14   *
15   * Unless required by applicable law or agreed to in writing,
16   * software distributed under the License is distributed on an
17   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18   * KIND, either express or implied.  See the License for the
19   * specific language governing permissions and limitations
20   * under the License.
21   */
22  
23  
24  import org.apache.avalon.framework.component.Component;
25  
26  import com.opensymphony.workflow.Workflow;
27  import com.opensymphony.workflow.WorkflowException;
28  
29  /***
30   * WorkflowService interface.
31   *
32   * @author <a href="mailto:epugh@upstate.com">Eric Pugh</a>
33   * @version $Id: WorkflowService.java 535465 2007-05-05 06:58:06Z tv $
34   */
35  public interface WorkflowService
36      extends Component
37  {
38      /*** Avalon role - used to id the component within the manager */
39      String ROLE = WorkflowService.class.getName();
40  
41      /*** Retrives a workflow based on the caller
42       * @param caller the value of the caller
43       * @return the Workflow for this caller
44       */
45      public Workflow retrieveWorkflow(String caller);
46  
47      /*** For a specific caller and status, return all the workflows.
48       *
49       * @param caller the value of the caller
50       * @param status the status, defined in the workflow xml file
51       * @return an array of longs of the workflow id's
52       * @throws com.opensymphony.workflow.WorkflowException if there is a problem
53       */
54      public long[] retrieveWorkflows(String caller, String status) throws WorkflowException;
55  
56  
57  
58  
59  }