DocumentFolder


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