01: /* Copyright 2004 The JA-SIG Collaborative. All rights reserved.
02: * See license distributed with this file and
03: * available online at http://www.uportal.org/license.html
04: */
05:
06: package org.jasig.portal.layout.alm;
07:
08: import org.jasig.portal.PortalException;
09: import org.jasig.portal.layout.IUserLayout;
10:
11: /**
12: * An interface representing the user layout fragment.
13: *
14: * Prior to uPortal 2.5, this class existed in the package org.jasig.portal.layout.
15: * It was moved to its present package to reflect that it is part of Aggregated
16: * Layouts.
17: *
18: * @author <a href="mailto:mvi@immagic.com">Michael Ivanov</a>
19: * @version $Revision: 35724 $
20: */
21: public interface ILayoutFragment extends IUserLayout {
22:
23: /**
24: * Returns a fragment name
25: *
26: * @return an <code>String</code> fragment name
27: */
28: public String getName();
29:
30: /**
31: * Returns a fragment description
32: *
33: * @return an <code>String</code> fragment description
34: */
35: public String getDescription();
36:
37: /**
38: * Returns a fragment functional name
39: *
40: * @return an <code>String</code> fragment name
41: */
42: public String getFunctionalName();
43:
44: /**
45: * Returns the fragment root Id.
46: *
47: * @return a <code>String</code> fragment root Id
48: * @exception PortalException if an error occurs
49: */
50: public String getFragmentRootId() throws PortalException;
51:
52: }
|