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 /**
19 * Encapsulation of the ebXML classes for {@code ExternalIdentifierType}.
20 * <p>
21 * This class contains convenience methods and provides a version independent
22 * abstraction of the ebXML data structure.
23 * @author Jens Riemschneider
24 */
25 public interface EbXMLExternalIdentifier {
26 /**
27 * @return the value of the identifier.
28 */
29 String getValue();
30
31 /**
32 * @param value
33 * the value of the identifier.
34 */
35 void setValue(String value);
36
37 /**
38 * @return the scheme of the identifier.
39 */
40 String getIdentificationScheme();
41
42 /**
43 * @param identificationScheme
44 * the scheme of the identifier.
45 */
46 void setIdentificationScheme(String identificationScheme);
47
48 /**
49 * @return the name of the identifier.
50 */
51 EbXMLInternationalString getName();
52
53 /**
54 * @param name
55 * the name of the identifier.
56 */
57 void setName(EbXMLInternationalString name);
58
59 /**
60 * @param registryObject
61 * the registry object that this identifier belongs to.
62 */
63 void setRegistryObject(String registryObject);
64
65 /**
66 * @return the registry object that this identifier belongs to.
67 */
68 String getRegistryObject();
69
70 /**
71 * @param id
72 * the id of the identifier.
73 */
74 void setId(String id);
75
76 /**
77 * @return the id of the identifier.
78 */
79 String getId();
80 }