← Back to branch summary

~ubuntu-branches/ubuntu/wily/afnix/wily

« back to all changes in this revision

Viewing changes to src/mod/pim/doc/appendix-i.xml

  • Committer: Bazaar Package Importer
  • Author(s): Anibal Monsalve Salazar
  • Date: 2011-03-16 21:31:18 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20110316213118-gk4k3ez3e5d2huna
Tags: 2.0.0-1
* QA upload.
* New upstream release
* Debian source format is 3.0 (quilt)
* Fix debhelper-but-no-misc-depends
* Fix ancient-standards-version
* Fix package-contains-linda-override
* debhelper compatibility is 7
* Fix dh-clean-k-is-deprecated

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/mod/pim/doc/appendix-i.xml
13
13
<!-- = incidental  or special  damages arising  in any way out of the use = -->
14
14
<!-- = of this software.                                                  = -->
15
15
<!-- ====================================================================== -->
16
 
<!-- = copyright (c) 1999-2007 - amaury darsch                            = -->
 
16
<!-- = copyright (c) 1999-2011 - amaury darsch                            = -->
17
17
<!-- ====================================================================== -->
18
18
 
19
19
<appendix module="pim" number="i">
20
 
  <title>Standard pim reference</title>
21
 
 
22
 
  <p>
23
 
  This appendix is a reference of the <afnix/> standard pim module.
24
 
  </p>
25
 
 
26
 
  <table>
27
 
   <title>Standard pim module</title>
28
 
   <tr><th>Symbol</th> <th>Description</th></tr>
29
 
   <tr><td>afnix-pim</td><td>module</td></tr>
30
 
   <tr><td>afnix:pim</td><td>nameset</td></tr>
31
 
  </table>
 
20
  <title>Standard personnal information management reference</title>
32
21
 
33
22
  <!-- =================================================================== -->
34
23
  <!-- = slot object                                                     = -->
38
27
    <name>Slot</name>
39
28
 
40
29
    <p>
41
 
    The <code>Slot</code> class is a base class designed to handle a
42
 
    basic time slot event. The class is defined with a date and a
43
 
    duration. The slot class is primarily used to build an agenda.
 
30
      The <code>Slot</code> class is a base class designed to handle a
 
31
      basic time slot event. The class is defined with a date and a
 
32
      duration. The slot class is primarily used to build an agenda.
44
33
    </p>
45
34
 
46
35
    <!-- predicate -->
53
42
 
54
43
    <!-- constructors -->
55
44
    <ctors>
56
 
     <ctor>
57
 
      <name>Slot</name>
58
 
      <args>none</args>
59
 
      <p>
60
 
      The <code>Slot</code> constructor creates an empty slot
61
 
      initialized at time 0 with duration 0.
62
 
      </p>
63
 
     </ctor>
 
45
      <ctor>
 
46
        <name>Slot</name>
 
47
        <args>none</args>
 
48
        <p>
 
49
          The <code>Slot</code> constructor creates an empty slot
 
50
          initialized at time 0 with duration 0.
 
51
        </p>
 
52
      </ctor>
64
53
 
65
 
     <ctor>
66
 
      <name>Slot</name>
67
 
      <args>Integer Integer</args>
68
 
      <p>
69
 
      The <code>Slot</code> constructor creates a slot with a time and
70
 
      duration. The first argument is the slot time. The second
71
 
      argument is the slot duration.
72
 
      </p>
73
 
     </ctor>
 
54
      <ctor>
 
55
        <name>Slot</name>
 
56
        <args>Integer Integer</args>
 
57
        <p>
 
58
          The <code>Slot</code> constructor creates a slot with a time and
 
59
          duration. The first argument is the slot time. The second
 
60
          argument is the slot duration.
 
61
        </p>
 
62
      </ctor>
74
63
    </ctors>
75
64
 
76
65
    <!-- methods -->
77
66
    <methods>
78
 
     <meth>
