View Javadoc

1   package ca.uhn.hl7v2.conf.spec.message;
2   
3   import ca.uhn.hl7v2.conf.ProfileException;
4   
5   /**
6    * A message profile Segment or SegGroup. 
7    * @author Bryan Tripp
8    */
9   public interface ProfileStructure {
10  
11      /** Getter for property name.
12       * @return Value of property name.
13       */
14      public String getName();
15      
16      /** Setter for property name.
17       * @param name New value of property name.
18       *
19       * @throws ProfileException
20       */
21      public void setName(String name) throws ProfileException;
22      
23      /** Getter for property longName.
24       * @return Value of property longName.
25       */
26      public String getLongName();
27      
28      /** Setter for property longName.
29       * @param longName New value of property longName.
30       *
31       * @throws ProfileException
32       */
33      public void setLongName(String longName) throws ProfileException;
34      
35      /** Getter for property usage.
36       * @return Value of property usage.
37       */
38      public String getUsage();
39      
40      /** Setter for property usage.
41       * @param usage New value of property usage.
42       *
43       * @throws ProfileException
44       */
45      public void setUsage(String usage) throws ProfileException;
46      
47      /** Getter for property min.
48       * @return Value of property min.
49       */
50      public short getMin();
51      
52      /** Setter for property min.
53       * @param min New value of property min.
54       *
55       * @throws ProfileException
56       */
57      public void setMin(short min) throws ProfileException;
58      
59      /** Getter for property max.
60       * @return Value of property max.
61       */
62      public short getMax();
63      
64      /** Setter for property max.
65       * @param max New value of property max.
66       *
67       * @throws ProfileException
68       */
69      public void setMax(short max) throws ProfileException;
70              
71      /** Getter for property impNote.
72       * @return Value of property impNote.
73       */
74      public String getImpNote();
75      
76      /** Setter for property impNote.
77       * @param impNote New value of property impNote.
78       *
79       * @throws ProfileException
80       */
81      public void setImpNote(String impNote) throws ProfileException;
82      
83      /** Getter for property description.
84       * @return Value of property description.
85       */
86      public String getDescription();
87      
88      /** Setter for property description.
89       * @param description New value of property description.
90       *
91       * @throws ProfileException
92       */
93      public void setDescription(String description) throws ProfileException;
94      
95      /** Getter for property reference.
96       * @return Value of property reference.
97       */
98      public String getReference();
99      
100     /** Setter for property reference.
101      * @param reference New value of property reference.
102      *
103      * @throws ProfileException
104      */
105     public void setReference(String reference) throws ProfileException;
106     
107     /** Getter for property predicate.
108      * @return Value of property predicate.
109      */
110     public String getPredicate();
111     
112     /** Setter for property predicate.
113      * @param predicate New value of property predicate.
114      *
115      * @throws ProfileException
116      */
117     public void setPredicate(String predicate) throws ProfileException;    
118         
119 }