[portal-commits] JBoss Portal SVN: r6800 - in trunk: api/src/main/org/jboss/portal/spi and 3 other directories.

Author: julien(a)jboss.com Date: 2007-03-21 20:23:50 -0400 (Wed, 21 Mar 2007) New Revision: 6800 Added: trunk/api/src/main/org/jboss/portal/spi/runtime/NavigationalStateContext.java Removed: trunk/api/src/main/org/jboss/portal/spi/NavigationalStateContext.java Modified: trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventContext.java trunk/api/src/main/org/jboss/portal/spi/runtime/PortalRuntimeContext.java trunk/core-samples/src/main/org/jboss/portal/core/portlet/test/event/WindowConstraintEventListener.java trunk/core/src/main/org/jboss/portal/core/aspects/controller/node/EventBroadcasterInterceptor.java trunk/core/src/main/org/jboss/portal/core/aspects/controller/node/PortalObjectNode.java Log: moved NavigationalStateContext to the spi.runtime.package since it is a runtime object Modified: trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventContext.java =================================================================== --- trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventContext.java 2007-03-22 00:20:28 UTC (rev 6799) +++ trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventContext.java 2007-03-22 00:23:50 UTC (rev 6800) @@ -23,7 +23,7 @@ package org.jboss.portal.api.node.event; import org.jboss.portal.api.node.PortalNode; -import org.jboss.portal.spi.NavigationalStateContext; +import org.jboss.portal.spi.runtime.NavigationalStateContext; /** * The context in which a <code>PortalNodeEvent</code> is dispatched. Deleted: trunk/api/src/main/org/jboss/portal/spi/NavigationalStateContext.java =================================================================== --- trunk/api/src/main/org/jboss/portal/spi/NavigationalStateContext.java 2007-03-22 00:20:28 UTC (rev 6799) +++ trunk/api/src/main/org/jboss/portal/spi/NavigationalStateContext.java 2007-03-22 00:23:50 UTC (rev 6800) @@ -1,72 +0,0 @@ -/****************************************************************************** - * JBoss, a division of Red Hat * - * Copyright 2006, Red Hat Middleware, LLC, and individual * - * contributors as indicated by the @authors tag. See the * - * copyright.txt in the distribution for a full listing of * - * individual contributors. * - * * - * This is free software; you can redistribute it and/or modify it * - * under the terms of the GNU Lesser General Public License as * - * published by the Free Software Foundation; either version 2.1 of * - * the License, or (at your option) any later version. * - * * - * This software is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * - * Lesser General Public License for more details. * - * * - * You should have received a copy of the GNU Lesser General Public * - * License along with this software; if not, write to the Free * - * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * - * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * - ******************************************************************************/ -package org.jboss.portal.spi; - -import org.jboss.portal.WindowState; -import org.jboss.portal.Mode; -import org.jboss.portal.api.node.PortalNode; - -/** - * Provide access to the navigational state. - * - * @author <a href="mailto:julien@jboss.org">Julien Viet</a> - * @version $Revision: 1.1 $ - */ -public interface NavigationalStateContext -{ - /** - * Returns the window state of a window or null if it is not found. - * - * @param window the window from which the window state is returned - * @return the window state - * @throws IllegalArgumentException - */ - WindowState getWindowState(PortalNode window) throws IllegalArgumentException; - - /** - * Updates the window state of a window. - * - * @param window the window to update - * @param windowState the new window state value - * @throws IllegalArgumentException - */ - void setWindowState(PortalNode window, WindowState windowState) throws IllegalArgumentException; - - /** - * Returns the mode of a window or null if it is not found. - * - * @param window the window from which the mode is returned - * @return the mode - * @throws IllegalArgumentException - */ - Mode getMode(PortalNode window) throws IllegalArgumentException; - - /** - * Updates the mode of a window. - * - * @param window the window to update - * @param mode the new mode value - * @throws IllegalArgumentException - */ - void setMode(PortalNode window, Mode mode) throws IllegalArgumentException; -} Copied: trunk/api/src/main/org/jboss/portal/spi/runtime/NavigationalStateContext.java (from rev 6798, trunk/api/src/main/org/jboss/portal/spi/NavigationalStateContext.java) =================================================================== --- trunk/api/src/main/org/jboss/portal/spi/runtime/NavigationalStateContext.java (rev 0) +++ trunk/api/src/main/org/jboss/portal/spi/runtime/NavigationalStateContext.java 2007-03-22 00:23:50 UTC (rev 6800) @@ -0,0 +1,72 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2006, Red Hat Middleware, LLC, and individual * + * contributors as indicated by the @authors tag. See the * + * copyright.txt in the distribution for a full listing of * + * individual contributors. * + * * + * This is free software; you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation; either version 2.1 of * + * the License, or (at your option) any later version. * + * * + * This software is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this software; if not, write to the Free * + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * + ******************************************************************************/ +package org.jboss.portal.spi.runtime; + +import org.jboss.portal.WindowState; +import org.jboss.portal.Mode; +import org.jboss.portal.api.node.PortalNode; + +/** + * Provide access to the navigational state. + * + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> + * @version $Revision: 1.1 $ + */ +public interface NavigationalStateContext +{ + /** + * Returns the window state of a window or null if it is not found. + * + * @param window the window from which the window state is returned + * @return the window state + * @throws IllegalArgumentException + */ + WindowState getWindowState(PortalNode window) throws IllegalArgumentException; + + /** + * Updates the window state of a window. + * + * @param window the window to update + * @param windowState the new window state value + * @throws IllegalArgumentException + */ + void setWindowState(PortalNode window, WindowState windowState) throws IllegalArgumentException; + + /** + * Returns the mode of a window or null if it is not found. + * + * @param window the window from which the mode is returned + * @return the mode + * @throws IllegalArgumentException + */ + Mode getMode(PortalNode window) throws IllegalArgumentException; + + /** + * Updates the mode of a window. + * + * @param window the window to update + * @param mode the new mode value + * @throws IllegalArgumentException + */ + void setMode(PortalNode window, Mode mode) throws IllegalArgumentException; +} Modified: trunk/api/src/main/org/jboss/portal/spi/runtime/PortalRuntimeContext.java =================================================================== --- trunk/api/src/main/org/jboss/portal/spi/runtime/PortalRuntimeContext.java 2007-03-22 00:20:28 UTC (rev 6799) +++ trunk/api/src/main/org/jboss/portal/spi/runtime/PortalRuntimeContext.java 2007-03-22 00:23:50 UTC (rev 6800) @@ -23,7 +23,7 @@ package org.jboss.portal.spi.runtime; /** - * The portal runtime context. + * The portal runtime context which provides access to runtime objects. * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 1.1 $ Modified: trunk/core/src/main/org/jboss/portal/core/aspects/controller/node/EventBroadcasterInterceptor.java =================================================================== --- trunk/core/src/main/org/jboss/portal/core/aspects/controller/node/EventBroadcasterInterceptor.java 2007-03-22 00:20:28 UTC (rev 6799) +++ trunk/core/src/main/org/jboss/portal/core/aspects/controller/node/EventBroadcasterInterceptor.java 2007-03-22 00:23:50 UTC (rev 6800) @@ -26,7 +26,7 @@ import org.jboss.portal.Mode; import org.jboss.portal.WindowState; import org.jboss.portal.theme.navigation.WindowNavigationalState; -import org.jboss.portal.spi.NavigationalStateContext; +import org.jboss.portal.spi.runtime.NavigationalStateContext; import org.jboss.portal.api.node.PortalNode; import org.jboss.portal.api.node.event.PortalNodeEvent; import org.jboss.portal.api.node.event.WindowActionEvent; Modified: trunk/core/src/main/org/jboss/portal/core/aspects/controller/node/PortalObjectNode.java =================================================================== --- trunk/core/src/main/org/jboss/portal/core/aspects/controller/node/PortalObjectNode.java 2007-03-22 00:20:28 UTC (rev 6799) +++ trunk/core/src/main/org/jboss/portal/core/aspects/controller/node/PortalObjectNode.java 2007-03-22 00:23:50 UTC (rev 6800) @@ -30,7 +30,7 @@ import org.jboss.portal.core.event.PortalEventListenerRegistry; import org.jboss.portal.core.model.portal.PortalObject; import org.jboss.portal.core.model.portal.PortalObjectId; -import org.jboss.portal.spi.NavigationalStateContext; +import org.jboss.portal.spi.runtime.NavigationalStateContext; import java.util.Collection; import java.util.Collections; Modified: trunk/core-samples/src/main/org/jboss/portal/core/portlet/test/event/WindowConstraintEventListener.java =================================================================== --- trunk/core-samples/src/main/org/jboss/portal/core/portlet/test/event/WindowConstraintEventListener.java 2007-03-22 00:20:28 UTC (rev 6799) +++ trunk/core-samples/src/main/org/jboss/portal/core/portlet/test/event/WindowConstraintEventListener.java 2007-03-22 00:23:50 UTC (rev 6800) @@ -29,7 +29,7 @@ import org.jboss.portal.api.node.event.WindowNavigationEvent; import org.jboss.portal.api.node.PortalNode; import org.jboss.portal.theme.ThemeConstants; -import org.jboss.portal.spi.NavigationalStateContext; +import org.jboss.portal.spi.runtime.NavigationalStateContext; import org.jboss.portal.WindowState; import java.util.Map;