79
 
      <name>reset</name>
80
 
      <retn>none</retn>
81
 
      <args>none</args>
82
 
      <p>
83
 
      The <code>reset</code> method reset the slot to time 0 with
84
 
      duration 0.
85
 
      </p>
86
 
     </meth>
87
 
 
88
 
     <meth>
89
 
      <name>set-time</name>
90
 
      <retn>none</retn>
91
 
      <args>Integer</args>
92
 
      <p>
93
 
      The <code>set-time</code> method sets the slot time.
94
 
      </p>
95
 
     </meth>
96
 
 
97
 
     <meth>
98
 
      <name>get-time</name>
99
 
      <retn>Integer</retn>
100
 
      <args>none</args>
101
 
      <p>
102
 
      The <code>get-time</code> method returns the slot time.
103
 
      </p>
104
 
     </meth>
105
 
 
106
 
     <meth>
107
 
      <name>set-duration</name>
108
 
      <retn>none</retn>
109
 
      <args>Integer</args>
110
 
      <p>
111
 
      The <code>set-duration</code> method sets the slot duration.
112
 
      </p>
113
 
     </meth>
114
 
 
115
 
     <meth>
116
 
      <name>get-duration</name>
117
 
      <retn>Integer</retn>
118
 
      <args>none</args>
119
 
      <p>
120
 
      The <code>get-duration</code> method returns the slot duration.
121
 
      </p>
122
 
     </meth>
123
 
 
124
 
     <meth>
125
 
      <name>set-slot</name>
126
 
      <retn>none</retn>
127
 
      <args>Integer Integer</args>
128
 
      <p>
129
 
      The <code>set-slot</code> method sets the slot time and duration
130
 
      at once. The first argument is the slot time. The second
131
 
      argument is the slot duration.
132
 
      </p>
133
 
     </meth>
 
67
      <meth>
 
68
        <name>reset</name>
 
69
        <retn>none</retn>
 
70
        <args>none</args>
 
71
        <p>
 
72
          The <code>reset</code> method reset the slot to time 0 with
 
73
          duration 0.
 
74
        </p>
 
75
      </meth>
 
76
 
 
77
      <meth>
 
78
        <name>set-time</name>
 
79
        <retn>none</retn>
 
80
        <args>Integer</args>
 
81
        <p>
 
82
          The <code>set-time</code> method sets the slot time.
 
83
        </p>
 
84
      </meth>
 
85
 
 
86
      <meth>
 
87
        <name>get-time</name>
 
88
        <retn>Integer</retn>
 
89
        <args>none</args>
 
90
        <p>
 
91
          The <code>get-time</code> method returns the slot time.
 
92
        </p>
 
93
      </meth>
 
94
 
 
95
      <meth>
 
96
        <name>set-duration</name>
 
97
        <retn>none</retn>
 
98
        <args>Integer</args>
 
99
        <p>
 
100
          The <code>set-duration</code> method sets the slot duration.
 
101
        </p>
 
102
      </meth>
 
103
 
 
104
      <meth>
 
105
        <name>get-duration</name>
 
106
        <retn>Integer</retn>
 
107
        <args>none</args>
 
108
        <p>
 
109
          The <code>get-duration</code> method returns the slot duration.
 
110
        </p>
 
111
      </meth>
 
112
 
 
113
      <meth>
 
114
        <name>set-slot</name>
 
115
        <retn>none</retn>
 
116
        <args>Integer Integer</args>
 
117
        <p>
 
118
          The <code>set-slot</code> method sets the slot time and duration
 
119
          at once. The first argument is the slot time. The second
 
120
          argument is the slot duration.
 
121
        </p>
 
122
      </meth>
134
123
    </methods>
135
124
  </object>
136
125
 
142
131
    <name>Appointer</name>
143
132
 
144
133
    <p>
145
 
    The <code>Appointer</code> class is a class design to allocate
