01: /*
02: * Version: MPL 1.1/GPL 2.0/LGPL 2.1
03: *
04: * "The contents of this file are subject to the Mozilla Public License
05: * Version 1.1 (the "License"); you may not use this file except in
06: * compliance with the License. You may obtain a copy of the License at
07: * http://www.mozilla.org/MPL/
08: *
09: * 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 extends AbstractSessionEvent
44: implements ContextEvent {
45: private int viewNumber;
46:
47: /**
48: * Constructs a <code>ViewNumberRetrievedEvent</code> with the specified
49: * <code>source</code> and <code>viewNumber</code>. </p>
50: *
51: * @param source the HTTP session.
52: * @param iceFacesId the ICEfaces ID identifying the session.
53: * @param viewNumber the view number that has been retrieved.
54: * @throws IllegalArgumentException if the one of the following happens:
55: * <ul> <li> the specified
56: * <code>source</code> is
57: * <code>null</code>. </li> <li> the
58: * specified <code>iceFacesId</code> is
59: * either <code>null</code> or empty. </li>
60: * </ul>
61: */
62: public ViewNumberRetrievedEvent(HttpSession source,
63: String iceFacesId, int viewNumber)
64: throws IllegalArgumentException {
65: super (source, iceFacesId);
66: this .viewNumber = viewNumber;
67: }
68:
69: /**
70: * Gets the view number of this <code>ViewNumberRetrievedEvent</code>. </p>
71: *
72: * @return the view number.
73: * @see #getICEfacesID()
74: */
75: public int getViewNumber() {
76: return viewNumber;
77: }
78: }
|