View Javadoc

1   /*$Id: WorkflowStore.java,v 1.6 2004/12/03 14:47:41 jdt Exp $
2    * Created on 01-Mar-2004
3    *
4    * Copyright (C) AstroGrid. All rights reserved.
5    *
6    * This software is published under the terms of the AstroGrid 
7    * Software License version 1.2, a copy of which has been included 
8    * with this distribution in the LICENSE.txt file.  
9    *
10  **/
11  package org.astrogrid.portal.workflow.intf;
12  
13  import org.astrogrid.community.User;
14  import org.astrogrid.community.beans.v1.Account;
15  import org.astrogrid.store.Ivorn;
16  import org.astrogrid.workflow.beans.v1.Workflow;
17  
18  /*** A component that can store and retreive workflow documents from VoSpace.
19   * (i.e. myspace)
20   * @author Noel Winstanley nw@jb.man.ac.uk 01-Mar-2004
21   *
22   */
23  public interface WorkflowStore {
24  
25      /*** delete a workflow from the store
26       * 
27       * @param acc account details of the owner of the workflow
28       * @param name name of the workflow
29       * @throws WorkflowInterfaceException
30       */
31     // void deleteWorkflow(Account acc, String name) throws WorkflowInterfaceException;
32  
33      /*** Read a query from the store
34       * 
35       * @param acc account details of the ownder of the query
36       * @param name name of the query
37       * @return a string representation of the query. will never return null
38       * @throws WorkflowInterfaceException if fails to read query
39       */
40      /*String readQuery( Account acc
41                                    , String name ) throws WorkflowInterfaceException ;
42  */
43      /*** return list of names of queries present in the store
44       * 
45       * @param acc account details for the owner of the list of queries
46       * @return list of query names. never returns null
47       * @throws WorkflowInterfaceException
48       */
49     // String[] listQueries(Account acc) throws WorkflowInterfaceException;
50                                             
51  
52      /*** read workflow from the store 
53       * 
54       * @param user account details for the owner of the workflow document 
55       * @param  locationToReadFrom ivorn location to read the workflow from.
56       * @return workflow document object. will never return null
57       * @throws WorkflowInterfaceException if document can't be loaded
58       */
59      Workflow readWorkflow(User user, Ivorn locationToReadFrom) throws WorkflowInterfaceException;
60     /* Workflow readWorkflow( Account acc
61                                         , String name ) throws WorkflowInterfaceException;
62  */
63     /*** read list of workflow names from myspace 
64      * 
65      * @param acc account details for the owner of the workflow documents listed
66      * @return list of workflow names. never returns null
67      * @throws WorkflowInterfaceException
68      */                                        
69     //String[] listWorkflows(Account acc) throws WorkflowInterfaceException;                                         
70      /*** save workflow to myspace 
71       * 
72       * @param user account details for the owner of the workflow
73       * @param locationToSaveTo ivorn location to save the document
74       * @param workflow workflow document to save
75       * @throws WorkflowInterfaceException
76       */
77      void saveWorkflow(User user,Ivorn locationToSaveTo,  Workflow workflow) throws WorkflowInterfaceException;
78               
79    /*  void saveWorkflow( Account acc
80                                        , Workflow workflow ) throws WorkflowInterfaceException;
81  */
82  
83  
84  
85  }
86  
87  
88  /* 
89  $Log: WorkflowStore.java,v $
90  Revision 1.6  2004/12/03 14:47:41  jdt
91  Merges from workflow-nww-776
92  
93  Revision 1.5.124.1  2004/12/01 21:08:35  nw
94  scripting documentation
95  
96  Revision 1.5  2004/04/14 13:02:57  nw
97  cut down workflow store interface. now to implement it.
98  
99  Revision 1.4  2004/03/09 15:32:19  nw
100 removed deprecated methods - no need for them
101 
102 Revision 1.3  2004/03/03 11:15:23  nw
103 tarted up javadocs, reviewed types
104 
105 Revision 1.2  2004/03/03 01:36:38  nw
106 merged interfaces in from branch nww-int05-bz#146
107 
108 Revision 1.1.2.2  2004/03/03 01:18:00  nw
109 commited first draft of interface design
110 
111 Revision 1.1.2.1  2004/03/01 19:02:57  nw
112 refined interfaces. almost ready to publish
113  
114 */