146
 
    time slot in a calendar in order to fill an agenda. The appointer
147
 
    do not store the slot but rather acts as a generator. the
148
 
    appointer algorithm operates with rules that permits to allocate
149
 
    the next available slot. The basic rules permits to define regular
150
 
    blocked days and special blocked days. Another rule permits to
151
 
    define an operating time period. Multiple time periods are
152
 
    allowed. A maximum daily slots rule is also available.
 
134
      The <code>Appointer</code> class is a class design to allocate
 
135
      time slot in a calendar in order to fill an agenda. The appointer
 
136
      do not store the slot but rather acts as a generator. the
 
137
      appointer algorithm operates with rules that permits to allocate
 
138
      the next available slot. The basic rules permits to define regular
 
139
      blocked days and special blocked days. Another rule permits to
 
140
      define an operating time period. Multiple time periods are
 
141
      allowed. A maximum daily slots rule is also available.
153
142
    </p>
154
143
 
155
144
    <!-- predicate -->
162
151
 
163
152
    <!-- constructors -->
164
153
    <ctors>
165
 
     <ctor>
166
 
      <name>Appointer</name>
167
 
      <args>none</args>
168
 
      <p>
169
 
      The <code>Appointer</code> constructor creates a default appointer
170
 
      initialized at time 0. There is no rule installed by the constructor.
171
 
      </p>
172
 
     </ctor>
 
154
      <ctor>
 
155
        <name>Appointer</name>
 
156
        <args>none</args>
 
157
        <p>
 
158
          The <code>Appointer</code> constructor creates a default appointer
 
159
          initialized at time 0. There is no rule installed by the constructor.
 
160
        </p>
 
161
      </ctor>
173
162
 
174
 
     <ctor>
175
 
      <name>Appointer</name>
176
 
      <args>Integer</args>
177
 
      <p>
178
 
      The <code>Appointer</code> constructor creates an appointer with
179
 
      an initial time. The time is set as he starting time to allocate
180
 
      slots. There is no rule installed by the constructor.
181
 
      </p>
182
 
     </ctor>
 
163
      <ctor>
 
164
        <name>Appointer</name>
 
165
        <args>Integer</args>
 
166
        <p>
 
167
          The <code>Appointer</code> constructor creates an appointer with
 
168
          an initial time. The time is set as he starting time to allocate
 
169
          slots. There is no rule installed by the constructor.
 
170
        </p>
 
171
      </ctor>
183
172
    </ctors>
184
173
 
185
174
    <!-- methods -->
186
175
    <methods>
187
 
     <meth>
188
 
      <name>reset</name>
189
 
      <retn>none</retn>
190
 
      <args>none</args>
191
 
      <p>
192
 
      The <code>reset</code> method reset the appointer slot number
193
 
      and daily slot counter. The rules are not touched by this method.
194
 
      </p>
195
 
     </meth>
196
 
 
197
 
     <meth>
198
 
      <name>set-time</name>
199
 
      <retn>none</retn>
200
 
      <args>Integer</args>
201
 
      <p>
202
 
      The <code>set-time</code> method set the appointer time. During
203
 
      the next operation, the newly allocated slots have their time
204
 
      starting at least at this time.
205
 
      </p>
206
 
     </meth>
207
 
 
208
 
     <meth>
209
 
      <name>get-time</name>
210
 
      <retn>Integer</retn>
211
 
      <args>none</args>
212
 
      <p>
213
 
      The <code>get-time</code> method returns the current appointer time.
214
 
      </p>
215
 
     </meth>
216
 
 
217
 
     <meth>
218
 
      <name>set-date</name>
219
 
      <retn>none</retn>
220
 
      <args>Date</args>
221
 
      <p>
222
 
      The <code>set-date</code> method set the appointer time
223
 
      by converting the date argument to a time.
224
 
      </p>
225
 
     </meth>
226
 
 
227
 
     <meth>
228
 
      <name>get-date</name>
