/*
    * Copyright  2004-2005 Stefan Reuter
    *
    *  Licensed under the Apache License, Version 2.0 (the "License");
    *  you may not use this file except in compliance with the License.
    *  You may obtain a copy of the License at
    *
    *      http://www.apache.org/licenses/LICENSE-2.0
    *
   *  Unless required by applicable law or agreed to in writing, software
   *  distributed under the License is distributed on an "AS IS" BASIS,
   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   *  See the License for the specific language governing permissions and
   *  limitations under the License.
   *
   */
  package net.sf.asterisk.manager.event;
  
  /***
   * A QueueParamsEvent is triggered in response to a QueueStatusAction and contains the parameters 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: QueueParamsEvent.java,v 1.3 2005/07/15 11:44:23 srt Exp $
   */
  public class QueueParamsEvent extends ResponseEvent
  {
      /***
       * Serializable version identifier
       */
      private static final long serialVersionUID = -170511596914604717L;
      private String queue;
      private Integer max;
      private Integer calls;
      private Integer holdtime;
      private Integer completed;
      private Integer abandoned;
      private Integer serviceLevel;
      private Double serviceLevelPerf;
      private Integer weight;
  
      /***
       * @param source
       */
      public QueueParamsEvent(Object source)
      {
          super(source);
      }
  
      /***
       * Returns the name of the queue.
       */
      public String getQueue()
      {
          return queue;
      }
  
      /***
       * Sets the name of the queue.
       */
      public void setQueue(String queue)
      {
          this.queue = queue;
      }
  
      /***
       * Returns the maximum number of people waiting in the queue or 0 for unlimited.<br>
       * This corresponds to the <code>maxlen</code> setting in <code>queues.conf</code>.
       */
      public Integer getMax()
      {
          return max;
      }
  
      /***
       * Sets the maximum number of people waiting in the queue.
       */
      public void setMax(Integer max)
      {
          this.max = max;
      }
  
      /***
       * Returns the number of calls currently waiting in the queue.
       */
      public Integer getCalls()
      {
          return calls;
      }
  
      /***
       * Sets the number of calls currently waiting in the queue.
       */
      public void setCalls(Integer calls)
      {
          this.calls = calls;
     }
 
     /***
      * Returns the current average holdtime for this queue (in seconds).
      */
     public Integer getHoldtime()
     {
         return holdtime;
     }
 
     /***
      * Sets the current average holdtime for this queue.
      */
     public void setHoldtime(Integer holdtime)
     {
         this.holdtime = holdtime;
     }
 
     /***
      * Returns the number of completed calls.
      */
     public Integer getCompleted()
     {
         return completed;
     }
 
     /***
      * Sets the number of completed calls.
      */
     public void setCompleted(Integer complete)
     {
         this.completed = complete;
     }
 
     /***
      * Returns the number of abandoned calls.
      */
     public Integer getAbandoned()
     {
         return abandoned;
     }
 
     /***
      * Sets the number of abandoned calls.
      */
     public void setAbandoned(Integer abandoned)
     {
         this.abandoned = abandoned;
     }
 
     /***
      * Returns the service level (in seconds) as defined by the <code>servicelevel</code> setting
      * in <code>queues.conf</code>.
      */
     public Integer getServiceLevel()
     {
         return serviceLevel;
     }
 
     /***
      * Sets the service level.
      */
     public void setServiceLevel(Integer serviceLevel)
     {
         this.serviceLevel = serviceLevel;
     }
 
     /***
      * Returns the ratio of calls answered within the specified service level per total completed
      * calls (in percent).
      */
     public Double getServiceLevelPerf()
     {
         return serviceLevelPerf;
     }
 
     /***
      * Sets the ratio of calls answered within the specified service level per total completed
      * calls.
      */
     public void setServiceLevelPerf(Double serviceLevelPerf)
     {
         this.serviceLevelPerf = serviceLevelPerf;
     }
 
     /***
      * Returns the weight of this queue.<br>
      * A queues can be assigned a 'weight' to ensure calls waiting in a 
      * higher priority queue will deliver its calls first. Only delays 
      * the lower weight queue's call if the member is also in the 
      * higher weight queue.<br>
      * Available since Asterisk 1.2
      * 
      * @return the weight of this queue or <code>null</code> if not 
      *         supported by your version of Asterisk
      * @since 0.2
      */
     public Integer getWeight()
     {
         return weight;
     }
 
     /***
      * Sets the weight of this queue.
      * 
      * @param weight the weight of this queue
      * @since 0.2
      */
     public void setWeight(Integer weight)
     {
         this.weight = weight;
     }
 }