KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencrx > kernel > activity1 > cci > Mailing


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:39:02 CEST 2006
9
//
10
// GENERATED - DO NOT CHANGE MANUALLY
11
//
12
//////////////////////////////////////////////////////////////////////////////
13
package org.opencrx.kernel.activity1.cci;
14
15 public interface Mailing
16   extends
17  org.opencrx.kernel.activity1.cci.Activity {
18 // ----------------------------------------------------------------------------
19
// Instance/IntfAttributeGet0_1
20
// ----------------------------------------------------------------------------
21
/**
22    * @return The possibly null value for attribute <code>document</code>.
23    * @exception JmiException If the value cannot be retrieved for some reason.
24    */

25   public String JavaDoc getDocument(
26   );
27
28 // ----------------------------------------------------------------------------
29
// Instance/IntfAttributeSet0_1
30
// ----------------------------------------------------------------------------
31

32
33   /**
34    * Sets a new value for the attribute <code>document</code>.
35    * @param newValue The possibly null new value for attribute <code>document</code>.
36    * @exception JmiException If the value cannot be set for some reason.
37    */

38   public void setDocument(
39     String JavaDoc newValue
40   );
41
42 // ----------------------------------------------------------------------------
43
// Instance/IntfReferenceGet0_1WithQualifier
44
// ----------------------------------------------------------------------------
45
/**
46    * Retrieves the value for the reference <code>mailingRecipient</code> for
47    * the specified qualifier attribute value.
48    * @param id The value for the qualifier attribute that qualifies this reference.
49    * @return The possibly null value for this reference.
50    * @exception JmiException If the value cannot be retrieved for some reason.
51    */

52   public org.opencrx.kernel.activity1.cci.AbstractMailingRecipient getMailingRecipient(
53     String JavaDoc id
54   );
55
56 // ----------------------------------------------------------------------------
57
// Instance/IntfReferenceGet0_nWithFilter
58
// ----------------------------------------------------------------------------
59
/**
60    * Retrieves a collection containing all the elements for the reference
61    * <code>mailingRecipient</code>.
62    * @return A collection containing all the elements for this reference.
63    * @exception JmiException If the values cannot be retrieved for some reason.
64    */

65   public java.util.Collection JavaDoc getMailingRecipient(
66   );
67
68   /**
69    * Retrieves the value for the reference <code>mailingRecipient</code> for
70    * the specified filter.
71    * @param filter filter which is applied to the set of referenced objects.
72    * @return The filtered collection of referenced objects.
73    * @exception JmiException If the value cannot be retrieved for some reason.
74    */

75   public java.util.List JavaDoc getMailingRecipient(
76     org.opencrx.kernel.activity1.cci.AbstractMailingRecipientFilter filter
77   );
78
79 // ----------------------------------------------------------------------------
80
// Instance/IntfReferenceAddWithQualifier
81
// ----------------------------------------------------------------------------
82
/**
83    * @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
84    * @param newValue The element to be appended.
85    * @exception JmiException If the value cannot be appended for some reason.
86    */

87   public void addMailingRecipient (
88     String JavaDoc id,
89     org.opencrx.kernel.activity1.cci.AbstractMailingRecipient newValue
90   );
91
92 // ----------------------------------------------------------------------------
93
// Instance/IntfReferenceAddWithoutQualifier
94
// ----------------------------------------------------------------------------
95
/**
96    * @param newValue The element to be appended.
97    * @exception JmiException If the value cannot be appended for some reason.
98    */

99   public void addMailingRecipient (
100     org.opencrx.kernel.activity1.cci.AbstractMailingRecipient newValue
101   );
102
103 // ----------------------------------------------------------------------------
104
// Instance/IntfReferenceRemoveWithQualifier
105
// ----------------------------------------------------------------------------
106
/**
107    * @exception JmiException If the value cannot be removed for some reason.
108    */

109   public void removeMailingRecipient (
110     String JavaDoc id
111   );
112 // ----------------------------------------------------------------------------
113
// Instance/IntfReferenceGet0_1NoQualifier
114
// ----------------------------------------------------------------------------
115
/**
116    * Retrieves the value for the optional reference <code>sender</code>.
117    * @return The possibly null value for this reference.
118    * @exception JmiException If the value cannot be retrieved for some reason.
119    */

120   public org.opencrx.kernel.account1.cci.PostalAddress getSender(
121   );
122
123 // ----------------------------------------------------------------------------
124
// Instance/IntfReferenceSetNoQualifier
125
// ----------------------------------------------------------------------------
126
/**
127    * Sets a new value for the reference <code>sender</code>.
128    * @param newValue The non-null new value for this reference.
129    * @exception JmiException If the value cannot be set for some reason.
130    */

131   public void setSender(
132     org.opencrx.kernel.account1.cci.PostalAddress newValue
133   );
134
135 // ----------------------------------------------------------------------------
136
// Instance/IntfReferenceRemoveOptional
137
// ----------------------------------------------------------------------------
138
/**
139    * Removes the value for the optional reference <code>sender</code>.
140    * @exception JmiException If the value cannot be removed for some reason.
141    */

142   public void removeSender (
143   );
144
145 // ----------------------------------------------------------------------------
146
// Instance/IntfAttributeGet0_1
147
// ----------------------------------------------------------------------------
148
/**
149    * @return The possibly null value for attribute <code>template</code>.
150    * @exception JmiException If the value cannot be retrieved for some reason.
151    */

152   public String JavaDoc getTemplate(
153   );
154
155 // ----------------------------------------------------------------------------
156
// Instance/IntfAttributeSet0_1
157
// ----------------------------------------------------------------------------
158

159
160   /**
161    * Sets a new value for the attribute <code>template</code>.
162    * @param newValue The possibly null new value for attribute <code>template</code>.
163    * @exception JmiException If the value cannot be set for some reason.
164    */

165   public void setTemplate(
166     String JavaDoc newValue
167   );
168
169 // ----------------------------------------------------------------------------
170
// Instance/IntfEnd.vm
171
// ----------------------------------------------------------------------------
172
}
173
Popular Tags