[Asterisk-java-cvs] CVS: asterisk-java/src/java/net/sf/asterisk/manager/event QueueMemberEvent.java,1.3,1.4

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

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

Modified Files:
	QueueMemberEvent.java 
Log Message:
Fixed spelling of penalty

Index: QueueMemberEvent.java
===================================================================
RCS file: /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/manager/event/QueueMemberEvent.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -p -r1.3 -r1.4
--- QueueMemberEvent.java	15 Jul 2005 11:44:23 -0000	1.3
+++ QueueMemberEvent.java	28 Aug 2005 09:39:50 -0000	1.4
@@ -17,12 +17,11 @@
 package net.sf.asterisk.manager.event;
 
 /**
- * A QueueMemberEvent is triggered in response to a QueueStatusAction and contains information about
- * a member of a queue.<br>
+ * A QueueMemberEvent is triggered in response to a QueueStatusAction and
+ * contains information about a member of a queue.<br>
  * It is implemented in <code>apps/app_queue.c</code>
  * 
  * @see net.sf.asterisk.manager.action.QueueStatusAction
- * 
  * @author srt
  * @version $Id$
  */
@@ -51,6 +50,8 @@ public class QueueMemberEvent extends Re
 
     /**
      * Returns the name of the queue.
+     * 
+     * @return the name of the queue.
      */
     public String getQueue()
     {
@@ -59,6 +60,8 @@ public class QueueMemberEvent extends Re
 
     /**
      * Sets the name of the queue.
+     * 
+     * @param queue the name of the queue.
      */
     public void setQueue(String queue)
     {
@@ -66,8 +69,10 @@ public class QueueMemberEvent extends Re
     }
 
     /**
-     * Returns the location of this member.<br>
+     * Returns the name of the member's interface.<br>
      * E.g. the channel name or agent group.
+     * 
+     * @return the name of the member's interface.
      */
     public String getLocation()
     {
@@ -75,7 +80,9 @@ public class QueueMemberEvent extends Re
     }
 
     /**
-     * Sets the location of this member.
+     * Sets the name of the member's interface.
+     * 
+     * @param member the name of the member's interface.
      */
     public void setLocation(String location)
     {
@@ -83,9 +90,12 @@ public class QueueMemberEvent extends Re
     }
 
     /**
-     * Returns "dynamic" if this member has been dynamically added by the QueueAdd command (in the
-     * dialplan or via the manager api) or "static" if this member is has been statically defined in
-     * <code>queues.conf</code>.
+     * Returns if this member has been dynamically added by the QueueAdd command
+     * (in the dialplan or via the Manager API) or if this member is has been
+     * statically defined in <code>queues.conf</code>.
+     * 
+     * @return "dynamic" if the added member is a dynamic queue member, "static"
+     *         if the added member is a static queue member.
      */
     public String getMembership()
     {
@@ -95,7 +105,8 @@ public class QueueMemberEvent extends Re
     /**
      * Sets if this member has been dynamically or statically added.
      * 
-     * @param membership either "dynamic" or "static".
+     * @param membership "dynamic" if the added member is a dynamic queue
+     *            member, "static" if the added member is a static queue member.
      */
     public void setMembership(String membership)
     {
@@ -103,7 +114,10 @@ public class QueueMemberEvent extends Re
     }
 
     /**
-     * Returns the penality of this member.
+     * Returns the penalty for the added member. When calls are distributed
+     * members with higher penalties are considered last.
+     * 
+     * @return the penalty for the added member.
      */
     public Integer getPenalty()
     {
@@ -111,15 +125,19 @@ public class QueueMemberEvent extends Re
     }
 
     /**
-     * Sets the penality of this member.
+     * Sets the penalty for this member.
+     * 
+     * @param penalty the penalty for this member.
      */
-    public void setPenalty(Integer penality)
+    public void setPenalty(Integer penalty)
     {
-        this.penalty = penality;
+        this.penalty = penalty;
     }
 
     /**
-     * Returns the number of calls answered by this member.
+     * Returns the number of calls answered by the member.
+     * 
+     * @return the number of calls answered by the member.
      */
     public Integer getCallsTaken()
     {
@@ -127,7 +145,9 @@ public class QueueMemberEvent extends Re
     }
 
     /**
-     * Sets the number of calls answered by this member.
+     * Sets the number of calls answered by the added member.
+     * 
+     * @param callsTaken the number of calls answered by the added member.
      */
     public void setCallsTaken(Integer callsTaken)
     {
@@ -135,8 +155,11 @@ public class QueueMemberEvent extends Re
     }
 
     /**
-     * Returns the time (in seconds since 01/01/1970) the last 
-     * successful call answered by this member was hungup.
+     * Returns the time the last successful call answered by the added member
+     * was hungup.
+     * 
+     * @return the time (in seconds since 01/01/1970) the last successful call
+     *         answered by the added member was hungup.
      */
     public Long getLastCall()
     {
@@ -144,8 +167,11 @@ public class QueueMemberEvent extends Re
     }
 
     /**
-     * Sets the time (in seconds since 01/01/1970) the last successful call answered by this member
-     * was hungup.
+     * Sets the time the last successful call answered by this member was
+     * hungup.
+     * 
+     * @param lastCall the time (in seconds since 01/01/1970) the last
+     *            successful call answered by the added member was hungup.
      */
     public void setLastCall(Long lastCall)
     {
@@ -171,9 +197,8 @@ public class QueueMemberEvent extends Re
      * <dd>?</dd>
      * </dl>
      * 
-     * @return the status of this queue member or <code>null</code>
-     *         if this attribute is not supported by your version of 
-     *         Asterisk.
+     * @return the status of this queue member or <code>null</code> if this
+     *         attribute is not supported by your version of Asterisk.
      * @since 0.2
      */
     public Integer getStatus()
@@ -197,9 +222,9 @@ public class QueueMemberEvent extends Re
      * Available since Asterisk 1.2.
      * 
      * @return <code>Boolean.TRUE</code> if this member has been paused,
-     *         <code>Boolean.FALSE</code> if not or <code>null</code> 
-     *         if pausing is not supported by your version of Asterisk.
-     * @since 0.2 
+     *         <code>Boolean.FALSE</code> if not or <code>null</code> if
+     *         pausing is not supported by your version of Asterisk.
+     * @since 0.2
      */
     public Boolean getPaused()
     {
@@ -208,6 +233,7 @@ public class QueueMemberEvent extends Re
 
     /**
      * Sets if this member has been paused.
+     * 
      * @since 0.2
      */
     public void setPaused(Boolean paused)