1 /*
2 The contents of this file are subject to the Mozilla Public License Version 1.1
3 (the "License"); you may not use this file except in compliance with the License.
4 You may obtain a copy of the License at http://www.mozilla.org/MPL/
5 Software distributed under the License is distributed on an "AS IS" basis,
6 WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
7 specific language governing rights and limitations under the License.
8
9 The Original Code is "Variable.java". Description:
10 "Interface type for Varies"
11
12 The Initial Developer of the Original Code is University Health Network. Copyright (C)
13 2015. All Rights Reserved.
14
15 Contributor(s): ______________________________________.
16
17 Alternatively, the contents of this file may be used under the terms of the
18 GNU General Public License (the "GPL"), in which case the provisions of the GPL are
19 applicable instead of those above. If you wish to allow use of your version of this
20 file only under the terms of the GPL and not to allow others to use your version
21 of this file under the MPL, indicate your decision by deleting the provisions above
22 and replace them with the notice and other provisions required by the GPL License.
23 If you do not delete the provisions above, a recipient may use your version of
24 this file under either the MPL or the GPL.
25 */
26
27 package ca.uhn.hl7v2.model;
28
29 /**
30 * Interface type for Varies
31 */
32 public interface Variable extends Type {
33
34 /**
35 * Returns the data contained by this instance of Variable. Returns a {@link ca.uhn.hl7v2.model.GenericPrimitive} unless
36 * {@link #setData(Type)} has been called.
37 *
38 * @return the data contained by this instance of Variable
39 */
40 Type getData();
41
42 /**
43 * Sets the data contained by this instance of Variable. If a data object already exists,
44 * then its values are copied to the incoming data object before the old one is replaced.
45 * For example, if {@link #getData()} returns an ST with the value "19901012" and you call
46 * setData(new DT()), then subsequent calls to {@link #getData()} will return the same DT, with the value
47 * set to "19901012".
48 *
49 * @param data the data to be set for this Varies instance
50 * @throws DataTypeException if the data could not be set
51 */
52 void setData(Type data) throws DataTypeException;
53
54 }