KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > barracuda > core > event > EventContext


1 /*
2  * Copyright (C) 2003 Christian Cryder [christianc@granitepeaks.com]
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * $Id: EventContext.java,v 1.12 2004/02/01 05:16:28 christianc Exp $
19  */
20 package org.enhydra.barracuda.core.event;
21
22 import java.io.*;
23 import java.util.*;
24
25 import org.enhydra.barracuda.core.view.*;
26 import org.enhydra.barracuda.plankton.data.*;
27
28 /**
29  * This interface defines the event context. The context
30  * contains information about the event (event, queue,
31  * plus request and response info if appropriate). The
32  * context also implements StateMap, so you can use it
33  * to pass information between event handlers. The scope
34  * of the context is only for the duration of an event
35  * dispatch cycle (ie. from Http Request to Http Response)
36  */
37 public interface EventContext extends StateMap {
38
39     public static final String JavaDoc BASE_EVENT = EventContext.class.getName()+".BaseEvent";
40     public static final String JavaDoc DISPATCH_QUEUE = EventContext.class.getName()+".DispatchQueue";
41     public static final String JavaDoc VIEW_CAPABILITIES = EventContext.class.getName()+".ViewCapabilities";
42
43     /**
44      * @clientCardinality 1
45      */
46     /*#ViewCapabilities lnkViewCapabilities;*/
47
48     /**
49      * @clientCardinality 1
50      */
51     /*#DispatchQueue lnkDispatchQueue;*/
52
53     /**
54      * @clientCardinality 1
55      */
56     /*#BaseEvent lnkBaseEvent;*/
57
58     /**
59      * Get the underlying BaseEvent
60      *
61      * @return the underlying BaseEvent
62      */
63     public BaseEvent getEvent();
64
65     /**
66      * Get the underlying DispatchQueue
67      *
68      * @return the underlying DispatchQueue
69      */
70     public DispatchQueue getQueue();
71
72     /**
73      * Get the underlying ViewCapabilities
74      */
75     public ViewCapabilities getViewCapabilities();
76     
77     /**
78      * The event context must be able to persist its statemap so that it can
79      * reconstruct itself after a ClientSideRedirectException. Developers should
80      * not normally need to call this method directly.
81      */
82 //csc_082302.2 - this method should not be exposed via the interface; developers
83 //should never need to call this function directly
84 // public void persistContext();
85 //csc_010404_1 - make this method part of the interface after all
86 public void persistContext(ClientSideRedirectException re);
87 }
88
Popular Tags