01: /******************************************************************************
02: * JBoss, a division of Red Hat *
03: * Copyright 2006, Red Hat Middleware, LLC, and individual *
04: * contributors as indicated by the @authors tag. See the *
05: * copyright.txt in the distribution for a full listing of *
06: * individual contributors. *
07: * *
08: * This is free software; you can redistribute it and/or modify it *
09: * under the terms of the GNU Lesser General Public License as *
10: * published by the Free Software Foundation; either version 2.1 of *
11: * the License, or (at your option) any later version. *
12: * *
13: * This software is distributed in the hope that it will be useful, *
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16: * Lesser General Public License for more details. *
17: * *
18: * You should have received a copy of the GNU Lesser General Public *
19: * License along with this software; if not, write to the Free *
20: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
21: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
22: ******************************************************************************/package org.jboss.portal.theme;
23:
24: import org.jboss.portal.theme.metadata.PortalLayoutMetaData;
25: import org.jboss.portal.theme.metadata.RenderSetMetaData;
26:
27: /**
28: * TODO: A description of this class.
29: *
30: * @author <a href="mailto:mholzner@novell.com">Martin Holzner</a>.
31: * @version <tt>$Revision: 8784 $</tt>
32: */
33: public interface LayoutService extends LayoutServiceInfo {
34:
35: /**
36: * Set the default layout (on a global level).
37: *
38: * @param name the name of the layout to set as default
39: * @throws LayoutException
40: */
41: void setDefaultLayoutName(String name) throws LayoutException;
42:
43: PortalLayout getDefaultLayout();
44:
45: /** Add a layout. */
46: void addLayout(RuntimeContext runtimeContext,
47: PortalLayoutMetaData layoutMD) throws LayoutException;
48:
49: /**
50: * Remove all layouts that are hosted in the provided application.
51: *
52: * @param appID the name of the application that hosts the layout(s) to be removed
53: * @throws LayoutException
54: */
55: void removeLayouts(String appID) throws LayoutException;
56:
57: /** Register a renderSet with this service */
58: void addRenderSet(RuntimeContext runtimeContext,
59: RenderSetMetaData renderSet) throws LayoutException;
60:
61: public void setDefaultRenderSetName(String name);
62:
63: public String getDefaultRenderSetName();
64:
65: /**
66: * Remove all rendersets that are hosted in the provided application.
67: *
68: * @param appID the name of the application that hosts the render set(s) to be removed
69: * @throws LayoutException
70: */
71: void removeRenderSets(String appID) throws LayoutException;
72: }
|