1 /*
2 * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
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 de.smartics.properties.spi.core.metadata;
17
18 import java.io.Serializable;
19 import java.util.Locale;
20
21 import de.smartics.properties.api.core.domain.PropertyComment;
22 import de.smartics.properties.api.core.domain.PropertyDescriptor;
23
24 /**
25 * Provides access to the comment of a property.
26 */
27 public interface PropertyCommentProvider extends Serializable
28 {
29 // ********************************* Fields *********************************
30
31 // --- constants ------------------------------------------------------------
32
33 // ****************************** Initializer *******************************
34
35 // ****************************** Inner Classes *****************************
36
37 // ********************************* Methods ********************************
38
39 // --- get&set --------------------------------------------------------------
40
41 /**
42 * Returns the comment for the given property descriptor.
43 *
44 * @param propertyDescriptor the descriptor for which the comment is
45 * requested. It is required that this is the same for each
46 * invocation.
47 * @param locale the locale to select the language the comment is written in.
48 * @return the property comment for the given descriptor.
49 */
50 PropertyComment getComment(PropertyDescriptor propertyDescriptor,
51 Locale locale);
52
53 // --- business -------------------------------------------------------------
54
55 // --- object basics --------------------------------------------------------
56 }