01: /* Copyright 2002 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.node;
07:
08: import org.w3c.dom.Document;
09: import org.w3c.dom.Element;
10:
11: /**
12: * An interface describing a folder user layout node.
13: *
14: * @author Peter Kharchenko {@link <a href="mailto:pkharchenko@interactivebusiness.com"">pkharchenko@interactivebusiness.com"</a>}
15: * @version 1.0
16: */
17: public interface IUserLayoutFolderDescription extends
18: IUserLayoutNodeDescription {
19:
20: public static final int REGULAR_TYPE = 0;
21: public static final int HEADER_TYPE = 1;
22: public static final int FOOTER_TYPE = 2;
23:
24: public static final String[] folderTypeNames = { "regular",
25: "header", "footer" };
26:
27: /**
28: * Returns folder type.
29: *
30: * @return an <code>int</code> value corresponding
31: * to one of the valid folder types.
32: */
33: public int getFolderType();
34:
35: /**
36: * Assign a type to a folder.
37: *
38: * @param folderType an <code>int</code> value corresponding
39: * to one of the valid folder types.
40: */
41: public void setFolderType(int folderType);
42:
43: /**
44: * Creates a <code>org.w3c.dom.Element</code> representation of the current node.
45: *
46: * @param root a <code>Document</code> for which the <code>Element</code> should be created.
47: * @return a <code>Node</code> value
48: */
49: public Element getXML(Document root);
50:
51: }
|