View Javadoc

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 "Primitive.java".  Description: 
10  "Represents the category of HL7 data types that contain a single value (in other
11    words have no subcomponents)" 
12  
13  The Initial Developer of the Original Code is University Health Network. Copyright (C) 
14  2001.  All Rights Reserved. 
15  
16  Contributor(s): ______________________________________. 
17  
18  Alternatively, the contents of this file may be used under the terms of the 
19  GNU General Public License (the "GPL"), in which case the provisions of the GPL are 
20  applicable instead of those above.  If you wish to allow use of your version of this 
21  file only under the terms of the GPL and not to allow others to use your version 
22  of this file under the MPL, indicate your decision by deleting  the provisions above 
23  and replace  them with the notice and other provisions required by the GPL License.  
24  If you do not delete the provisions above, a recipient may use your version of 
25  this file under either the MPL or the GPL. 
26  
27  */
28  
29  package ca.uhn.hl7v2.model;
30  
31  
32  /**
33   * Represents the category of HL7 data types that contain a single value (in other
34   * words have no subcomponents).  Examples include ST and ID.
35   * @author Bryan Tripp (bryan_tripp@sourceforge.net)
36   */
37  public interface Primitive extends Type {
38  
39    /**
40     * Returns a String representation of the value of this field.
41     *
42     * @return a String representation of the value of this field
43     */
44    public String getValue();
45  
46    /**
47     * Sets the value of this field if the given value is legal in the context of the
48     * implementing class.
49     *
50     * @param value the value to be set
51     * @throws DataTypeException if the given value is not valid in this context.
52     */
53    public void setValue(String value) throws DataTypeException;
54  
55  }