asterisk-java-cvs

[Stefan R. <sr...@us...>]

Update of /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/fastagi
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv6973/src/java/net/sf/asterisk/fastagi

Modified Files:
	AGIRequest.java 
Log Message:
Added javadoc

Index: AGIRequest.java
===================================================================
RCS file: /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/fastagi/AGIRequest.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -p -r1.2 -r1.3
--- AGIRequest.java	6 Apr 2005 18:59:00 -0000	1.2
+++ AGIRequest.java	6 Apr 2005 22:29:09 -0000	1.3
@@ -19,13 +19,19 @@ package net.sf.asterisk.fastagi;
 import java.util.Map;
 
 /**
+ * Defines an object to provide client request information to an AGIScript.<br>
+ * This includes information about the channel the script is invoked on and
+ * parameters passed from the dialplan.
+ * 
  * @author srt
  * @version $Id$
  */
 public interface AGIRequest
 {
     /**
-     * Returns the name of the script to execute.
+     * Returns the name of the script to execute including its full path.<br>
+     * This corresponds to the request url with protocol, host, port and
+     * parameters stripped off.
      * 
      * @return the name of the script to execute.
      */
@@ -33,10 +39,10 @@ public interface AGIRequest
 
     /**
      * Returns the full URL of the requestURL in the form
-     * agi://host[:port][/script].
+     * agi://host[:port][/script][?param1=value1&param2=value2].
      * 
      * @return the full URL of the requestURL in the form
-     *         agi://host[:port][/script].
+     *         agi://host[:port][/script][?param1=value1&param2=value2].
      */
     String getRequestURL();
 
@@ -82,8 +88,20 @@ public interface AGIRequest
      */
     String getCallerIdName();
 
+    /**
+     * Returns the number, that has been dialed by the user.
+     * 
+     * @return the dialed number.
+     */
     String getDnid();
 
+    /**
+     * If this call has been forwared, the number of the person doing the
+     * redirect is returned (Redirected dialed number identification service).<br>
+     * This is usally only only available on PRI.
+     * 
+     * @return the number of the person doing the redirect.
+     */
     String getRdnis();
 
     /**