View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.om.page;
18  
19  import org.apache.jetspeed.page.document.Node;
20  
21  /***
22   * <p>
23   * Document
24   * </p>
25   * <p>
26   * 
27   * </p>
28   * 
29   * @author <a href="mailto:weaver@apache.org">Scott T. Weaver </a>
30   * @version $Id: Document.java 551606 2007-06-28 16:07:53Z taylor $
31   *  
32   */
33  public interface Document extends Node
34  {
35      /***
36       * Gets the version number
37       * 
38       * @return version number is a string composed of optionally point separated digits
39       */
40      String getVersion();
41      
42      /***
43       * Sets the version number
44       * 
45       * @param versionNumber version number is a string composed of optional point separated digits
46       */
47      void setVersion(String versionNumber);
48      
49      /***
50       * <p>
51       * isDirty
52       * </p>
53       * <p>
54       *  Whether this node is dirty, i.e. should be updated in the persistent store.
55       * </p>
56       * @param hidden flag
57       */
58      boolean isDirty();
59  
60      /***
61       * <p>
62       * setDirty
63       * </p>
64       * <p>
65       *  Flag the node as dirty / clean, i.e. should be resp. should not be updated in the persistent store
66       * </p>
67       * @param hidden flag
68       */
69  
70      void setDirty(boolean dirty);
71      
72  }