svn commit: r582115 - /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java

[sk...@apache.org]

Author: skitching
Date: Fri Oct  5 01:15:40 2007
New Revision: 582115

URL: http://svn.apache.org/viewvc?rev=582115&view=rev
Log:
Add javadoc only.

Modified:
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java?rev=582115&r1=582114&r2=582115&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java Fri Oct  5 01:15:40 2007
@@ -33,27 +33,62 @@
  */
 public interface FrameworkAdapterInterface
 {
+	/**
+	 * Return the global init parameter with the specified name.
+	 * In most cases this is expected to return data from the ServletContext.
+	 */
 	public String getInitParameter(String key);
 
+	/**
+	 * Get a value from the set of input parameters sent by the user as part
+	 * of the request.
+	 */
 	public Object getRequestParameterAttribute(String key);
 
 	public boolean containsRequestParameterAttribute(String key);
 
+	/**
+	 * Get a request-scope variable. 
+	 */
 	public Object getRequestAttribute(String key);
 
 	public void setRequestAttribute(String key, Object value);
 
 	public boolean containsRequestAttribute(String key);
 
+	/**
+	 * Get a variable from the session-scope of the current user.
+	 */
 	public Object getSessionAttribute(String key);
 
 	public void setSessionAttribute(String key, Object value);
 
 	public boolean containsSessionAttribute(String key);
 
+	/**
+	 * Instruct the remote browser to fetch the specified URL.
+	 */
 	public void redirect(String url) throws IOException;
 
+	/**
+	 * Return the variable with the specified name.
+	 * <p>
+	 * In frameworks that support "managed beans", ie creation of objects on demand then
+	 * this may trigger the creation of the specified object. In frameworks that do not
+	 * support this, then the lookup may just return null if no object with the specified
+	 * name currently exists.
+	 */
 	public Object getBean(String name);
 
-	public void invokeNavigation(String navigationName);
+	/**
+	 * Navigate to the specified logical destination.
+	 * <p>
+	 * For frameworks that have a built-in navigation system, that system should be 
+	 * invoked.
+	 * <p>
+	 * For frameworks with no logical navigation system, the navigationName is treated
+	 * as a plain URL. Whether a FORWARD or a REDIRECT to this URL is perfomed is
+	 * determined by the subclass.
+	 */
+	public void invokeNavigation(String navigationName) throws IOException;
 }