Add international basic service module
[vfc/nfvo/wfengine.git] / baseservice-i18n / src / main / java / org / openo / baseservice / i18n / I18nService.java
1 /**
2  * Copyright 2017 ZTE Corporation.
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 org.openo.baseservice.i18n;
17
18
19 import java.util.Optional;
20 import org.jvnet.hk2.annotations.Contract;
21 import org.openo.baseservice.i18n.ErrorCodeI18n.ErrorItem;
22
23 @Contract
24 public interface I18nService {
25
26     /**
27      * Get the corresponding examples of international documents (all languages), <br> for the above
28      * example topology (for example, the Chinese definition: topo-i18n-zh-CN.json, English
29      * definition Topo -i18n-en-US.json), into the reference into the "TOPO" can be <br> (i.e.
30      * except "-i18n-*.json" after the exact match).
31      *
32      * @return Optional<I18n>
33      */
34     public Optional<I18n> getI18n(String i18nFilePrefix);
35
36     public Optional<ErrorItem> getErrorItem(int errorCode);
37
38 }