1 /*******************************************************************************
2 * Copyright (c) 2005 Gabriel Handford.
3 * All rights reserved.
4 *
5 * Contributors:
6 * Gabriel Handford -
7 *******************************************************************************/
8 package net.sf.tacos.services;
9
10 import java.util.List;
11
12 /**
13 * This class describes a tapestry page.
14 *
15 * @author Gabriel Handford
16 */
17 public interface PageInfo {
18
19 /**
20 * Get the page description.
21 * @return The page description.
22 */
23 public String getDesc();
24
25 /**
26 * Get the unique page name.
27 * @return Page name
28 */
29 public String getName();
30
31 /**
32 * Get the permission associated with page, if any.
33 * @return Permission
34 */
35 public String getPermission();
36
37 /**
38 * Get the parent to this page.
39 * @return parent The parent.
40 */
41 public PageInfo getParent();
42
43 /**
44 * Set the parent.
45 * @param parent The parent.
46 */
47 public void setParent(PageInfo parent);
48
49 /**
50 * Adds the specified child node.
51 * @param child Child page
52 */
53 public void addChild(PageInfo child);
54
55 /**
56 * Get the children.
57 * @return Children
58 */
59 public List getChildrenNames();
60
61 /**
62 * Check if page should be included in navigation.
63 * @return Whether page should be included in navigation.
64 */
65 public boolean isNavigable();
66 }