01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.pluto;
18:
19: import javax.portlet.PortletMode;
20: import javax.portlet.WindowState;
21:
22: /**
23: * Thin representation of the portlet window for which the container
24: * request should be processed. The PortletWindow is used internally
25: * to map the request to the configured Portlet Application and Portlet.
26: *
27: * @see org.apache.pluto.internal.impl.InternalPortletWindowImpl
28: * @see org.apache.pluto.descriptors.portlet.PortletDD
29: *
30: * @version 1.0
31: * @since Sep 22, 2004
32: */
33: public interface PortletWindow {
34:
35: /**
36: * Retrieve this windows unique id which will be
37: * used to communicate back to the referencing portal.
38: * @return unique id.
39: */
40: public PortletWindowID getId();
41:
42: /**
43: * Retrieve the context path in which the Portlet resides.
44: * @return context path
45: */
46: public String getContextPath();
47:
48: /**
49: * Retrieve the name of the portlet as configured in the
50: * <code>portlet.xml</code>.
51: * @return the name of the portlet.
52: */
53: public String getPortletName();
54:
55: /**
56: * Retrieve the current window state for this window.
57: * @return the current window state.
58: */
59: public WindowState getWindowState();
60:
61: /**
62: * Retrieve the current portlet mode for this window.
63: * @return the current portlet mode.
64: */
65: public PortletMode getPortletMode();
66:
67: }
|