Document


1   // ----------------------------------------------------------------------------
2   // Instance/IntfBegin
3   // ----------------------------------------------------------------------------
4   //////////////////////////////////////////////////////////////////////////////
5   //
6   // Name: $Id: JMIAbstractMapper.java,v 1.11 2006/01/21 23:09:07 wfro Exp $
7   // Generated by: openMDX JMI Mapper
8   // Date: Mon Apr 03 11:38:57 CEST 2006
9   //
10  // GENERATED - DO NOT CHANGE MANUALLY
11  //
12  //////////////////////////////////////////////////////////////////////////////
13  package org.opencrx.kernel.document1.cci;
14  
15  public interface Document
16    extends
17   org.opencrx.kernel.base.cci.Auditee,
18   org.opencrx.kernel.base.cci.Importer,
19   org.opencrx.kernel.base.cci.SecureObject,
20   org.opencrx.kernel.base.cci.XmlExporter,
21   org.openmdx.base.cci.BasicObject {
22  // ----------------------------------------------------------------------------
23  // Instance/IntfAttributeGet0_1
24  // ----------------------------------------------------------------------------
25    /**
26     * @return The possibly null value for attribute <code>activeOn</code>.
27     * @exception JmiException If the value cannot be retrieved for some reason.
28     */
29    public java.util.Date   getActiveOn(
30    );
31  
32  // ----------------------------------------------------------------------------
33  // Instance/IntfAttributeSet0_1
34  // ----------------------------------------------------------------------------
35  
36  
37    /**
38     * Sets a new value for the attribute <code>activeOn</code>.
39     * @param newValue The possibly null new value for attribute <code>activeOn</code>.
40     * @exception JmiException If the value cannot be set for some reason.
41     */
42    public void setActiveOn(
43      java.util.Date   newValue
44    );
45  
46  // ----------------------------------------------------------------------------
47  // Instance/IntfAttributeGet0_1
48  // ----------------------------------------------------------------------------
49    /**
50     * @return The possibly null value for attribute <code>activeUntil</code>.
51     * @exception JmiException If the value cannot be retrieved for some reason.
52     */
53    public java.util.Date   getActiveUntil(
54    );
55  
56  // ----------------------------------------------------------------------------
57  // Instance/IntfAttributeSet0_1
58  // ----------------------------------------------------------------------------
59  
60  
61    /**
62     * Sets a new value for the attribute <code>activeUntil</code>.
63     * @param newValue The possibly null new value for attribute <code>activeUntil</code>.
64     * @exception JmiException If the value cannot be set for some reason.
65     */
66    public void setActiveUntil(
67      java.util.Date   newValue
68    );
69  
70  // ----------------------------------------------------------------------------
71  // Instance/IntfAttributeGet0_1
72  // ----------------------------------------------------------------------------
73    /**
74     * @return The possibly null value for attribute <code>author</code>.
75     * @exception JmiException If the value cannot be retrieved for some reason.
76     */
77    public String   getAuthor(
78    );
79  
80  // ----------------------------------------------------------------------------
81  // Instance/IntfAttributeSet0_1
82  // ----------------------------------------------------------------------------
83  
84  
85    /**
86     * Sets a new value for the attribute <code>author</code>.
87     * @param newValue The possibly null new value for attribute <code>author</code>.
88     * @exception JmiException If the value cannot be set for some reason.
89     */
90    public void setAuthor(
91      String   newValue
92    );
93  
94  // ----------------------------------------------------------------------------
95  // Instance/IntfAttributeGet1_1
96  // ----------------------------------------------------------------------------
97    /**
98     * Retrieves the value for the attribute <code>contentLanguage</code>.
99     * @return The non-null value for attribute <code>contentLanguage</code>.
100    * @exception JmiException If the value cannot be retrieved for some reason.
101    */
102   public short getContentLanguage(
103   );
104 
105 // ----------------------------------------------------------------------------
106 // Instance/IntfAttributeSet1_1
107 // ----------------------------------------------------------------------------
108   /**
109    * Sets a new value for the attribute <code>contentLanguage</code>.
110    * @param newValue The non-null new value for attribute <code>contentLanguage</code>.
111    * @exception JmiException If the value cannot be set for some reason.
112    */
113   public void setContentLanguage(
114     short newValue
115   );
116 
117 // ----------------------------------------------------------------------------
118 // Instance/IntfAttributeGet0_1
119 // ----------------------------------------------------------------------------
120   /**
121    * @return The possibly null value for attribute <code>contentLength</code>.
122    * @exception JmiException If the value cannot be retrieved for some reason.
123    */
124   public Integer   getContentLength(
125   );
126 
127 // ----------------------------------------------------------------------------
128 // Instance/IntfAttributeSet0_1
129 // ----------------------------------------------------------------------------
130 
131 
132   /**
133    * Sets a new value for the attribute <code>contentLength</code>.
134    * @param newValue The possibly null new value for attribute <code>contentLength</code>.
135    * @exception JmiException If the value cannot be set for some reason.
136    */
137   public void setContentLength(
138     Integer   newValue
139   );
140 
141 // ----------------------------------------------------------------------------
142 // Instance/IntfAttributeGet0_1
143 // ----------------------------------------------------------------------------
144   /**
145    * @return The possibly null value for attribute <code>contentType</code>.
146    * @exception JmiException If the value cannot be retrieved for some reason.
147    */
148   public String   getContentType(
149   );
150 
151 // ----------------------------------------------------------------------------
152 // Instance/IntfAttributeSet0_1
153 // ----------------------------------------------------------------------------
154 
155 
156   /**
157    * Sets a new value for the attribute <code>contentType</code>.
158    * @param newValue The possibly null new value for attribute <code>contentType</code>.
159    * @exception JmiException If the value cannot be set for some reason.
160    */
161   public void setContentType(
162     String   newValue
163   );
164 
165 // ----------------------------------------------------------------------------
166 // Instance/IntfAttributeGet0_1
167 // ----------------------------------------------------------------------------
168   /**
169    * @return The possibly null value for attribute <code>documentAbstract</code>.
170    * @exception JmiException If the value cannot be retrieved for some reason.
171    */
172   public String   getDocumentAbstract(
173   );
174 
175 // ----------------------------------------------------------------------------
176 // Instance/IntfAttributeSet0_1
177 // ----------------------------------------------------------------------------
178 
179 
180   /**
181    * Sets a new value for the attribute <code>documentAbstract</code>.
182    * @param newValue The possibly null new value for attribute <code>documentAbstract</code>.
183    * @exception JmiException If the value cannot be set for some reason.
184    */
185   public void setDocumentAbstract(
186     String   newValue
187   );
188 
189 // ----------------------------------------------------------------------------
190 // Instance/IntfAttributeGet0_1
191 // ----------------------------------------------------------------------------
192   /**
193    * @return The possibly null value for attribute <code>documentNumber</code>.
194    * @exception JmiException If the value cannot be retrieved for some reason.
195    */
196   public String   getDocumentNumber(
197   );
198 
199 // ----------------------------------------------------------------------------
200 // Instance/IntfAttributeSet0_1
201 // ----------------------------------------------------------------------------
202 
203 
204   /**
205    * Sets a new value for the attribute <code>documentNumber</code>.
206    * @param newValue The possibly null new value for attribute <code>documentNumber</code>.
207    * @exception JmiException If the value cannot be set for some reason.
208    */
209   public void setDocumentNumber(
210     String   newValue
211   );
212 
213 // ----------------------------------------------------------------------------
214 // Instance/IntfAttributeGet1_1
215 // ----------------------------------------------------------------------------
216   /**
217    * Retrieves the value for the attribute <code>documentState</code>.
218    * @return The non-null value for attribute <code>documentState</code>.
219    * @exception JmiException If the value cannot be retrieved for some reason.
220    */
221   public short getDocumentState(
222   );
223 
224 // ----------------------------------------------------------------------------
225 // Instance/IntfAttributeSet1_1
226 // ----------------------------------------------------------------------------
227   /**
228    * Sets a new value for the attribute <code>documentState</code>.
229    * @param newValue The non-null new value for attribute <code>documentState</code>.
230    * @exception JmiException If the value cannot be set for some reason.
231    */
232   public void setDocumentState(
233     short newValue
234   );
235 
236 // ----------------------------------------------------------------------------
237 // Instance/IntfAttributeGet1_1
238 // ----------------------------------------------------------------------------
239   /**
240    * Retrieves the value for the attribute <code>documentType</code>.
241    * @return The non-null value for attribute <code>documentType</code>.
242    * @exception JmiException If the value cannot be retrieved for some reason.
243    */
244   public short getDocumentType(
245   );
246 
247 // ----------------------------------------------------------------------------
248 // Instance/IntfAttributeSet1_1
249 // ----------------------------------------------------------------------------
250   /**
251    * Sets a new value for the attribute <code>documentType</code>.
252    * @param newValue The non-null new value for attribute <code>documentType</code>.
253    * @exception JmiException If the value cannot be set for some reason.
254    */
255   public void setDocumentType(
256     short newValue
257   );
258 
259 // ----------------------------------------------------------------------------
260 // Instance/IntfReferenceGet0_1WithQualifier
261 // ----------------------------------------------------------------------------
262   /**
263    * Retrieves the value for the reference <code>folder</code> for the 
264    * specified qualifier attribute value. 
265    * @param index The value for the qualifier attribute that qualifies this reference.
266    * @return The possibly null value for this reference.
267    * @exception JmiException If the value cannot be retrieved for some reason.
268    */
269   public org.opencrx.kernel.document1.cci.DocumentFolder getFolder(
270     int index
271   );
272 
273 // ----------------------------------------------------------------------------
274 // Instance/IntfReferenceGet0_nNoFilter
275 // ----------------------------------------------------------------------------
276   /**
277    * Retrieves the objects referenced by <code>folder</code>. 
278    * @return The collection of referenced objects.
279    * @exception JmiException If the value cannot be retrieved for some reason.
280    */
281   public java.util.Collection   getFolder(
282   );
283 
284 // ----------------------------------------------------------------------------
285 // Instance/IntfReferenceAddWithQualifier
286 // ----------------------------------------------------------------------------
287   /**
288    * @param index The qualifier attribute value that qualifies the reference to get the element to be appended.
289    * @param newValue The element to be appended.
290    * @exception JmiException If the value cannot be appended for some reason.
291    */
292   public void addFolder (
293     int index,
294     org.opencrx.kernel.document1.cci.DocumentFolder newValue
295   );
296 
297 // ----------------------------------------------------------------------------
298 // Instance/IntfReferenceAddWithoutQualifier
299 // ----------------------------------------------------------------------------
300   /**
301    * @param newValue The element to be appended.
302    * @exception JmiException If the value cannot be appended for some reason.
303    */
304   public void addFolder (
305     org.opencrx.kernel.document1.cci.DocumentFolder newValue
306   );
307 
308 // ----------------------------------------------------------------------------
309 // Instance/IntfReferenceRemoveWithQualifier
310 // ----------------------------------------------------------------------------
311   /**
312    * @exception JmiException If the value cannot be removed for some reason.
313    */
314   public void removeFolder (
315     int index
316   );
317 // ----------------------------------------------------------------------------
318 // Instance/IntfReferenceGet0_1NoQualifier
319 // ----------------------------------------------------------------------------
320   /**
321    * Retrieves the value for the optional reference <code>headRevision</code>.
322    * @return The possibly null value for this reference.
323    * @exception JmiException If the value cannot be retrieved for some reason.
324    */
325   public org.opencrx.kernel.document1.cci.DocumentRevision getHeadRevision(
326   );
327 
328 // ----------------------------------------------------------------------------
329 // Instance/IntfReferenceSetNoQualifier
330 // ----------------------------------------------------------------------------
331   /**
332    * Sets a new value for the reference <code>headRevision</code>.
333    * @param newValue The non-null new value for this reference.
334    * @exception JmiException If the value cannot be set for some reason.
335    */
336   public void setHeadRevision(
337     org.opencrx.kernel.document1.cci.DocumentRevision newValue
338   );
339 
340 // ----------------------------------------------------------------------------
341 // Instance/IntfReferenceRemoveOptional
342 // ----------------------------------------------------------------------------
343   /**
344    * Removes the value for the optional reference <code>headRevision</code>.
345    * @exception JmiException If the value cannot be removed for some reason.
346    */
347   public void removeHeadRevision (
348   );
349 
350 // ----------------------------------------------------------------------------
351 // Instance/IntfAttributeGet0_1
352 // ----------------------------------------------------------------------------
353   /**
354    * @return The possibly null value for attribute <code>keywords</code>.
355    * @exception JmiException If the value cannot be retrieved for some reason.
356    */
357   public String   getKeywords(
358   );
359 
360 // ----------------------------------------------------------------------------
361 // Instance/IntfAttributeSet0_1
362 // ----------------------------------------------------------------------------
363 
364 
365   /**
366    * Sets a new value for the attribute <code>keywords</code>.
367    * @param newValue The possibly null new value for attribute <code>keywords</code>.
368    * @exception JmiException If the value cannot be set for some reason.
369    */
370   public void setKeywords(
371     String   newValue
372   );
373 
374 // ----------------------------------------------------------------------------
375 // Instance/IntfAttributeGet1_1
376 // ----------------------------------------------------------------------------
377   /**
378    * Retrieves the value for the attribute <code>literatureType</code>.
379    * @return The non-null value for attribute <code>literatureType</code>.
380    * @exception JmiException If the value cannot be retrieved for some reason.
381    */
382   public short getLiteratureType(
383   );
384 
385 // ----------------------------------------------------------------------------
386 // Instance/IntfAttributeSet1_1
387 // ----------------------------------------------------------------------------
388   /**
389    * Sets a new value for the attribute <code>literatureType</code>.
390    * @param newValue The non-null new value for attribute <code>literatureType</code>.
391    * @exception JmiException If the value cannot be set for some reason.
392    */
393   public void setLiteratureType(
394     short newValue
395   );
396 
397 // ----------------------------------------------------------------------------
398 // Instance/IntfAttributeGet0_1
399 // ----------------------------------------------------------------------------
400   /**
401    * @return The possibly null value for attribute <code>location</code>.
402    * @exception JmiException If the value cannot be retrieved for some reason.
403    */
404   public String   getLocation(
405   );
406 
407 // ----------------------------------------------------------------------------
408 // Instance/IntfAttributeSet0_1
409 // ----------------------------------------------------------------------------
410 
411 
412   /**
413    * Sets a new value for the attribute <code>location</code>.
414    * @param newValue The possibly null new value for attribute <code>location</code>.
415    * @exception JmiException If the value cannot be set for some reason.
416    */
417   public void setLocation(
418     String   newValue
419   );
420 
421 // ----------------------------------------------------------------------------
422 // Instance/IntfReferenceGet0_1WithQualifier
423 // ----------------------------------------------------------------------------
424   /**
425    * Retrieves the value for the reference <code>revision</code> for the 
426    * specified qualifier attribute value. 
427    * @param id The value for the qualifier attribute that qualifies this reference.
428    * @return The possibly null value for this reference.
429    * @exception JmiException If the value cannot be retrieved for some reason.
430    */
431   public org.opencrx.kernel.document1.cci.DocumentRevision getRevision(
432     String   id
433   );
434 
435 // ----------------------------------------------------------------------------
436 // Instance/IntfReferenceGet0_nWithFilter
437 // ----------------------------------------------------------------------------
438   /**
439    * Retrieves a collection containing all the elements for the reference 
440    * <code>revision</code>. 
441    * @return A collection containing all the elements for this reference.
442    * @exception JmiException If the values cannot be retrieved for some reason.
443    */
444   public java.util.Collection   getRevision(
445   );
446 
447   /**
448    * Retrieves the value for the reference <code>revision</code> for the 
449    * specified filter. 
450    * @param filter filter which is applied to the set of referenced objects.
451    * @return The filtered collection of referenced objects.
452    * @exception JmiException If the value cannot be retrieved for some reason.
453    */
454   public java.util.List   getRevision(
455     org.opencrx.kernel.document1.cci.DocumentRevisionFilter filter
456   );
457 
458 // ----------------------------------------------------------------------------
459 // Instance/IntfReferenceAddWithQualifier
460 // ----------------------------------------------------------------------------
461   /**
462    * @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
463    * @param newValue The element to be appended.
464    * @exception JmiException If the value cannot be appended for some reason.
465    */
466   public void addRevision (
467     String   id,
468     org.opencrx.kernel.document1.cci.DocumentRevision newValue
469   );
470 
471 // ----------------------------------------------------------------------------
472 // Instance/IntfReferenceAddWithoutQualifier
473 // ----------------------------------------------------------------------------
474   /**
475    * @param newValue The element to be appended.
476    * @exception JmiException If the value cannot be appended for some reason.
477    */
478   public void addRevision (
479     org.opencrx.kernel.document1.cci.DocumentRevision newValue
480   );
481 
482 // ----------------------------------------------------------------------------
483 // Instance/IntfReferenceRemoveWithQualifier
484 // ----------------------------------------------------------------------------
485   /**
486    * @exception JmiException If the value cannot be removed for some reason.
487    */
488   public void removeRevision (
489     String   id
490   );
491 // ----------------------------------------------------------------------------
492 // Instance/IntfAttributeGet0_1
493 // ----------------------------------------------------------------------------
494   /**
495    * @return The possibly null value for attribute <code>searchText</code>.
496    * @exception JmiException If the value cannot be retrieved for some reason.
497    */
498   public String   getSearchText(
499   );
500 
501 // ----------------------------------------------------------------------------
502 // Instance/IntfAttributeSet0_1
503 // ----------------------------------------------------------------------------
504 
505 
506   /**
507    * Sets a new value for the attribute <code>searchText</code>.
508    * @param newValue The possibly null new value for attribute <code>searchText</code>.
509    * @exception JmiException If the value cannot be set for some reason.
510    */
511   public void setSearchText(
512     String   newValue
513   );
514 
515 // ----------------------------------------------------------------------------
516 // Instance/IntfAttributeGet0_1
517 // ----------------------------------------------------------------------------
518   /**
519    * @return The possibly null value for attribute <code>title</code>.
520    * @exception JmiException If the value cannot be retrieved for some reason.
521    */
522   public String   getTitle(
523   );
524 
525 // ----------------------------------------------------------------------------
526 // Instance/IntfAttributeSet0_1
527 // ----------------------------------------------------------------------------
528 
529 
530   /**
531    * Sets a new value for the attribute <code>title</code>.
532    * @param newValue The possibly null new value for attribute <code>title</code>.
533    * @exception JmiException If the value cannot be set for some reason.
534    */
535   public void setTitle(
536     String   newValue
537   );
538 
539 // ----------------------------------------------------------------------------
540 // Instance/IntfEnd.vm
541 // ----------------------------------------------------------------------------
542 }
543
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags