DepotEntity


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:56 CEST 2006
9   //
10  // GENERATED - DO NOT CHANGE MANUALLY
11  //
12  //////////////////////////////////////////////////////////////////////////////
13  package org.opencrx.kernel.depot1.cci;
14  
15  public interface DepotEntity
16    extends
17   org.opencrx.kernel.generic.cci.CrxObject {
18  // ----------------------------------------------------------------------------
19  // Instance/IntfReferenceGet0_1WithQualifier
20  // ----------------------------------------------------------------------------
21    /**
22     * Retrieves the value for the reference <code>bookingPeriod</code> for 
23     * the specified qualifier attribute value. 
24     * @param id The value for the qualifier attribute that qualifies this reference.
25     * @return The possibly null value for this reference.
26     * @exception JmiException If the value cannot be retrieved for some reason.
27     */
28    public org.opencrx.kernel.depot1.cci.BookingPeriod getBookingPeriod(
29      String   id
30    );
31  
32  // ----------------------------------------------------------------------------
33  // Instance/IntfReferenceGet0_nWithFilter
34  // ----------------------------------------------------------------------------
35    /**
36     * Retrieves a collection containing all the elements for the reference 
37     * <code>bookingPeriod</code>. 
38     * @return A collection containing all the elements for this reference.
39     * @exception JmiException If the values cannot be retrieved for some reason.
40     */
41    public java.util.Collection   getBookingPeriod(
42    );
43  
44    /**
45     * Retrieves the value for the reference <code>bookingPeriod</code> for 
46     * the specified filter. 
47     * @param filter filter which is applied to the set of referenced objects.
48     * @return The filtered collection of referenced objects.
49     * @exception JmiException If the value cannot be retrieved for some reason.
50     */
51    public java.util.List   getBookingPeriod(
52      org.opencrx.kernel.depot1.cci.BookingPeriodFilter filter
53    );
54  
55  // ----------------------------------------------------------------------------
56  // Instance/IntfReferenceAddWithQualifier
57  // ----------------------------------------------------------------------------
58    /**
59     * @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
60     * @param newValue The element to be appended.
61     * @exception JmiException If the value cannot be appended for some reason.
62     */
63    public void addBookingPeriod (
64      String   id,
65      org.opencrx.kernel.depot1.cci.BookingPeriod newValue
66    );
67  
68  // ----------------------------------------------------------------------------
69  // Instance/IntfReferenceAddWithoutQualifier
70  // ----------------------------------------------------------------------------
71    /**
72     * @param newValue The element to be appended.
73     * @exception JmiException If the value cannot be appended for some reason.
74     */
75    public void addBookingPeriod (
76      org.opencrx.kernel.depot1.cci.BookingPeriod newValue
77    );
78  
79  // ----------------------------------------------------------------------------
80  // Instance/IntfReferenceRemoveWithQualifier
81  // ----------------------------------------------------------------------------
82    /**
83     * @exception JmiException If the value cannot be removed for some reason.
84     */
85    public void removeBookingPeriod (
86      String   id
87    );
88  // ----------------------------------------------------------------------------
89  // Instance/IntfReferenceGet0_1WithQualifier
90  // ----------------------------------------------------------------------------
91    /**
92     * Retrieves the value for the reference <code>bookingText</code> for the 
93     * specified qualifier attribute value. 
94     * @param id The value for the qualifier attribute that qualifies this reference.
95     * @return The possibly null value for this reference.
96     * @exception JmiException If the value cannot be retrieved for some reason.
97     */
98    public org.opencrx.kernel.depot1.cci.BookingText getBookingText(
99      String   id
100   );
101 
102 // ----------------------------------------------------------------------------
103 // Instance/IntfReferenceGet0_nWithFilter
104 // ----------------------------------------------------------------------------
105   /**
106    * Retrieves a collection containing all the elements for the reference 
107    * <code>bookingText</code>. 
108    * @return A collection containing all the elements for this reference.
109    * @exception JmiException If the values cannot be retrieved for some reason.
110    */
111   public java.util.Collection   getBookingText(
112   );
113 
114   /**
115    * Retrieves the value for the reference <code>bookingText</code> for the 
116    * specified filter. 
117    * @param filter filter which is applied to the set of referenced objects.
118    * @return The filtered collection of referenced objects.
119    * @exception JmiException If the value cannot be retrieved for some reason.
120    */
121   public java.util.List   getBookingText(
122     org.opencrx.kernel.depot1.cci.BookingTextFilter filter
123   );
124 
125 // ----------------------------------------------------------------------------
126 // Instance/IntfReferenceAddWithQualifier
127 // ----------------------------------------------------------------------------
128   /**
129    * @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
130    * @param newValue The element to be appended.
131    * @exception JmiException If the value cannot be appended for some reason.
132    */
133   public void addBookingText (
134     String   id,
135     org.opencrx.kernel.depot1.cci.BookingText newValue
136   );
137 
138 // ----------------------------------------------------------------------------
139 // Instance/IntfReferenceAddWithoutQualifier
140 // ----------------------------------------------------------------------------
141   /**
142    * @param newValue The element to be appended.
143    * @exception JmiException If the value cannot be appended for some reason.
144    */
145   public void addBookingText (
146     org.opencrx.kernel.depot1.cci.BookingText newValue
147   );
148 
149 // ----------------------------------------------------------------------------
150 // Instance/IntfReferenceRemoveWithQualifier
151 // ----------------------------------------------------------------------------
152   /**
153    * @exception JmiException If the value cannot be removed for some reason.
154    */
155   public void removeBookingText (
156     String   id
157   );
158 // ----------------------------------------------------------------------------
159 // Instance/IntfOperation
160 // ----------------------------------------------------------------------------
161 
162   public org.opencrx.kernel.depot1.cci.CreateBookingResult createBookingByPosition(
163       org.opencrx.kernel.depot1.cci.CreateBookingByPositionParams params
164   ) throws javax.jmi.reflect.RefException  ;
165 
166   /**
167    */
168   public org.opencrx.kernel.depot1.cci.CreateBookingResult createBookingByPosition(
169       org.opencrx.kernel.depot1.cci.BookingText bookingText
170     , String   bookingTextName
171     , short bookingType
172     , org.opencrx.kernel.depot1.cci.DepotPosition positionCredit
173     , org.opencrx.kernel.depot1.cci.DepotPosition positionDebit
174     , java.math.BigDecimal   quantity
175     , org.opencrx.kernel.depot1.cci.CompoundBooking reversalOf
176     , java.util.Date   valueDate
177   ) throws javax.jmi.reflect.RefException  ;
178 
179 // ----------------------------------------------------------------------------
180 // Instance/IntfOperation
181 // ----------------------------------------------------------------------------
182 
183   public org.opencrx.kernel.depot1.cci.CreateBookingResult createBookingByPositionName(
184       org.opencrx.kernel.depot1.cci.CreateBookingByPositionNameParams params
185   ) throws javax.jmi.reflect.RefException  ;
186 
187   /**
188    */
189   public org.opencrx.kernel.depot1.cci.CreateBookingResult createBookingByPositionName(
190       org.opencrx.kernel.depot1.cci.BookingText bookingText
191     , String   bookingTextName
192     , short bookingType
193     , org.opencrx.kernel.depot1.cci.Depot depotCredit
194     , org.opencrx.kernel.depot1.cci.Depot depotDebit
195     , String   depotNumberCredit
196     , String   depotNumberDebit
197     , String   positionName
198     , java.math.BigDecimal   quantity
199     , org.opencrx.kernel.depot1.cci.CompoundBooking reversalOf
200     , java.util.Date   valueDate
201   ) throws javax.jmi.reflect.RefException  ;
202 
203 // ----------------------------------------------------------------------------
204 // Instance/IntfOperation
205 // ----------------------------------------------------------------------------
206 
207   public org.opencrx.kernel.depot1.cci.CreateBookingResult createBookingByProduct(
208       org.opencrx.kernel.depot1.cci.CreateBookingByProductParams params
209   ) throws javax.jmi.reflect.RefException  ;
210 
211   /**
212    */
213   public org.opencrx.kernel.depot1.cci.CreateBookingResult createBookingByProduct(
214       org.opencrx.kernel.depot1.cci.BookingText bookingText
215     , String   bookingTextName
216     , short bookingType
217     , org.opencrx.kernel.depot1.cci.Depot depotCredit
218     , org.opencrx.kernel.depot1.cci.Depot depotDebit
219     , String   depotNumberCredit
220     , String   depotNumberDebit
221     , org.opencrx.kernel.product1.cci.Product product
222     , java.math.BigDecimal   quantity
223     , org.opencrx.kernel.depot1.cci.CompoundBooking reversalOf
224     , java.util.Date   valueDate
225   ) throws javax.jmi.reflect.RefException  ;
226 
227 // ----------------------------------------------------------------------------
228 // Instance/IntfReferenceGet0_1WithQualifier
229 // ----------------------------------------------------------------------------
230   /**
231    * Retrieves the value for the reference <code>depot</code> for the 
232    * specified qualifier attribute value. 
233    * @param id The value for the qualifier attribute that qualifies this reference.
234    * @return The possibly null value for this reference.
235    * @exception JmiException If the value cannot be retrieved for some reason.
236    */
237   public org.opencrx.kernel.depot1.cci.Depot getDepot(
238     String   id
239   );
240 
241 // ----------------------------------------------------------------------------
242 // Instance/IntfReferenceGet0_nWithFilter
243 // ----------------------------------------------------------------------------
244   /**
245    * Retrieves a collection containing all the elements for the reference 
246    * <code>depot</code>. 
247    * @return A collection containing all the elements for this reference.
248    * @exception JmiException If the values cannot be retrieved for some reason.
249    */
250   public java.util.Collection   getDepot(
251   );
252 
253   /**
254    * Retrieves the value for the reference <code>depot</code> for the 
255    * specified filter. 
256    * @param filter filter which is applied to the set of referenced objects.
257    * @return The filtered collection of referenced objects.
258    * @exception JmiException If the value cannot be retrieved for some reason.
259    */
260   public java.util.List   getDepot(
261     org.opencrx.kernel.depot1.cci.DepotFilter filter
262   );
263 
264 // ----------------------------------------------------------------------------
265 // Instance/IntfAttributeGet1_1
266 // ----------------------------------------------------------------------------
267   /**
268    * Retrieves the value for the attribute <code>depotEntityNumber</code>.
269    * @return The non-null value for attribute <code>depotEntityNumber</code>.
270    * @exception JmiException If the value cannot be retrieved for some reason.
271    */
272   public String   getDepotEntityNumber(
273   );
274 
275 // ----------------------------------------------------------------------------
276 // Instance/IntfAttributeSet1_1
277 // ----------------------------------------------------------------------------
278   /**
279    * Sets a new value for the attribute <code>depotEntityNumber</code>.
280    * @param newValue The non-null new value for attribute <code>depotEntityNumber</code>.
281    * @exception JmiException If the value cannot be set for some reason.
282    */
283   public void setDepotEntityNumber(
284     String   newValue
285   );
286 
287 // ----------------------------------------------------------------------------
288 // Instance/IntfReferenceGet0_1WithQualifier
289 // ----------------------------------------------------------------------------
290   /**
291    * Retrieves the value for the reference <code>depotGroup</code> for the 
292    * specified qualifier attribute value. 
293    * @param id The value for the qualifier attribute that qualifies this reference.
294    * @return The possibly null value for this reference.
295    * @exception JmiException If the value cannot be retrieved for some reason.
296    */
297   public org.opencrx.kernel.depot1.cci.DepotGroup getDepotGroup(
298     String   id
299   );
300 
301 // ----------------------------------------------------------------------------
302 // Instance/IntfReferenceGet0_nWithFilter
303 // ----------------------------------------------------------------------------
304   /**
305    * Retrieves a collection containing all the elements for the reference 
306    * <code>depotGroup</code>. 
307    * @return A collection containing all the elements for this reference.
308    * @exception JmiException If the values cannot be retrieved for some reason.
309    */
310   public java.util.Collection   getDepotGroup(
311   );
312 
313   /**
314    * Retrieves the value for the reference <code>depotGroup</code> for the 
315    * specified filter. 
316    * @param filter filter which is applied to the set of referenced objects.
317    * @return The filtered collection of referenced objects.
318    * @exception JmiException If the value cannot be retrieved for some reason.
319    */
320   public java.util.List   getDepotGroup(
321     org.opencrx.kernel.depot1.cci.DepotGroupFilter filter
322   );
323 
324 // ----------------------------------------------------------------------------
325 // Instance/IntfReferenceAddWithQualifier
326 // ----------------------------------------------------------------------------
327   /**
328    * @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
329    * @param newValue The element to be appended.
330    * @exception JmiException If the value cannot be appended for some reason.
331    */
332   public void addDepotGroup (
333     String   id,
334     org.opencrx.kernel.depot1.cci.DepotGroup newValue
335   );
336 
337 // ----------------------------------------------------------------------------
338 // Instance/IntfReferenceAddWithoutQualifier
339 // ----------------------------------------------------------------------------
340   /**
341    * @param newValue The element to be appended.
342    * @exception JmiException If the value cannot be appended for some reason.
343    */
344   public void addDepotGroup (
345     org.opencrx.kernel.depot1.cci.DepotGroup newValue
346   );
347 
348 // ----------------------------------------------------------------------------
349 // Instance/IntfReferenceRemoveWithQualifier
350 // ----------------------------------------------------------------------------
351   /**
352    * @exception JmiException If the value cannot be removed for some reason.
353    */
354   public void removeDepotGroup (
355     String   id
356   );
357 // ----------------------------------------------------------------------------
358 // Instance/IntfReferenceGet0_1WithQualifier
359 // ----------------------------------------------------------------------------
360   /**
361    * Retrieves the value for the reference <code>depotHolder</code> for the 
362    * specified qualifier attribute value. 
363    * @param id The value for the qualifier attribute that qualifies this reference.
364    * @return The possibly null value for this reference.
365    * @exception JmiException If the value cannot be retrieved for some reason.
366    */
367   public org.opencrx.kernel.depot1.cci.DepotHolder getDepotHolder(
368     String   id
369   );
370 
371 // ----------------------------------------------------------------------------
372 // Instance/IntfReferenceGet0_nWithFilter
373 // ----------------------------------------------------------------------------
374   /**
375    * Retrieves a collection containing all the elements for the reference 
376    * <code>depotHolder</code>. 
377    * @return A collection containing all the elements for this reference.
378    * @exception JmiException If the values cannot be retrieved for some reason.
379    */
380   public java.util.Collection   getDepotHolder(
381   );
382 
383   /**
384    * Retrieves the value for the reference <code>depotHolder</code> for the 
385    * specified filter. 
386    * @param filter filter which is applied to the set of referenced objects.
387    * @return The filtered collection of referenced objects.
388    * @exception JmiException If the value cannot be retrieved for some reason.
389    */
390   public java.util.List   getDepotHolder(
391     org.opencrx.kernel.depot1.cci.DepotHolderFilter filter
392   );
393 
394 // ----------------------------------------------------------------------------
395 // Instance/IntfReferenceAddWithQualifier
396 // ----------------------------------------------------------------------------
397   /**
398    * @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
399    * @param newValue The element to be appended.
400    * @exception JmiException If the value cannot be appended for some reason.
401    */
402   public void addDepotHolder (
403     String   id,
404     org.opencrx.kernel.depot1.cci.DepotHolder newValue
405   );
406 
407 // ----------------------------------------------------------------------------
408 // Instance/IntfReferenceAddWithoutQualifier
409 // ----------------------------------------------------------------------------
410   /**
411    * @param newValue The element to be appended.
412    * @exception JmiException If the value cannot be appended for some reason.
413    */
414   public void addDepotHolder (
415     org.opencrx.kernel.depot1.cci.DepotHolder newValue
416   );
417 
418 // ----------------------------------------------------------------------------
419 // Instance/IntfReferenceRemoveWithQualifier
420 // ----------------------------------------------------------------------------
421   /**
422    * @exception JmiException If the value cannot be removed for some reason.
423    */
424   public void removeDepotHolder (
425     String   id
426   );
427 // ----------------------------------------------------------------------------
428 // Instance/IntfAttributeGet0_1
429 // ----------------------------------------------------------------------------
430   /**
431    * @return The possibly null value for attribute <code>description</code>.
432    * @exception JmiException If the value cannot be retrieved for some reason.
433    */
434   public String   getDescription(
435   );
436 
437 // ----------------------------------------------------------------------------
438 // Instance/IntfAttributeSet0_1
439 // ----------------------------------------------------------------------------
440 
441 
442   /**
443    * Sets a new value for the attribute <code>description</code>.
444    * @param newValue The possibly null new value for attribute <code>description</code>.
445    * @exception JmiException If the value cannot be set for some reason.
446    */
447   public void setDescription(
448     String   newValue
449   );
450 
451 // ----------------------------------------------------------------------------
452 // Instance/IntfAttributeGet1_1
453 // ----------------------------------------------------------------------------
454   /**
455    * Retrieves the value for the attribute <code>name</code>.
456    * @return The non-null value for attribute <code>name</code>.
457    * @exception JmiException If the value cannot be retrieved for some reason.
458    */
459   public String   getName(
460   );
461 
462 // ----------------------------------------------------------------------------
463 // Instance/IntfAttributeSet1_1
464 // ----------------------------------------------------------------------------
465   /**
466    * Sets a new value for the attribute <code>name</code>.
467    * @param newValue The non-null new value for attribute <code>name</code>.
468    * @exception JmiException If the value cannot be set for some reason.
469    */
470   public void setName(
471     String   newValue
472   );
473 
474 // ----------------------------------------------------------------------------
475 // Instance/IntfEnd.vm
476 // ----------------------------------------------------------------------------
477 }
478
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags