View Javadoc

1   /*
2    * <cvs:source>$Source: /devel/astrogrid/filemanager/client/src/java/org/astrogrid/filemanager/client/delegate/FileManagerDelegate.java,v $</cvs:source>
3    * <cvs:author>$Author: clq2 $</cvs:author>
4    * <cvs:date>$Date: 2005/01/28 10:43:58 $</cvs:date>
5    * <cvs:version>$Revision: 1.2 $</cvs:version>
6    * <cvs:log>
7    *   $Log: FileManagerDelegate.java,v $
8    *   Revision 1.2  2005/01/28 10:43:58  clq2
9    *   dave_dev_200501141257 (filemanager)
10   *
11   *   Revision 1.1.2.1  2005/01/22 07:54:16  dave
12   *   Refactored delegate into a separate package ....
13   *
14   *   Revision 1.4  2005/01/13 17:23:15  jdt
15   *   merges from dave-dev-200412201250
16   *
17   *   Revision 1.3.4.2  2005/01/12 14:20:57  dave
18   *   Replaced tabs with spaces ....
19   *
20   *   Revision 1.3.4.1  2004/12/22 07:38:36  dave
21   *   Started to move towards StoreClient API ...
22   *
23   *   Revision 1.3  2004/12/16 17:25:49  jdt
24   *   merge from dave-dev-200410061224-200412161312
25   *
26   *   Revision 1.1.2.6  2004/12/08 17:54:54  dave
27   *   Added update to FileManager client and server side ...
28   *
29   *   Revision 1.1.2.5  2004/12/02 19:11:54  dave
30   *   Added move name and parent to manager ...
31   *
32   *   Revision 1.1.2.4  2004/11/29 18:05:07  dave
33   *   Refactored methods names ....
34   *   Added stubs for delete, copy and move.
35   *
36   *   Revision 1.1.2.3  2004/11/24 16:15:08  dave
37   *   Added node functions to client ...
38   *
39   *   Revision 1.1.2.2  2004/11/16 03:26:14  dave
40   *   Added initial tests for adding accounts, containers and files ...
41   *
42   *   Revision 1.1.2.1  2004/11/13 01:41:26  dave
43   *   Created initial client API ....
44   *
45   * </cvs:log>
46   *
47   */
48  package org.astrogrid.filemanager.client.delegate ;
49  
50  import org.astrogrid.store.Ivorn ;
51  
52  import org.astrogrid.filemanager.common.exception.NodeNotFoundException ;
53  import org.astrogrid.filemanager.common.exception.DuplicateNodeException;
54  import org.astrogrid.filemanager.common.exception.FileManagerIdentifierException;
55  import org.astrogrid.filemanager.common.exception.FileManagerServiceException;
56  
57  import org.astrogrid.filemanager.client.FileManagerNode;
58  
59  /***
60   * The public API for a FileManager delegate.
61   *
62   */
63  public interface FileManagerDelegate
64      {
65      /***
66       * Get the manager identifier.
67       * @return The manager ivorn identifier.
68       * @throws FileManagerServiceException If a problem occurs when handling the request. 
69       *
70       */
71      public Ivorn getServiceIvorn()
72          throws FileManagerServiceException;
73  
74      /***
75       * Create a node for a new account.
76       * @param ivorn The ivorn identifier for the account.
77       * @return A node representing the account home.
78       * @throws DuplicateNodeException If the the account already exists.
79       * @throws FileManagerServiceException If a problem occurs when handling the request. 
80       *
81       */
82      public FileManagerNode addAccount(Ivorn ident)
83          throws
84              FileManagerServiceException,
85              DuplicateNodeException;
86  
87      /***
88       * Get the root node for an account
89       * @param ivorn The identifier of the account.
90       * @return An new node for the account home.
91       * @throws NodeNotFoundException If the account does not exist.
92       * @throws FileManagerServiceException If a problem occurs when handling the request. 
93       *
94       */
95      public FileManagerNode getAccount(Ivorn ivorn)
96          throws
97              FileManagerServiceException,
98              NodeNotFoundException;
99  
100     /***
101      * Get a node from the node Ivorn
102      * @param ivorn The identifier of the node.
103      * @return The node for the ivorn.
104      * @throws NodeNotFoundException If the node does not exist.
105      * @throws FileManagerIdentifierException If the node identifier is invalid.
106      * @throws FileManagerServiceException If a problem occurs when handling the request. 
107      *
108      */
109     public FileManagerNode getNode(Ivorn ivorn)
110         throws
111             FileManagerServiceException,
112             FileManagerIdentifierException,
113             NodeNotFoundException;
114 
115     }
116