View Javadoc

1   /*
2    * Copyright 2003,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  /* 
17  
18   */
19  
20  package org.apache.pluto.portalImpl.om.page;
21  
22  
23  /***
24   * <P>
25   * The <CODE>Navigation</CODE> interface represents the navigational
26   * information linked with one fragment.
27   * </P>
28   * <P>
29   * The interfaces defined in this package represent an abstract object
30   * model (OM) that is applicable for different implementations.
31   * The abstract OM defines only how the data is stored and accessed
32   * in the memory. Each implementation can store the data in different ways.
33   * </P>
34   * <P>
35   * This abstraction layer helps to generalize the portlet container from
36   * special implementations like data storage and moreover it is not bound
37   * to a special Application Server.
38   * </P>
39   * 
40  
41   */
42  public interface Navigation
43  {
44  
45  
46      /***
47       * Returns the title
48       * 
49       * @return the title as string
50       */
51      public String getTitle();
52  
53      /***
54       * Sets the title
55       * 
56       * @param title   the title to be set
57       */
58      public void setTitle(String title);
59  
60      /***
61       * Returns the description of this property
62       * 
63       * @return the description as string
64       */
65      public String getDescription();
66  
67      /***
68      * Sets the description of this property
69      * 
70      * @param description  the description to be set
71      */
72      public void setDescription(String description);
73      
74  }