229
 
      <retn>Integer</retn>
230
 
      <args>none</args>
231
 
      <p>
232
 
      The <code>get-date</code> method returns the current appointer date.
233
 
      </p>
234
 
     </meth>
235
 
 
236
 
     <meth>
237
 
      <name>get-slot</name>
238
 
      <retn>Slot</retn>
239
 
      <args>Integer|Integer Integer</args>
240
 
      <p>
241
 
      The <code>get-slot</code> method returns a new slot allocated by
242
 
      the appointer. with one argument the argument is taken as the
243
 
      slot duration. With 2 arguments, the first arguments is the
244
 
      requested slot time and the second argument is the slot
245
 
      duration. The slot allocation algorithm operates by finding the
246
 
      appropriate day and time which satisfies the appointer rules. If
247
 
      the slot cannot be found within one week, the allocation is
248
 
      assumed to have failed.
249
 
      </p>
250
 
     </meth>
251
 
 
252
 
     <meth>
253
 
      <name>get-slot-number</name>
254
 
      <retn>Integer</retn>
255
 
      <args>none</args>
256
 
      <p>
257
 
      The <code>get-slot-number</code> method returns the total number
258
 
      of slots allocated by the appointer.
259
 
      </p>
260
 
     </meth>
261
 
 
262
 
     <meth>
263
 
      <name>set-blocked-day</name>
264
 
      <retn>none</retn>
265
 
      <args>Integer</args>
266
 
      <p>
267
 
      The <code>set-blocked-day</code> method sets a regular weekly
268
 
      block day. The method uses the week day index as its
269
 
      argument. Sunday has index 0 and Saturday has index 6. No slot
270
 
      is allocated in a blocked day.
271
 
      </p>
272
 
     </meth>
273
 
 
274
 
     <meth>
275
 
      <name>set-special-day</name>
276
 
      <retn>none</retn>
277
 
      <args>Integer Integer</args>
278
 
      <p>
279
 
      The <code>set-special-day</code> method sets a special year
280
 
      day. The method uses the year month and the month day index as its
281
 
      arguments. The first argument is the year month which must be in
282
 
      the range of 1 to 12. The second argument is the month day which
283
 
      must be in the range of 1 to 31. No slot is allocated in a
284
 
      special day.
285
 
      </p>
286
 
     </meth>
287
 
 
288
 
     <meth>
289
 
      <name>set-maximum-slots</name>
290
 
      <retn>none</retn>
291
 
      <args>Integer</args>
292
 
      <p>
293
 
      The <code>set-maximum-slots</code> method sets a daily maximum
294
 
      slots number. When the daily maximum slot number is reached, the
295
 
      slot allocation proceed to the next day.
296
 
      </p>
297
 
     </meth>
298
 
 
299
 
     <meth>
300
 
      <name>set-valid-block-time</name>
301
 
      <retn>none</retn>
302
 
      <args>Integer Integer</args>
303
 
      <p>
304
 
      The <code>set-valid-block-time</code> method sets a valid block
305
 
      time in which the slot can be allocated. By default, a slot can
306
 
      be allocated anytime during the day. When this rule is set, at
307
 
      least once, the slot is allocated in this block. Multiple valid
308
 
      block time can be defined. The first argument is the valid block
309
 
      time lower bound expressed in seconds from 12PM. The second
310
 
      argument is the valid block time upper bound. All time are
311
 
      expressed in seconds and rounded to a day second which is 84600
312
 
      seconds in 24 hours. For example, a valid block time is from 8AM
313
 
      to 12AM. Another would be from 2PM to 6PM.
314
 
      </p>
315
 
     </meth>
 
176
      <meth>
 
177
        <name>reset</name>
 
178
        <retn>none</retn>
 
179
        <args>none</args>
 
180
        <p>
 
181
          The <code>reset</code> method reset the appointer slot number
 
182
          and daily slot counter. The rules are not touched by this method.
 
183
        </p>
 
184
      </meth>
 
185
 
 
186
      <meth>
 
187
        <name>set-time</name>
 
188
        <retn>none</retn>
 
189
        <args>Integer</args>
 
190
        <p>
 
191
          The <code>set-time</code> method set the appointer time. During
 
192
          the next operation, the newly allocated slots have their time
 
193
          starting at least at this time.
 
194
        </p>
 
195
      </meth>
 
196
 
 
197
      <meth>
 
198
        <name>get-time</name>
 
199
        <retn>Integer</retn>
 
200
        <args>none</args>
 
201
        <p>
 
202
          The <code>get-time</code> method returns the current appointer time.
 
203
        </p>
 
204
      </meth>
 
205
 
 
206
      <meth>
 
207
        <name>set-date</name>
 
208
        <retn>none</retn>
 
209
        <args>Date</args>
 
210
        <p>
 
211
          The <code>set-date</code> method set the appointer time
 
212
          by converting the date argument to a time.
 
213
        </p>
 
214
      </meth>
 
215
 
 
216
      <meth>
 
217
        <name>get-date</name>
 
218
        <retn>Integer</retn>
 
219
        <args>none</args>
 
220
        <p>
 
221
          The <code>get-date</code> method returns the current appointer date.
 
222
        </p>
 
223
      </meth>
 
224
 
 
225
      <meth>
 
226
        <name>get-slot</name>
 
227
        <retn>Slot</retn>
 
228
        <args>Integer|Integer Integer</args>
 
229
        <p>
 
230
          The <code>get-slot</code> method returns a new slot allocated by
 
231
          the appointer. with one argument the argument is taken as the
 
232
          slot duration. With 2 arguments, the first arguments is the
 
233
          requested slot time and the second argument is the slot
 
234
          duration. The slot allocation algorithm operates by finding the
 
235
          appropriate day and time which satisfies the appointer rules. If
 
236
          the slot cannot be found within one week, the allocation is
 
237
          assumed to have failed.
 
238
        </p>
 
239
      </meth>
 
240
 
 
241
      <meth>
 
242
        <name>get-slot-number</name>
 
243
        <retn>Integer</retn>
 
244
        <args>none</args>
 
245
        <p>
 
246
          The <code>get-slot-number</code> method returns the total number
 
247
          of slots allocated by the appointer.
 
248
        </p>
 
249
      </meth>
 
250
 
 
251
      <meth>
 
252
        <name>set-blocked-day</name>
 
253
        <retn>none</retn>
 
254
        <args>Integer</args>
 
255
        <p>
 
256
          The <code>set-blocked-day</code> method sets a regular weekly
 
257
          block day. The method uses the week day index as its
 
258
          argument. Sunday has index 0 and Saturday has index 6. No slot
 
259
          is allocated in a blocked day.
 
260
        </p>
 
261
      </meth>
 
262
 
 
263
      <meth>
 
264
        <name>set-special-day</name>
 
265
        <retn>none</retn>
 
266
        <args>Integer Integer</args>
 
267
        <p>
 
268
          The <code>set-special-day</code> method sets a special year
 
269
          day. The method uses the year month and the month day index as its
 
270
          arguments. The first argument is the year month which must be in
 
271
          the range of 1 to 12. The second argument is the month day which
 
272
          must be in the range of 1 to 31. No slot is allocated in a
 
273
          special day.
 
274
        </p>
 
275
      </meth>
 
276
 
 
277
      <meth>
 
278
        <name>set-maximum-slots</name>
 
279
        <retn>none</retn>
 
280
        <args>Integer</args>
 
281
        <p>
 
282
          The <code>set-maximum-slots</code> method sets a daily maximum
 
283
          slots number. When the daily maximum slot number is reached, the
 
284
          slot allocation proceed to the next day.
 
285
        </p>
 
286
      </meth>
 
287
 
 
288
      <meth>
 
