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.prefs.om;
18  
19  import java.io.Serializable;
20  import java.sql.Timestamp;
21  
22  /***
23   * <p>
24   * Interface representing a property key/value pair.
25   * </p>
26   * 
27   * @author <a href="mailto:dlestrat@apache.org">David Le Strat</a>
28   */
29  public interface Property extends Serializable, Cloneable
30  {
31  
32      /***
33       * <p>
34       * Getter for the property value id.
35       * </p>
36       * 
37       * @return The property value id.
38       */
39      long getPropertyValueId();
40  
41      /***
42       * <p>
43       * Setter for the property value id.
44       * </p>
45       * 
46       * @param propertyValueId The property value id.
47       */
48      void setPropertyValueId(long propertyValueId);
49  
50      /***
51       * <p>
52       * Getter for the node id.
53       * </p>
54       * 
55       * @return The node id.
56       */
57      long getNodeId();
58  
59      /***
60       * <p>
61       * Setter for the node id.
62       * </p>
63       * 
64       * @param nodeId The node id.
65       */
66      void setNodeId(long nodeId);
67  
68      /***
69       * <p>
70       * Getter for the property name.
71       * </p>
72       * 
73       * @return The property name.
74       */
75      String getPropertyName();
76  
77      /***
78       * <p>
79       * Setter for the property name.
80       * </p>
81       * 
82       * @param propertyName The property name.
83       */
84      void setPropertyName(String propertyName);
85  
86      /***
87       * <p>
88       * Utility method used to return the property value as a String.
89       * </p>
90       * 
91       * @return The property value as a String.
92       */
93      String getPropertyValue();
94  
95      /***
96       * <p>
97       * Utility method used to identify with property value to set based on the
98       * value object type.
99       * </p>
100      * 
101      * @param valueObject The value object.
102      */
103     void setPropertyValue(String valueObject);
104 
105     /***
106      * <p>
107      * Getter for creation date.
108      * </p>
109      * 
110      * @return The creation date.
111      */
112     Timestamp getCreationDate();
113 
114     /***
115      * <p>
116      * Setter for the creation date.
117      * </p>
118      * 
119      * @param creationDate The creation date.
120      */
121     void setCreationDate(Timestamp creationDate);
122 
123     /***
124      * <p>
125      * Getter for the modified date.
126      * </p>
127      * 
128      * @return The modified date.
129      */
130     Timestamp getModifiedDate();
131 
132     /***
133      * <p>
134      * Setter for the modified date.
135      * </p>
136      * 
137      * @param modifiedDate The modified date.
138      */
139     void setModifiedDate(Timestamp modifiedDate);
140 
141 }