Depot


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