289
        <name>set-valid-block-time</name>
 
290
        <retn>none</retn>
 
291
        <args>Integer Integer</args>
 
292
        <p>
 
293
          The <code>set-valid-block-time</code> method sets a valid block
 
294
          time in which the slot can be allocated. By default, a slot can
 
295
          be allocated anytime during the day. When this rule is set, at
 
296
          least once, the slot is allocated in this block. Multiple valid
 
297
          block time can be defined. The first argument is the valid block
 
298
          time lower bound expressed in seconds from 12PM. The second
 
299
          argument is the valid block time upper bound. All time are
 
300
          expressed in seconds and rounded to a day second which is 84600
 
301
          seconds in 24 hours. For example, a valid block time is from 8AM
 
302
          to 12AM. Another would be from 2PM to 6PM.
 
303
        </p>
 
304
      </meth>
316
305
    </methods>
317
306
  </object>
318
307
 
324
313
    <name>Assistant</name>
325
314
 
326
315
    <p>
327
 
    The <code>Assistant</code> class class is a generic class designed
328
 
    to hold various pim component and manage them like an assistant
329
 
    will do. For example, the class can store several
330
 
    <code>Appointer</code> objects and distribute slot for all of
331
 
    them.
 
316
      The <code>Assistant</code> class class is a generic class designed
 
317
      to hold various pim component and manage them like an assistant
 
318
      will do. For example, the class can store several
 
319
      <code>Appointer</code> objects and distribute slot for all of
 
320
      them.
332
321
    </p>
333
322
 
334
323
    <!-- predicate -->
341
330
 
342
331
    <!-- constructors -->
343
332
    <ctors>
344
 
     <ctor>
345
 
      <name>Assistant</name>
346
 
      <args>none</args>
347
 
      <p>
348
 
      The <code>Assistant</code> constructor creates a default assistant.
349
 
      </p>
350
 
     </ctor>
351
 
 
352
 
     <ctor>
353
 
      <name>Assistant</name>
354
 
      <args>String</args>
355
 
      <p>
356
 
      The <code>Assistant</code> constructor creates a default
357
 
      assistant by name.
358
 
      </p>
359
 
     </ctor>
360
 
 
361
 
     <ctor>
362
 
      <name>Assistant</name>
363
 
      <args>String String</args>
364
 
      <p>
365
 
      The <code>Assistant</code> constructor creates a default
366
 
      assistant by name and information. The first argument is the
367
 
      assistant name. the second argument is the assistant information
368
 
      string.
369
 
      </p>
370
 
     </ctor>
 
333
      <ctor>
 
334
        <name>Assistant</name>
 
335
        <args>none</args>
 
336
        <p>
 
337
          The <code>Assistant</code> constructor creates a default assistant.
 
338
        </p>
 
339
      </ctor>
 
340
 
 
341
      <ctor>
 
342
        <name>Assistant</name>
 
343
        <args>String</args>
 
344
        <p>
 
345
          The <code>Assistant</code> constructor creates a default
 
346
          assistant by name.
 
347
        </p>
 
348
      </ctor>
 
349
 
 
350
      <ctor>
 
351
        <name>Assistant</name>
 
352
        <args>String String</args>
 
353
        <p>
 
354
          The <code>Assistant</code> constructor creates a default
 
355
          assistant by name and information. The first argument is the
 
356
          assistant name. the second argument is the assistant information
 
357
          string.
 
358
        </p>
 
359
      </ctor>
371
360
    </ctors>
372
361
 
373
362
    <!-- methods -->
374
363
    <methods>
375
 
     <meth>
376
 
      <name>reset</name>
377
 
      <retn>none</retn>
378
 
      <args>none</args>
379
 
      <p>
380
 
      The <code>reset</code> method reset the assistant by. All
381
 
      objects attached to the assistant are reset by this method.
382
 
      </p>
383
 
     </meth>
384
 
 
385
 
     <meth>
