Descriptor


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.descriptor;
18  
19  
20  /**
21   * Provides meta-data for the Alfresco stack.
22   * 
23   * @author David Caruana
24   */
25  public interface Descriptor
26  {
27      /**
28       * Gets the major version number, e.g. <u>1</u>.2.3
29       * 
30       * @return  major version number
31       */
32      public String   getVersionMajor();
33  
34      /**
35       * Gets the minor version number, e.g. 1.<u>2</u>.3
36       * 
37       * @return  minor version number
38       */
39      public String   getVersionMinor();
40      
41      /**
42       * Gets the version revision number, e.g. 1.2.<u>3</u>
43       * 
44       * @return  revision number
45       */
46      public String   getVersionRevision();
47      
48      /**
49       * Gets the version label
50       * 
51       * @return  the version label
52       */
53      public String   getVersionLabel();
54      
55      /**
56       * Gets the full version number
57       * 
58       * @return  full version number as major.minor.revision (label)
59       */
60      public String   getVersion();
61  
62      /**
63       * Gets the edition
64       *  
65       * @return  the edition
66       */
67      public String   getEdition();
68      
69      /**
70       * Gets the schema number
71       * 
72       * @return a positive integer
73       */
74      public int getSchema();
75      
76      /**
77       * Gets the list available descriptors
78       *  
79       * @return  descriptor keys
80       */
81      public String  [] getDescriptorKeys();
82      
83      /**
84       * Get descriptor value
85       * 
86       * @param key  the descriptor key
87       * @return  descriptor value (or null, if one not provided)
88       */
89      public String   getDescriptor(String   key);
90      
91  }
92
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags