Segment


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 Segment
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.Segment {
22  // ----------------------------------------------------------------------------
23  // Instance/IntfReferenceGet0_1WithQualifier
24  // ----------------------------------------------------------------------------
25    /**
26     * Retrieves the value for the reference <code>document</code> for the 
27     * specified qualifier attribute value. 
28     * @param id The value for the qualifier attribute that qualifies this reference.
29     * @return The possibly null value for this reference.
30     * @exception JmiException If the value cannot be retrieved for some reason.
31     */
32    public org.opencrx.kernel.document1.cci.Document getDocument(
33      String   id
34    );
35  
36  // ----------------------------------------------------------------------------
37  // Instance/IntfReferenceGet0_nWithFilter
38  // ----------------------------------------------------------------------------
39    /**
40     * Retrieves a collection containing all the elements for the reference 
41     * <code>document</code>. 
42     * @return A collection containing all the elements for this reference.
43     * @exception JmiException If the values cannot be retrieved for some reason.
44     */
45    public java.util.Collection   getDocument(
46    );
47  
48    /**
49     * Retrieves the value for the reference <code>document</code> for the 
50     * specified filter. 
51     * @param filter filter which is applied to the set of referenced objects.
52     * @return The filtered collection of referenced objects.
53     * @exception JmiException If the value cannot be retrieved for some reason.
54     */
55    public java.util.List   getDocument(
56      org.opencrx.kernel.document1.cci.DocumentFilter filter
57    );
58  
59  // ----------------------------------------------------------------------------
60  // Instance/IntfReferenceAddWithQualifier
61  // ----------------------------------------------------------------------------
62    /**
63     * @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
64     * @param newValue The element to be appended.
65     * @exception JmiException If the value cannot be appended for some reason.
66     */
67    public void addDocument (
68      String   id,
69      org.opencrx.kernel.document1.cci.Document newValue
70    );
71  
72  // ----------------------------------------------------------------------------
73  // Instance/IntfReferenceAddWithoutQualifier
74  // ----------------------------------------------------------------------------
75    /**
76     * @param newValue The element to be appended.
77     * @exception JmiException If the value cannot be appended for some reason.
78     */
79    public void addDocument (
80      org.opencrx.kernel.document1.cci.Document newValue
81    );
82  
83  // ----------------------------------------------------------------------------
84  // Instance/IntfReferenceRemoveWithQualifier
85  // ----------------------------------------------------------------------------
86    /**
87     * @exception JmiException If the value cannot be removed for some reason.
88     */
89    public void removeDocument (
90      String   id
91    );
92  // ----------------------------------------------------------------------------
93  // Instance/IntfReferenceGet0_1WithQualifier
94  // ----------------------------------------------------------------------------
95    /**
96     * Retrieves the value for the reference <code>folder</code> for the 
97     * specified qualifier attribute value. 
98     * @param id The value for the qualifier attribute that qualifies this reference.
99     * @return The possibly null value for this reference.
100    * @exception JmiException If the value cannot be retrieved for some reason.
101    */
102   public org.opencrx.kernel.document1.cci.DocumentFolder getFolder(
103     String   id
104   );
105 
106 // ----------------------------------------------------------------------------
107 // Instance/IntfReferenceGet0_nWithFilter
108 // ----------------------------------------------------------------------------
109   /**
110    * Retrieves a collection containing all the elements for the reference 
111    * <code>folder</code>. 
112    * @return A collection containing all the elements for this reference.
113    * @exception JmiException If the values cannot be retrieved for some reason.
114    */
115   public java.util.Collection   getFolder(
116   );
117 
118   /**
119    * Retrieves the value for the reference <code>folder</code> for the 
120    * specified filter. 
121    * @param filter filter which is applied to the set of referenced objects.
122    * @return The filtered collection of referenced objects.
123    * @exception JmiException If the value cannot be retrieved for some reason.
124    */
125   public java.util.List   getFolder(
126     org.opencrx.kernel.document1.cci.DocumentFolderFilter filter
127   );
128 
129 // ----------------------------------------------------------------------------
130 // Instance/IntfReferenceAddWithQualifier
131 // ----------------------------------------------------------------------------
132   /**
133    * @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
134    * @param newValue The element to be appended.
135    * @exception JmiException If the value cannot be appended for some reason.
136    */
137   public void addFolder (
138     String   id,
139     org.opencrx.kernel.document1.cci.DocumentFolder newValue
140   );
141 
142 // ----------------------------------------------------------------------------
143 // Instance/IntfReferenceAddWithoutQualifier
144 // ----------------------------------------------------------------------------
145   /**
146    * @param newValue The element to be appended.
147    * @exception JmiException If the value cannot be appended for some reason.
148    */
149   public void addFolder (
150     org.opencrx.kernel.document1.cci.DocumentFolder newValue
151   );
152 
153 // ----------------------------------------------------------------------------
154 // Instance/IntfReferenceRemoveWithQualifier
155 // ----------------------------------------------------------------------------
156   /**
157    * @exception JmiException If the value cannot be removed for some reason.
158    */
159   public void removeFolder (
160     String   id
161   );
162 // ----------------------------------------------------------------------------
163 // Instance/IntfEnd.vm
164 // ----------------------------------------------------------------------------
165 }
166
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags