View Javadoc

1   /*
2    * Copyright 2000-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  package org.apache.portals.graffito.model;
17  
18  
19  /***
20   * CMS History Element interface.
21   * 
22   */
23  public interface HistoryElement 
24  {
25      
26      
27      /***
28       * Gets the Document associated to this history element
29       * 
30       * @return the associated document 
31       */
32      Document getDocument();
33      
34      /***
35       * Get the previous history element
36       * 
37       * @return the previous object
38       */
39      HistoryElement getPrevious();
40         
41      
42      /***
43       * Set the Document into this history element
44       * 
45       * @param document The document to set
46       */
47      void setDocument(Document document);
48      
49      /***
50       * Set the previous history element
51       * 
52       * @param historyElement the previous element to set into the history
53       */
54      void setPrevious(HistoryElement historyElement);
55      
56      
57  }