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.core.model.portal;
23:
24: /**
25: * An interface which defines a page container.
26: *
27: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
28: * @version $Revision: 8786 $
29: */
30: public interface PageContainer extends PortalObject {
31: /**
32: * Return an existing page or null if the child does not exist or does not have the right type.
33: *
34: * @return the specified page
35: * @throws IllegalArgumentException if the name argument is null
36: */
37: Page getPage(String name) throws IllegalArgumentException;
38:
39: /**
40: * Create a new page in the scope of this container.
41: *
42: * @param name the name of the child page to create
43: * @return the create page
44: * @throws DuplicatePortalObjectException if an object with the specified name already exist
45: * @throws IllegalArgumentException if the name argument is null
46: */
47: Page createPage(String name) throws DuplicatePortalObjectException,
48: IllegalArgumentException;
49: }
|