View Javadoc

1   /*
2    * InteractionLayerInterface.java Created @ Jun 8, 2004
3    * 
4    * Copyright (c) 2003-2005 Delft University of Technology, Jaffalaan 5, 2628 BX
5    * Delft, the Netherlands. All rights reserved.
6    * 
7    * See for project information <a href="http://www.simulation.tudelft.nl/">
8    * www.simulation.tudelft.nl </a>.
9    * 
10   * The source code and binary code of this software is proprietary information
11   * of Delft University of Technology.
12   */
13  
14  package org.gscg.singleuser.interactionlayer;
15  
16  import java.rmi.RemoteException;
17  
18  import org.gscg.common.interactionlayer.GlobalInteractionLayerInterface;
19  import org.gscg.singleuser.interactionlayer.dataobjects.content.RFQDataSuppliers;
20  
21  /***
22   * THe RemoteInteraction interface defines the methods for the client-side
23   * application. <br>
24   * Copyright (c) 2003-2005 Delft University of Technology, Jaffalaan 5, 2628 BX
25   * Delft, the Netherlands. All rights reserved.
26   * 
27   * See for project information <a href="http://www.simulation.tudelft.nl/">
28   * www.simulation.tudelft.nl </a>.
29   * 
30   * The source code and binary code of this software is proprietary information
31   * of Delft University of Technology.
32   * 
33   * @author <a
34   *         href="http://www.tbm.tudelft.nl/webstaf/stijnh/index.htm">Stijn-Pieter
35   *         van Houten </a>
36   * @version $Revision: 1.1 $ $Date: 2005/06/16 12:34:08 $
37   * @since 1.0.0
38   */
39  public interface RemoteInteractionLayerInterface extends
40  		GlobalInteractionLayerInterface
41  {
42  
43  	/***
44  	 * Method getContentList. TODO provide java doc examples of the
45  	 * implementation of a call
46  	 * 
47  	 * 
48  	 * @param contentClass the class reflecting the content
49  	 * @param sent indicates whether the sent or received messages should be
50  	 *        returned as an asynchronous event
51  	 * @param productName the name of the product for which to get the list
52  	 * @throws RemoteException thrown in case of a network error
53  	 */
54  	void getContentList(Class contentClass, boolean sent, String productName)
55  			throws RemoteException;
56  
57  	/***
58  	 * Method getSuppliers returns the suppliers for the specified product name.
59  	 * If the product name does not exist, an empty array is returned.
60  	 * 
61  	 * @param productName the product to get the 'empty' RFQ data for
62  	 * @return an initialized RFQData object with potential suppliers
63  	 * @throws RemoteException thrown in case of a network error
64  	 */
65  	RFQDataSuppliers getSuppliers(String productName) throws RemoteException;
66  }