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.internal;
18:
19: import javax.servlet.ServletContext;
20:
21: import org.apache.pluto.PortletWindow;
22:
23: /**
24: * The internal portlet window represents a single window of a portlet instance
25: * as it can be shown only once on a single page. There is a one-to-one relation
26: * between portlet windows and portlet entities. Adding the same portlet e.g.
27: * twice on a page results in two different windows.
28: *
29: * @since 1.1.0
30: *
31: */
32: public interface InternalPortletWindow extends PortletWindow {
33:
34: /**
35: * The Context from which this window can be serviced.
36: * @return the associated servlet context.
37: */
38: ServletContext getServletContext();
39:
40: /**
41: * Returns the portlet entity. The return value cannot be NULL.
42: * @return the portlet entity
43: */
44: PortletEntity getPortletEntity();
45:
46: /**
47: * Retrieve the original portlet window with
48: * which the container was invoked.
49: *
50: * @return the original portlet window.
51: */
52: PortletWindow getOriginalPortletWindow();
53: }
|