View Javadoc

1   /*
2    * <cvs:source>$Source: /devel/astrogrid/community/common/src/java/org/astrogrid/community/common/policy/manager/ResourceManager.java,v $</cvs:source>
3    * <cvs:author>$Author: jdt $</cvs:author>
4    * <cvs:date>$Date: 2004/11/22 13:03:04 $</cvs:date>
5    * <cvs:version>$Revision: 1.8 $</cvs:version>
6    *
7    * <cvs:log>
8    *   $Log: ResourceManager.java,v $
9    *   Revision 1.8  2004/11/22 13:03:04  jdt
10   *   Merges from Comm_KMB_585
11   *
12   *   Revision 1.7.104.1  2004/11/12 09:12:09  KevinBenson
13   *   Still need to javadoc and check exceptions on a couple of new methods
14   *   for ResourceManager and PermissionManager, but for the most part it is ready.
15   *   I will also add some stylesheets around the jsp pages later.
16   *
17   *   Revision 1.7  2004/06/18 13:45:20  dave
18   *   Merged development branch, dave-dev-200406081614, into HEAD
19   *
20   *   Revision 1.6.54.2  2004/06/17 13:38:59  dave
21   *   Tidied up old CVS log entries
22   *
23   * </cvs:log>
24   *
25   */
26  package org.astrogrid.community.common.policy.manager ;
27  
28  import java.rmi.Remote ;
29  import java.rmi.RemoteException ;
30  
31  import org.astrogrid.community.common.policy.data.ResourceData ;
32  import org.astrogrid.community.common.service.CommunityService ;
33  
34  import org.astrogrid.community.common.exception.CommunityServiceException  ;
35  import org.astrogrid.community.common.exception.CommunityResourceException ;
36  import org.astrogrid.community.common.exception.CommunityIdentifierException ;
37  
38  /***
39   * The public interface for ResourceManager services.
40   *
41   */
42  public interface ResourceManager
43      extends Remote, CommunityService
44      {
45      /***
46       * Register a new Resource.
47       * @return A new ResourceData object to represent the resource.
48       * @throws CommunityServiceException If there is an internal error in the service.
49       * @throws RemoteException If the WebService call fails.
50       *
51       */
52      public ResourceData addResource()
53          throws RemoteException, CommunityServiceException ;
54  
55      /***
56       * Request the details for a Resource.
57       * @param The resource identifier.
58       * @return The requested ResourceData object.
59       * @throws CommunityResourceException If unable to locate the resource.
60       * @throws CommunityServiceException If there is an internal error in the service.
61       * @throws CommunityIdentifierException If the resource identifier is not valid.
62       * @throws RemoteException If the WebService call fails.
63       *
64       */
65     public ResourceData getResource(String ident)
66          throws RemoteException, CommunityIdentifierException, CommunityResourceException, CommunityServiceException ;
67     
68     /***
69      * Request the details for a Resource.
70      * @param The resource identifier.
71      * @return The requested ResourceData object.
72      * @throws CommunityResourceException If unable to locate the resource.
73      * @throws CommunityServiceException If there is an internal error in the service.
74      * @throws CommunityIdentifierException If the resource identifier is not valid.
75      * @throws RemoteException If the WebService call fails.
76      *
77      */
78    public Object[] getResources() throws RemoteException ;
79     
80  
81      /***
82       * Update the details for a Resource.
83       * @param The ResourceData to update.
84       * @return The updated ResourceData.
85       * @throws CommunityResourceException If unable to locate the resource.
86       * @throws CommunityServiceException If there is an internal error in the service.
87       * @throws CommunityIdentifierException If the resource identifier is not valid.
88       * @throws RemoteException If the WebService call fails.
89       *
90       */
91      public ResourceData setResource(ResourceData resource)
92          throws RemoteException, CommunityIdentifierException, CommunityResourceException, CommunityServiceException ;
93  
94      /***
95       * Delete a Resource.
96       * @param The resource identifier.
97       * @return The original ResourceData.
98       * @throws CommunityResourceException If unable to locate the resource.
99       * @throws CommunityServiceException If there is an internal error in the service.
100      * @throws CommunityIdentifierException If the identifier is not valid.
101      * @throws RemoteException If the WebService call fails.
102      *
103      */
104     public ResourceData delResource(String ident)
105         throws RemoteException, CommunityIdentifierException, CommunityResourceException, CommunityServiceException ;
106 
107     }