01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package com.sun.rave.web.ui.component.util.event;
42:
43: /**
44: * <P> This interface provides an abstraction for different locations for
45: * storing output from a handler. Implementations may store values in
46: * Session, request attributes, databases, etc.</P>
47: *
48: * @author Ken Paulsen (ken.paulsen@sun.com)
49: */
50: public interface OutputType {
51:
52: /**
53: * <P> This method is responsible for retrieving the value of the Output
54: * from the destination that was specified by handler. 'key' may be
55: * null. In cases where it is not needed, it can be ignored. If it
56: * is needed, the implementation may either provide a default or
57: * throw an exception.</P>
58: *
59: * @param context The HandlerContext
60: *
61: * @param outDesc The IODescriptor for this Output value in
62: * which to obtain the value
63: *
64: * @param key The optional 'key' to use when retrieving the
65: * value from the OutputType
66: *
67: * @return The requested value.
68: */
69: public Object getValue(HandlerContext context,
70: IODescriptor outDesc, String key);
71:
72: /**
73: * <P> This method is responsible for setting the value of the Output
74: * to the destination that was specified by handler. 'key' may be
75: * null. In cases where it is not needed, it can be ignored. If it
76: * is needed, the implementation may either provide a default or
77: * throw an exception.</P>
78: *
79: * @param context The HandlerContext
80: *
81: * @param outDesc The IODescriptor for this Output value in
82: * which to obtain the value
83: *
84: * @param key The optional 'key' to use when setting the
85: * value from the OutputType
86: *
87: * @param value The value to set
88: */
89: public void setValue(HandlerContext context, IODescriptor outDesc,
90: String key, Object value);
91: }
|