KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > alfresco > service > cmr > dictionary > PropertyDefinition


1 /*
2  * Copyright (C) 2005 Alfresco, Inc.
3  *
4  * Licensed under the Mozilla Public License version 1.1
5  * with a permitted attribution clause. You may obtain a
6  * copy of the License at
7  *
8  * http://www.alfresco.org/legal/license.txt
9  *
10  * Unless required by applicable law or agreed to in writing,
11  * software distributed under the License is distributed on an
12  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13  * either express or implied. See the License for the specific
14  * language governing permissions and limitations under the
15  * License.
16  */
17 package org.alfresco.service.cmr.dictionary;
18
19 import org.alfresco.service.namespace.QName;
20
21 /**
22  * Read-only definition of a Property.
23  *
24  * @author David Caruana
25  */
26 public interface PropertyDefinition
27 {
28     /**
29      * @return defining model
30      */
31     public ModelDefinition getModel();
32     
33     /**
34      * @return the qualified name of the property
35      */
36     public QName getName();
37
38     /**
39      * @return the human-readable class title
40      */
41     public String JavaDoc getTitle();
42     
43     /**
44      * @return the human-readable class description
45      */
46     public String JavaDoc getDescription();
47     
48     /**
49      * @return the default value
50      */
51     public String JavaDoc getDefaultValue();
52     
53     /**
54      * @return the qualified name of the property type
55      */
56     public DataTypeDefinition getDataType();
57
58     /**
59      * @return Returns the owning class's defintion
60      */
61     public ClassDefinition getContainerClass();
62     
63     /**
64      * @return true => multi-valued, false => single-valued
65      */
66     public boolean isMultiValued();
67
68     /**
69      * @return true => mandatory, false => optional
70      */
71     public boolean isMandatory();
72     
73     /**
74      * @return true => system maintained, false => client may maintain
75      */
76     public boolean isProtected();
77
78     /**
79      * @return true => indexed, false => not indexed
80      */
81     public boolean isIndexed();
82     
83     /**
84      * @return true => stored in index
85      */
86     public boolean isStoredInIndex();
87
88     /**
89      * @return true => tokenised when it is indexed (the stored value will not be tokenised)
90      */
91     public boolean isTokenisedInIndex();
92     
93     /**
94      * All non atomic properties will be indexed at the same time.
95      *
96      * @return true => The attribute must be indexed in the commit of the transaction.
97      * false => the indexing will be done in the background and may be out of date.
98      */
99     public boolean isIndexedAtomically();
100     
101 }
102
Popular Tags