001: /*
002: * The Apache Software License, Version 1.1
003: *
004: * Copyright (c) 2001-2004 Caucho Technology, Inc. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution, if
019: * any, must include the following acknowlegement:
020: * "This product includes software developed by the
021: * Caucho Technology (http://www.caucho.com/)."
022: * Alternately, this acknowlegement may appear in the software itself,
023: * if and wherever such third-party acknowlegements normally appear.
024: *
025: * 4. The names "Hessian", "Resin", and "Caucho" must not be used to
026: * endorse or promote products derived from this software without prior
027: * written permission. For written permission, please contact
028: * info@caucho.com.
029: *
030: * 5. Products derived from this software may not be called "Resin"
031: * nor may "Resin" appear in their names without prior written
032: * permission of Caucho Technology.
033: *
034: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
035: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
036: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
037: * DISCLAIMED. IN NO EVENT SHALL CAUCHO TECHNOLOGY OR ITS CONTRIBUTORS
038: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
039: * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
040: * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
041: * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
042: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
043: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
044: * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
045: *
046: * @author Sam
047: */
048:
049: package com.caucho.portal.generic;
050:
051: import javax.portlet.PortletMode;
052: import javax.portlet.WindowState;
053: import java.util.Map;
054:
055: /**
056: */
057: public interface Invocation {
058: /**
059: * Return true if this invocation is the target of an action
060: */
061: public boolean isActionTarget();
062:
063: /**
064: * Return a map view of the parameters.
065: */
066: public Map<String, String[]> getParameterMap();
067:
068: /**
069: * Return a map view of the parameters and then create a new
070: * empty parameter map for this invocation.
071: */
072: public Map<String, String[]> releaseParameterMap();
073:
074: public WindowState getWindowState();
075:
076: public void setWindowState(WindowState windowState);
077:
078: public PortletMode getPortletMode();
079:
080: public void setPortletMode(PortletMode portletMode);
081:
082: /**
083: * Create and return an InvocationURL. The InvocationURL is initially
084: * a duplicate of the state of the Invocation's for every namespace,
085: * changes to the returned url have no effect on the originating
086: * Invocation's.
087: *
088: * The exception is parameters, the returned InvocationURL starts off
089: * with an empty parameter map for this invocation, but parameters for
090: * other invocations with different namespaces are preserved.
091: */
092: public InvocationURL createActionURL();
093:
094: /**
095: * Create and return a InvocationURL. The InvocationURL is initially
096: * a duplicate of the state of the Invocation's for every namespace,
097: * changes to the returned url have no effect on the originating
098: * Invocation's.
099: *
100: * The exception is parameters, the returned InvocationURL starts off
101: * with an empty parameter map for this invocation, but parameters for
102: * other invocations with different namespaces are preserved.
103: */
104: public InvocationURL createRenderURL();
105: }
|