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;
23:
24: import org.jboss.portal.core.model.instance.Instance;
25: import org.jboss.portal.core.model.portal.Portal;
26: import org.jboss.portal.core.model.portal.PortalObject;
27: import org.jboss.portal.core.model.portal.Window;
28: import org.jboss.portal.identity.User;
29:
30: /**
31: * Integration logic between portal objects, instances and users.
32: *
33: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
34: * @version $Revision: 8786 $
35: */
36: public interface CustomizationManager {
37: /**
38: * Returns a top level named portlet instance.
39: *
40: * @param window the window of the portlet instance
41: * @return the target instance or null if it cannot be found
42: * @throws IllegalArgumentException if the window is null
43: */
44: Instance getInstance(Window window) throws IllegalArgumentException;
45:
46: /**
47: * Returns a contextualized portlet instance for the specified user id. If the window is in the context of a
48: * dashboard then the portlet instance is further customized for that specific window.
49: *
50: * @param window the window of the portlet instance
51: * @param user the user that can be null
52: * @return the target instance or null if it cannot be found
53: * @throws IllegalArgumentException if the window is null
54: */
55: Instance getInstance(Window window, User user)
56: throws IllegalArgumentException;
57:
58: /**
59: * Returns the dashboard of a specific user.
60: *
61: * @param user
62: * @return
63: * @throws IllegalArgumentException
64: */
65: Portal getDashboard(User user) throws IllegalArgumentException;
66:
67: /**
68: * Returns true if the portal object is in a dashboard context for the specified user.
69: *
70: * @param object
71: * @return
72: */
73: boolean isDashboard(PortalObject object, User user);
74:
75: /**
76: * Destroys the dashboard of a specified user.
77: *
78: * @param userId
79: */
80: void destroyDashboard(String userId);
81: }
|