386
 
      <name>get-name</name>
387
 
      <retn>String</retn>
388
 
      <args>none</args>
389
 
      <p>
390
 
      The <code>get-name</code> method returns the assistant name.
391
 
      </p>
392
 
     </meth>
393
 
 
394
 
     <meth>
395
 
      <name>get-info</name>
396
 
      <retn>String</retn>
397
 
      <args>none</args>
398
 
      <p>
399
 
      The <code>get-info</code> method returns the assistant
400
 
      information string.
401
 
      </p>
402
 
     </meth>
403
 
 
404
 
     <meth>
405
 
      <name>pushback</name>
406
 
      <retn>none</retn>
407
 
      <args>Slot</args>
408
 
      <p>
409
 
      The <code>pushback</code> method pushbaks a slot in the
410
 
      appointer list. The assistant manages internally an index which
411
 
      is used to select the appointer where the slot is pushed-back.
412
 
      </p>
413
 
     </meth>
414
 
 
415
 
     <meth>
416
 
      <name>get-slot</name>
417
 
      <retn>Slot</retn>
418
 
      <args>Integer|Integer Integer</args>
419
 
      <p>
420
 
      The <code>get-slot</code> method returns he next available slot
421
 
      from the appointer list. The assistant manages internally an
422
 
      index which is used to select the appointer from which the slot
423
 
      is obtained. With one argument, the method operates with a slot
424
 
      duration. with 2 arguments, the method operates by time and
425
 
      duration. The time is the minimum time for which the slot is
426
 
      allocated. If the slot cannot be allocated, an exception is
427
 
      raised.
428
 
      </p>
429
 
     </meth>
430
 
 
431
 
     <meth>
432
 
      <name>add-appointer</name>
433
 
      <retn>none</retn>
434
 
      <args>Appointer</args>
435
 
      <p>
436
 
      The <code>add-appointer</code> method adds an appointer object
437
 
      to the assistant.
438
 
      </p>
439
 
     </meth>
440
 
 
441
 
     <meth>
442
 
      <name>get-appointer</name>
443
 
      <retn>Appointer</retn>
444
 
      <args>Integer</args>
445
 
      <p>
446
 
      The <code>get-appointer</code> method returns an appointer object
447
 
      by index. If the appointer object cannot be found, an exception
448
 
      is raised.
449
 
      </p>
450
 
     </meth>
451
 
 
452
 
     <meth>
453
 
      <name>length-appointer</name>
454
 
      <retn>Integer</retn>
455
 
      <args>none</args>
456
 
      <p>
457
 
      The <code>length-appointer</code> method returns the number of
458
 
      appointers attached to the assistant.
459
 
      </p>
460
 
     </meth>
461
 
 
462
 
     <meth>
463
 
      <name>get-slot-number</name>
464
 
      <retn>Integer</retn>
465
 
      <args>none</args>
466
 
      <p>
467
 
      The <code>get-slot-number</code> method returns the total number
468
 
      of slot allocated by the assistant at the time of the call. The
469
 
      number is computed by summing all slot numbers for each appointers.
470
 
      attached to the assistant.
471
 
      </p>
472
 
     </meth>
473
 
 
474
 
     <meth>
475
 
      <name>get-appointer-time</name>
476
 
      <retn>Integer</retn>
477
 
      <args>none</args>
478
 
      <p>
479
 
      The <code>get-appointer-time</code> method returns the average
480
 
      appointer time for the attached appointers. At the time of the
481
 
      call, each appointer has a time which corresponds to the next
482
 
      slot available time. The average time for all appointers is the
483
 
      result of this method which corresponds to the average time of
484
 
      the next available slot.
485
 
      </p>
486
 
     </meth>
 
364
      <meth>
 
365
        <name>reset</name>
 
366
        <retn>none</retn>
 
367
        <args>none</args>
 
368
        <p>
 
369
          The <code>reset</code> method reset the assistant by. All
 
