View Javadoc
1   /*
2    * An XML document type.
3    * Localname: PlannedReport
4    * Namespace: http://apply.grants.gov/forms/PlannedReport-V1.0
5    * Java type: gov.grants.apply.forms.plannedReportV10.PlannedReportDocument
6    *
7    * Automatically generated - do not modify.
8    */
9   package gov.grants.apply.forms.plannedReportV10;
10  
11  
12  /**
13   * A document containing one PlannedReport(@http://apply.grants.gov/forms/PlannedReport-V1.0) element.
14   *
15   * This is a complex type.
16   */
17  public interface PlannedReportDocument extends org.apache.xmlbeans.XmlObject
18  {
19      public static final org.apache.xmlbeans.SchemaType type = (org.apache.xmlbeans.SchemaType)
20          org.apache.xmlbeans.XmlBeans.typeSystemForClassLoader(PlannedReportDocument.class.getClassLoader(), "schemaorg_apache_xmlbeans.system.sEAFA503253B0B59D5509A37AD48F2343").resolveHandle("plannedreport83f9doctype");
21      
22      /**
23       * Gets the "PlannedReport" element
24       */
25      gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport getPlannedReport();
26      
27      /**
28       * Sets the "PlannedReport" element
29       */
30      void setPlannedReport(gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport plannedReport);
31      
32      /**
33       * Appends and returns a new empty "PlannedReport" element
34       */
35      gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport addNewPlannedReport();
36      
37      /**
38       * An XML PlannedReport(@http://apply.grants.gov/forms/PlannedReport-V1.0).
39       *
40       * This is a complex type.
41       */
42      public interface PlannedReport extends org.apache.xmlbeans.XmlObject
43      {
44          public static final org.apache.xmlbeans.SchemaType type = (org.apache.xmlbeans.SchemaType)
45              org.apache.xmlbeans.XmlBeans.typeSystemForClassLoader(PlannedReport.class.getClassLoader(), "schemaorg_apache_xmlbeans.system.sEAFA503253B0B59D5509A37AD48F2343").resolveHandle("plannedreportd215elemtype");
46          
47          /**
48           * Gets array of all "Study" elements
49           */
50          gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study[] getStudyArray();
51          
52          /**
53           * Gets ith "Study" element
54           */
55          gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study getStudyArray(int i);
56          
57          /**
58           * Returns number of "Study" element
59           */
60          int sizeOfStudyArray();
61          
62          /**
63           * Sets array of all "Study" element
64           */
65          void setStudyArray(gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study[] studyArray);
66          
67          /**
68           * Sets ith "Study" element
69           */
70          void setStudyArray(int i, gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study study);
71          
72          /**
73           * Inserts and returns a new empty value (as xml) as the ith "Study" element
74           */
75          gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study insertNewStudy(int i);
76          
77          /**
78           * Appends and returns a new empty value (as xml) as the last "Study" element
79           */
80          gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study addNewStudy();
81          
82          /**
83           * Removes the ith "Study" element
84           */
85          void removeStudy(int i);
86          
87          /**
88           * Gets the "FormVersion" attribute
89           */
90          java.lang.String getFormVersion();
91          
92          /**
93           * Gets (as xml) the "FormVersion" attribute
94           */
95          gov.grants.apply.system.globalLibraryV20.FormVersionDataType xgetFormVersion();
96          
97          /**
98           * Sets the "FormVersion" attribute
99           */
100         void setFormVersion(java.lang.String formVersion);
101         
102         /**
103          * Sets (as xml) the "FormVersion" attribute
104          */
105         void xsetFormVersion(gov.grants.apply.system.globalLibraryV20.FormVersionDataType formVersion);
106         
107         /**
108          * An XML Study(@http://apply.grants.gov/forms/PlannedReport-V1.0).
109          *
110          * This is a complex type.
111          */
112         public interface Study extends org.apache.xmlbeans.XmlObject
113         {
114             public static final org.apache.xmlbeans.SchemaType type = (org.apache.xmlbeans.SchemaType)
115                 org.apache.xmlbeans.XmlBeans.typeSystemForClassLoader(Study.class.getClassLoader(), "schemaorg_apache_xmlbeans.system.sEAFA503253B0B59D5509A37AD48F2343").resolveHandle("study52a0elemtype");
116             
117             /**
118              * Gets the "StudyTitle" element
119              */
120             java.lang.String getStudyTitle();
121             
122             /**
123              * Gets (as xml) the "StudyTitle" element
124              */
125             gov.grants.apply.forms.plannedReportV10.PlannedReportString1250DataType xgetStudyTitle();
126             
127             /**
128              * Sets the "StudyTitle" element
129              */
130             void setStudyTitle(java.lang.String studyTitle);
131             
132             /**
133              * Sets (as xml) the "StudyTitle" element
134              */
135             void xsetStudyTitle(gov.grants.apply.forms.plannedReportV10.PlannedReportString1250DataType studyTitle);
136             
137             /**
138              * Gets the "DomesticForeignIndicator" element
139              */
140             gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study.DomesticForeignIndicator.Enum getDomesticForeignIndicator();
141             
142             /**
143              * Gets (as xml) the "DomesticForeignIndicator" element
144              */
145             gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study.DomesticForeignIndicator xgetDomesticForeignIndicator();
146             
147             /**
148              * Sets the "DomesticForeignIndicator" element
149              */
150             void setDomesticForeignIndicator(gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study.DomesticForeignIndicator.Enum domesticForeignIndicator);
151             
152             /**
153              * Sets (as xml) the "DomesticForeignIndicator" element
154              */
155             void xsetDomesticForeignIndicator(gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study.DomesticForeignIndicator domesticForeignIndicator);
156             
157             /**
158              * Gets the "Comments" element
159              */
160             java.lang.String getComments();
161             
162             /**
163              * Gets (as xml) the "Comments" element
164              */
165             gov.grants.apply.forms.plannedReportV10.PlannedReportString1500DataType xgetComments();
166             
167             /**
168              * True if has "Comments" element
169              */
170             boolean isSetComments();
171             
172             /**
173              * Sets the "Comments" element
174              */
175             void setComments(java.lang.String comments);
176             
177             /**
178              * Sets (as xml) the "Comments" element
179              */
180             void xsetComments(gov.grants.apply.forms.plannedReportV10.PlannedReportString1500DataType comments);
181             
182             /**
183              * Unsets the "Comments" element
184              */
185             void unsetComments();
186             
187             /**
188              * Gets the "NotHispanic" element
189              */
190             gov.grants.apply.forms.plannedReportV10.PlannedReportEthnicCategoryDataType getNotHispanic();
191             
192             /**
193              * Sets the "NotHispanic" element
194              */
195             void setNotHispanic(gov.grants.apply.forms.plannedReportV10.PlannedReportEthnicCategoryDataType notHispanic);
196             
197             /**
198              * Appends and returns a new empty "NotHispanic" element
199              */
200             gov.grants.apply.forms.plannedReportV10.PlannedReportEthnicCategoryDataType addNewNotHispanic();
201             
202             /**
203              * Gets the "Hispanic" element
204              */
205             gov.grants.apply.forms.plannedReportV10.PlannedReportEthnicCategoryDataType getHispanic();
206             
207             /**
208              * Sets the "Hispanic" element
209              */
210             void setHispanic(gov.grants.apply.forms.plannedReportV10.PlannedReportEthnicCategoryDataType hispanic);
211             
212             /**
213              * Appends and returns a new empty "Hispanic" element
214              */
215             gov.grants.apply.forms.plannedReportV10.PlannedReportEthnicCategoryDataType addNewHispanic();
216             
217             /**
218              * Gets the "Total" element
219              */
220             gov.grants.apply.forms.plannedReportV10.PlannedReportTotalsDataType getTotal();
221             
222             /**
223              * Sets the "Total" element
224              */
225             void setTotal(gov.grants.apply.forms.plannedReportV10.PlannedReportTotalsDataType total);
226             
227             /**
228              * Appends and returns a new empty "Total" element
229              */
230             gov.grants.apply.forms.plannedReportV10.PlannedReportTotalsDataType addNewTotal();
231             
232             /**
233              * An XML DomesticForeignIndicator(@http://apply.grants.gov/forms/PlannedReport-V1.0).
234              *
235              * This is an atomic type that is a restriction of gov.grants.apply.forms.plannedReportV10.PlannedReportDocument$PlannedReport$Study$DomesticForeignIndicator.
236              */
237             public interface DomesticForeignIndicator extends org.apache.xmlbeans.XmlString
238             {
239                 public static final org.apache.xmlbeans.SchemaType type = (org.apache.xmlbeans.SchemaType)
240                     org.apache.xmlbeans.XmlBeans.typeSystemForClassLoader(DomesticForeignIndicator.class.getClassLoader(), "schemaorg_apache_xmlbeans.system.sEAFA503253B0B59D5509A37AD48F2343").resolveHandle("domesticforeignindicator02abelemtype");
241                 
242                 org.apache.xmlbeans.StringEnumAbstractBase enumValue();
243                 void set(org.apache.xmlbeans.StringEnumAbstractBase e);
244                 
245                 static final Enum DOMESTIC = Enum.forString("Domestic");
246                 static final Enum FOREIGN = Enum.forString("Foreign");
247                 
248                 static final int INT_DOMESTIC = Enum.INT_DOMESTIC;
249                 static final int INT_FOREIGN = Enum.INT_FOREIGN;
250                 
251                 /**
252                  * Enumeration value class for gov.grants.apply.forms.plannedReportV10.PlannedReportDocument$PlannedReport$Study$DomesticForeignIndicator.
253                  * These enum values can be used as follows:
254                  * <pre>
255                  * enum.toString(); // returns the string value of the enum
256                  * enum.intValue(); // returns an int value, useful for switches
257                  * // e.g., case Enum.INT_DOMESTIC
258                  * Enum.forString(s); // returns the enum value for a string
259                  * Enum.forInt(i); // returns the enum value for an int
260                  * </pre>
261                  * Enumeration objects are immutable singleton objects that
262                  * can be compared using == object equality. They have no
263                  * public constructor. See the constants defined within this
264                  * class for all the valid values.
265                  */
266                 static final class Enum extends org.apache.xmlbeans.StringEnumAbstractBase
267                 {
268                     /**
269                      * Returns the enum value for a string, or null if none.
270                      */
271                     public static Enum forString(java.lang.String s)
272                         { return (Enum)table.forString(s); }
273                     /**
274                      * Returns the enum value corresponding to an int, or null if none.
275                      */
276                     public static Enum forInt(int i)
277                         { return (Enum)table.forInt(i); }
278                     
279                     private Enum(java.lang.String s, int i)
280                         { super(s, i); }
281                     
282                     static final int INT_DOMESTIC = 1;
283                     static final int INT_FOREIGN = 2;
284                     
285                     public static final org.apache.xmlbeans.StringEnumAbstractBase.Table table =
286                         new org.apache.xmlbeans.StringEnumAbstractBase.Table
287                     (
288                       new Enum[]
289                       {
290                         new Enum("Domestic", INT_DOMESTIC),
291                         new Enum("Foreign", INT_FOREIGN),
292                       }
293                     );
294                     private static final long serialVersionUID = 1L;
295                     private java.lang.Object readResolve() { return forInt(intValue()); } 
296                 }
297                 
298                 /**
299                  * A factory class with static methods for creating instances
300                  * of this type.
301                  */
302                 
303                 public static final class Factory
304                 {
305                     public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study.DomesticForeignIndicator newValue(java.lang.Object obj) {
306                       return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study.DomesticForeignIndicator) type.newValue( obj ); }
307                     
308                     public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study.DomesticForeignIndicator newInstance() {
309                       return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study.DomesticForeignIndicator) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().newInstance( type, null ); }
310                     
311                     public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study.DomesticForeignIndicator newInstance(org.apache.xmlbeans.XmlOptions options) {
312                       return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study.DomesticForeignIndicator) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().newInstance( type, options ); }
313                     
314                     private Factory() { } // No instance of this class allowed
315                 }
316             }
317             
318             /**
319              * A factory class with static methods for creating instances
320              * of this type.
321              */
322             
323             public static final class Factory
324             {
325                 public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study newInstance() {
326                   return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().newInstance( type, null ); }
327                 
328                 public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study newInstance(org.apache.xmlbeans.XmlOptions options) {
329                   return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport.Study) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().newInstance( type, options ); }
330                 
331                 private Factory() { } // No instance of this class allowed
332             }
333         }
334         
335         /**
336          * A factory class with static methods for creating instances
337          * of this type.
338          */
339         
340         public static final class Factory
341         {
342             public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport newInstance() {
343               return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().newInstance( type, null ); }
344             
345             public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport newInstance(org.apache.xmlbeans.XmlOptions options) {
346               return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument.PlannedReport) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().newInstance( type, options ); }
347             
348             private Factory() { } // No instance of this class allowed
349         }
350     }
351     
352     /**
353      * A factory class with static methods for creating instances
354      * of this type.
355      */
356     
357     public static final class Factory
358     {
359         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument newInstance() {
360           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().newInstance( type, null ); }
361         
362         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument newInstance(org.apache.xmlbeans.XmlOptions options) {
363           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().newInstance( type, options ); }
364         
365         /** @param xmlAsString the string value to parse */
366         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(java.lang.String xmlAsString) throws org.apache.xmlbeans.XmlException {
367           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( xmlAsString, type, null ); }
368         
369         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(java.lang.String xmlAsString, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException {
370           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( xmlAsString, type, options ); }
371         
372         /** @param file the file from which to load an xml document */
373         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(java.io.File file) throws org.apache.xmlbeans.XmlException, java.io.IOException {
374           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( file, type, null ); }
375         
376         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(java.io.File file, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
377           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( file, type, options ); }
378         
379         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(java.net.URL u) throws org.apache.xmlbeans.XmlException, java.io.IOException {
380           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( u, type, null ); }
381         
382         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(java.net.URL u, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
383           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( u, type, options ); }
384         
385         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(java.io.InputStream is) throws org.apache.xmlbeans.XmlException, java.io.IOException {
386           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( is, type, null ); }
387         
388         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(java.io.InputStream is, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
389           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( is, type, options ); }
390         
391         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(java.io.Reader r) throws org.apache.xmlbeans.XmlException, java.io.IOException {
392           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( r, type, null ); }
393         
394         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(java.io.Reader r, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
395           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( r, type, options ); }
396         
397         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(javax.xml.stream.XMLStreamReader sr) throws org.apache.xmlbeans.XmlException {
398           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( sr, type, null ); }
399         
400         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(javax.xml.stream.XMLStreamReader sr, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException {
401           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( sr, type, options ); }
402         
403         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(org.w3c.dom.Node node) throws org.apache.xmlbeans.XmlException {
404           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( node, type, null ); }
405         
406         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(org.w3c.dom.Node node, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException {
407           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( node, type, options ); }
408         
409         /** @deprecated {@link org.apache.xmlbeans.xml.stream.XMLInputStream} */
410         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(org.apache.xmlbeans.xml.stream.XMLInputStream xis) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException {
411           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( xis, type, null ); }
412         
413         /** @deprecated {@link org.apache.xmlbeans.xml.stream.XMLInputStream} */
414         public static gov.grants.apply.forms.plannedReportV10.PlannedReportDocument parse(org.apache.xmlbeans.xml.stream.XMLInputStream xis, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException {
415           return (gov.grants.apply.forms.plannedReportV10.PlannedReportDocument) org.apache.xmlbeans.XmlBeans.getContextTypeLoader().parse( xis, type, options ); }
416         
417         /** @deprecated {@link org.apache.xmlbeans.xml.stream.XMLInputStream} */
418         public static org.apache.xmlbeans.xml.stream.XMLInputStream newValidatingXMLInputStream(org.apache.xmlbeans.xml.stream.XMLInputStream xis) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException {
419           return org.apache.xmlbeans.XmlBeans.getContextTypeLoader().newValidatingXMLInputStream( xis, type, null ); }
420         
421         /** @deprecated {@link org.apache.xmlbeans.xml.stream.XMLInputStream} */
422         public static org.apache.xmlbeans.xml.stream.XMLInputStream newValidatingXMLInputStream(org.apache.xmlbeans.xml.stream.XMLInputStream xis, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException {
423           return org.apache.xmlbeans.XmlBeans.getContextTypeLoader().newValidatingXMLInputStream( xis, type, options ); }
424         
425         private Factory() { } // No instance of this class allowed
426     }
427 }