View Javadoc

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.DocumentMetaData;
22  import de.smartics.properties.api.core.domain.PropertyDescriptor;
23  
24  /**
25   * Allows to lazy load annotation information.
26   */
27  public interface DocumentMetaDataProxy extends Serializable
28  {
29    // ********************************* Fields *********************************
30  
31    // --- constants ------------------------------------------------------------
32  
33    // ****************************** Initializer *******************************
34  
35    // ****************************** Inner Classes *****************************
36  
37    // ********************************* Methods ********************************
38  
39    // --- get&set --------------------------------------------------------------
40  
41    // --- business -------------------------------------------------------------
42  
43    /**
44     * Returns the document meta data.
45     *
46     * @param descriptor the descriptor of the property whose document meta data
47     *          is requested.
48     * @param locale the locale to select the meta data in a specific language.
49     * @return the document meta data written for the given locale.
50     */
51    DocumentMetaData getDocumentMetaData(PropertyDescriptor descriptor,
52        Locale locale);
53  
54    // --- object basics --------------------------------------------------------
55  
56  }