ViewNumberRetrievedEvent


1   /*
2    * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3    *
4    * "The contents of this file are subject to the Mozilla Public License
5    * Version 1.1 (the "License"); you may not use this file except in
6    * compliance with the License. You may obtain a copy of the License at
7    * http://www.mozilla.org/MPL/
8    *
9    * Software distributed under the License is distributed on an "AS IS"
10   * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
11   * License for the specific language governing rights and limitations under
12   * the License.
13   *
14   * The Original Code is ICEfaces 1.5 open source software code, released
15   * November 5, 2006. The Initial Developer of the Original Code is ICEsoft
16   * Technologies Canada, Corp. Portions created by ICEsoft are Copyright (C)
17   * 2004-2006 ICEsoft Technologies Canada, Corp. All Rights Reserved.
18   *
19   * Contributor(s): _____________________.
20   *
21   * Alternatively, the contents of this file may be used under the terms of
22   * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"
23   * License), in which case the provisions of the LGPL License are
24   * applicable instead of those above. If you wish to allow use of your
25   * version of this file only under the terms of the LGPL License and not to
26   * allow others to use your version of this file under the MPL, indicate
27   * your decision by deleting the provisions above and replace them with
28   * the notice and other provisions required by the LGPL License. If you do
29   * not delete the provisions above, a recipient may use your version of
30   * this file under either the MPL or the LGPL License."
31   *
32   */
33  
34  package com.icesoft.faces.util.event.servlet;
35  
36  import javax.servlet.http.HttpSession  ;
37  
38  /**
39   * The <code>ViewNumberRetrievedEvent</code> class represents an event that
40   * should be fired whenever a view number is retrieved. A view number is always
41   * associated with an ICEfaces ID. </p>
42   */
43  public class ViewNumberRetrievedEvent
44          extends AbstractSessionEvent
45          implements ContextEvent {
46      private int viewNumber;
47  
48      /**
49       * Constructs a <code>ViewNumberRetrievedEvent</code> with the specified
50       * <code>source</code> and <code>viewNumber</code>. </p>
51       *
52       * @param source     the HTTP session.
53       * @param iceFacesId the ICEfaces ID identifying the session.
54       * @param viewNumber the view number that has been retrieved.
55       * @throws IllegalArgumentException if the one of the following happens:
56       *                                  <ul> <li> the specified
57       *                                  <code>source</code> is
58       *                                  <code>null</code>. </li> <li> the
59       *                                  specified <code>iceFacesId</code> is
60       *                                  either <code>null</code> or empty. </li>
61       *                                  </ul>
62       */
63      public ViewNumberRetrievedEvent(
64              HttpSession   source, String   iceFacesId, int viewNumber)
65              throws IllegalArgumentException   {
66          super(source, iceFacesId);
67          this.viewNumber = viewNumber;
68      }
69  
70      /**
71       * Gets the view number of this <code>ViewNumberRetrievedEvent</code>. </p>
72       *
73       * @return the view number.
74       * @see #getICEfacesID()
75       */
76      public int getViewNumber() {
77          return viewNumber;
78      }
79  }
80
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags