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: * Contains nodes of type portal.
26: *
27: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
28: * @version $Revision: 8786 $
29: */
30: public interface PortalContainer extends PortalObject {
31: /**
32: * Return an existing portal or null if such a child does not exist or does not have the right type.
33: *
34: * @param name the portal name
35: * @return the specified portal
36: * @throws IllegalArgumentException if the specified name is null
37: */
38: Portal getPortal(String name) throws IllegalArgumentException;
39:
40: /**
41: * Create a new portal.
42: *
43: * @param name the portal name
44: * @return the newly created portal
45: * @throws DuplicatePortalObjectException if a child with the specified name already exists
46: * @throws IllegalArgumentException if the name argument is null
47: */
48: Portal createPortal(String name)
49: throws DuplicatePortalObjectException,
50: IllegalArgumentException;
51:
52: /**
53: * Returns the default portal.
54: *
55: * @return the default portal of that container
56: */
57: Portal getDefaultPortal();
58:
59: // /**
60: // * Returns an existing portal container or null if such a child does not exist or does not have the appropriate type.
61: // *
62: // * @param name the portal container name
63: // * @return the specified portal container
64: // * @throws IllegalArgumentException if the specified name is null
65: // */
66: // PortalContainer getPortalContainer(String name) throws IllegalArgumentException;
67: //
68: // /**
69: // * Creates a new portal container.
70: // *
71: // * @param name the portal container name
72: // * @return the newly created portal container
73: // * @throws DuplicatePortalObjectException if a child with the specified name already exists
74: // * @throws IllegalArgumentException if the name argument is null
75: // */
76: // PortalContainer createPortalContainer(String name) throws DuplicatePortalObjectException, IllegalArgumentException;
77: }
|