1 /*
2 * Copyright 2009 the original author or authors.
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.openehealth.ipf.commons.ihe.xds.core.ebxml;
17
18 import java.util.List;
19
20 import org.openehealth.ipf.commons.ihe.xds.core.metadata.LocalizedString;
21
22 /**
23 * Encapsulation of the ebXML classes for {@code InternationalStringType}.
24 * <p>
25 * This class contains convenience methods and provides a version independent
26 * abstraction of the ebXML data structure.
27 * @author Jens Riemschneider
28 */
29 public interface EbXMLInternationalString {
30 /**
31 * @return all localized strings contained in this international string.
32 */
33 List<LocalizedString> getLocalizedStrings();
34
35 /**
36 * Retrieves a specific localized string.
37 * @param idx
38 * the index of the localized string.
39 * @return the localized string contained in this international string.
40 */
41 LocalizedString getLocalizedString(int idx);
42
43 /**
44 * Retrieves the first localized string.
45 * @return the localized string contained in this international string.
46 */
47 LocalizedString getSingleLocalizedString();
48 }