370
          objects attached to the assistant are reset by this method.
 
371
        </p>
 
372
      </meth>
 
373
 
 
374
      <meth>
 
375
        <name>get-name</name>
 
376
        <retn>String</retn>
 
377
        <args>none</args>
 
378
        <p>
 
379
          The <code>get-name</code> method returns the assistant name.
 
380
        </p>
 
381
      </meth>
 
382
 
 
383
      <meth>
 
384
        <name>get-info</name>
 
385
        <retn>String</retn>
 
386
        <args>none</args>
 
387
        <p>
 
388
          The <code>get-info</code> method returns the assistant
 
389
          information string.
 
390
        </p>
 
391
      </meth>
 
392
 
 
393
      <meth>
 
394
        <name>pushback</name>
 
395
        <retn>none</retn>
 
396
        <args>Slot</args>
 
397
        <p>
 
398
          The <code>pushback</code> method pushbaks a slot in the
 
399
          appointer list. The assistant manages internally an index which
 
400
          is used to select the appointer where the slot is pushed-back.
 
401
        </p>
 
402
      </meth>
 
403
 
 
404
      <meth>
 
405
        <name>get-slot</name>
 
406
        <retn>Slot</retn>
 
407
        <args>Integer|Integer Integer</args>
 
408
        <p>
 
409
          The <code>get-slot</code> method returns he next available slot
 
410
          from the appointer list. The assistant manages internally an
 
411
          index which is used to select the appointer from which the slot
 
412
          is obtained. With one argument, the method operates with a slot
 
413
          duration. with 2 arguments, the method operates by time and
 
414
          duration. The time is the minimum time for which the slot is
 
415
          allocated. If the slot cannot be allocated, an exception is
 
416
          raised.
 
417
        </p>
 
418
      </meth>
 
419
 
 
420
      <meth>
 
421
        <name>add-appointer</name>
 
422
        <retn>none</retn>
 
423
        <args>Appointer</args>
 
424
        <p>
 
425
          The <code>add-appointer</code> method adds an appointer object
 
426
          to the assistant.
 
427
        </p>
 
428
      </meth>
 
429
 
 
430
      <meth>
 
431
        <name>get-appointer</name>
 
432
        <retn>Appointer</retn>
 
433
        <args>Integer</args>
 
434
        <p>
 
435
          The <code>get-appointer</code> method returns an appointer object
 
436
          by index. If the appointer object cannot be found, an exception
 
437
          is raised.
 
438
        </p>
 
439
      </meth>
 
440
 
 
441
      <meth>
 
442
        <name>length-appointer</name>
 
443
        <retn>Integer</retn>
 
444
        <args>none</args>
 
445
        <p>
 
446
          The <code>length-appointer</code> method returns the number of
 
447
          appointers attached to the assistant.
 
448
        </p>
 
449
      </meth>
 
450
 
 
451
      <meth>
 
452
        <name>get-slot-number</name>
 
453
        <retn>Integer</retn>
 
454
        <args>none</args>
 
455
        <p>
 
456
          The <code>get-slot-number</code> method returns the total number
 
457
          of slot allocated by the assistant at the time of the call. The
 
458
          number is computed by summing all slot numbers for each appointers.
 
459
          attached to the assistant.
 
460
        </p>
 
461
      </meth>
 
462
 
 
463
      <meth>
 
464
        <name>get-appointer-time</name>
 
465
        <retn>Integer</retn>
 
466
        <args>none</args>
 
467
        <p>
 
468
          The <code>get-appointer-time</code> method returns the average
 
469
          appointer time for the attached appointers. At the time of the
 
470
          call, each appointer has a time which corresponds to the next
 
471
          slot available time. The average time for all appointers is the
 
472
          result of this method which corresponds to the average time of
 
473
          the next available slot.
 
474
        </p>
 
475
      </meth>
487
476
    </methods>
488
477
  </object>
489
478
</appendix>