KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sapia > magnet > domain > ProtocolHandlerIF


1 package org.sapia.magnet.domain;
2
3 // Import of Sun's JDK classes
4 // ---------------------------
5 import java.util.Collection JavaDoc;
6
7 // Import of Sapia's magnet classes
8 // --------------------------------
9 import org.sapia.magnet.render.RenderingException;
10
11
12 /**
13  *
14  *
15  * @author Jean-Cedric Desrochers
16  *
17  * <dl>
18  * <dt><b>Copyright:</b><dd>Copyright &#169; 2002-2003 <a HREF="http://www.sapia-oss.org">Sapia Open Source Software</a>. All Rights Reserved.</dd></dt>
19  * <dt><b>License:</b><dd>Read the license.txt file of the jar or visit the
20  * <a HREF="http://www.sapia-oss.org/license.html" target="sapia-license">license page</a> at the Sapia OSS web site</dd></dt>
21  * </dl>
22  */
23 public interface ProtocolHandlerIF {
24
25   /**
26    * Handle the rendering of the path object for a specific protocol by
27    * resolving the resources of the path.
28    *
29    * @param aPath The path object to render.
30    * @param aSortingOrder The sorting order of the collection to return.
31    * @return The collection of <CODE>Resource</CODE> objects.
32    * @exception RenderingException If an error occurs while resolving the path.
33    */
34   public Collection JavaDoc resolveResources(Path aPath, String JavaDoc aSortingOrder) throws RenderingException;
35 }
36
Popular Tags