svn commit: r190437 - /portals/jetspeed-2/trunk/jetspeed-api/src/java/org/apache/jetspeed/container/window/PortletWindowAccessor.java

[we...@apache.org]

Author: weaver
Date: Mon Jun 13 10:19:57 2005
New Revision: 190437

URL: http://svn.apache.org/viewcvs?rev=190437&view=rev
Log:
restored

Added:
    portals/jetspeed-2/trunk/jetspeed-api/src/java/org/apache/jetspeed/container/window/PortletWindowAccessor.java

Added: portals/jetspeed-2/trunk/jetspeed-api/src/java/org/apache/jetspeed/container/window/PortletWindowAccessor.java
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/jetspeed-api/src/java/org/apache/jetspeed/container/window/PortletWindowAccessor.java?rev=190437&view=auto
==============================================================================
--- portals/jetspeed-2/trunk/jetspeed-api/src/java/org/apache/jetspeed/container/window/PortletWindowAccessor.java (added)
+++ portals/jetspeed-2/trunk/jetspeed-api/src/java/org/apache/jetspeed/container/window/PortletWindowAccessor.java Mon Jun 13 10:19:57 2005
@@ -0,0 +1,107 @@
+/*
+ * Copyright 2000-2001,2004 The Apache Software Foundation.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.jetspeed.container.window;
+
+import org.apache.jetspeed.components.portletentity.PortletEntityNotStoredException;
+import org.apache.jetspeed.om.page.ContentFragment;
+import org.apache.pluto.om.entity.PortletEntity;
+import org.apache.pluto.om.window.PortletWindow;
+
+/**
+ * Portlet Window Accessor
+ *
+ * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
+ * @version $Id: PortletWindowAccessor.java,v 1.7 2005/04/29 13:59:46 weaver Exp $
+ */
+public interface PortletWindowAccessor 
+{
+    /**
+     * Get a portlet window for the given fragment
+     * 
+     * @param fragment
+     * @return
+     * @throws FailedToRetrievePortletWindow
+     * @throws PortletEntityNotStoredException 
+     * @throws InconsistentWindowStateException If the window references a non-existsent PortletEntity
+     */
+    PortletWindow getPortletWindow(ContentFragment fragment) throws FailedToRetrievePortletWindow, PortletEntityNotStoredException;
+    
+    /**
+     * Get the portlet window for a fragment and given principal
+     * @param fragment
+     * @param principal
+     * @return
+     * @throws FailedToCreateWindowException
+     * @throws FailedToRetrievePortletWindow
+     * @throws PortletEntityNotStoredException 
+     * @throws InconsistentWindowStateException If the window references a non-existsent PortletEntity
+     */
+    PortletWindow getPortletWindow(ContentFragment fragment, String principal) throws FailedToCreateWindowException, FailedToRetrievePortletWindow, PortletEntityNotStoredException;
+
+    /**
+     * Lookup a portlet window in the cache
+     * If not found, return null
+     * 
+     * @param windowId 
+     * @return the window from the cache or null
+     */
+    PortletWindow getPortletWindow(String windowId);
+
+    /**
+     * Given a portlet entity, create a portlet window for that entity.
+     * 
+     * @param entity
+     * @param windowId
+     * @return new window
+     */
+    PortletWindow createPortletWindow(PortletEntity entity, String windowId);
+
+    /**
+     * Create a temporary portlet window
+     * This window does not have an entity associated with it.
+     * 
+     * @param windowId
+     * @return
+     */
+    PortletWindow createPortletWindow(String windowId);
+    
+    /**
+     * 
+     * <p>
+     * removeWindows
+     * </p>
+     * 
+     * Removes all <code>PortletWindow</code>s associated with this
+     * <code>PortletEntity</code>
+     *
+     * @param portletEntity
+     */
+    void removeWindows(PortletEntity portletEntity);
+    
+    /**
+     * 
+     * <p>
+     * removeWindow
+     * </p>
+     * 
+     * Removes a <code>PortletWindow</code> from the window cache.
+     *
+     * @param window
+     */
+    void removeWindow(PortletWindow window);
+    
+    
+}



---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org