summaryrefslogtreecommitdiff
path: root/src/traffic-incidents-service/org.genivi.trafficincidentsservice.trafficincidentsservice-model/src/org/genivi/trafficincidentsservice/TrafficIncidents.java
blob: a7279fb5ac0dac34c633cb7398c2a7b3fb8ce9a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
/**
 * Copyright (C) 2013 TomTom International B.V.
 * 
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package org.genivi.trafficincidentsservice;

import org.eclipse.emf.common.util.EList;

import org.eclipse.emf.ecore.EObject;

import org.genivi.common.RectangularArea;

import org.genivi.iconset.IconDefinition;
import org.genivi.iconset.IconInfo;
import org.genivi.iconset.IconSet;
import org.genivi.trafficincidentsservice.trafficincidenttables.WarningLevel;

/**
 * <!-- begin-user-doc -->
 * A representation of the model object '<em><b>Traffic Incidents</b></em>'.
 * <!-- end-user-doc -->
 *
 * <!-- begin-model-doc -->
 * This is the main interface via which a client obtains Traffic Information.
 * <!-- end-model-doc -->
 *
 *
 * @see org.genivi.trafficincidentsservice.trafficincidentsservicePackage#getTrafficIncidents()
 * @model annotation="http://www.tomtom.com/emfidl/2012/GenModel versionMajor='0' versionMinor='1'"
 * @generated
 */
public interface TrafficIncidents extends EObject {
  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * Get the API version of this interface implemented by the service.
	 * @param listener The class on which the callback function is called.
	 * <!-- end-model-doc -->
	 * @model
	 * @generated
	 */
  void getVersion(TrafficIncidentsListener listener);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * Get all the Ids of the current traffic incidents.
	 * @param listener The class on which the callback function is called.
	 * @param warningLevels
	 *   Only incidents with one of the specified warning levels will be returned.
	 *   In case of an empty list, traffic incidents with any warning level (and no specified warning level) are returned.
	 * <!-- end-model-doc -->
	 * @model warningLevelsMany="true" categoryIdsMany="true"
	 * @generated
	 */
  void getTrafficIncidentIds(TrafficIncidentsListener listener, EList<WarningLevel> warningLevels, EList<Integer> categoryIds);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * Get the Ids of the traffic incidents in a number of areas.
	 * @param listener The class on which the callback function is called.
	 * @param warningLevels
	 *   Only incidents with one of the specified warning levels will be returned.
	 *   In case of an empty list, traffic incidents with any warning level (and no specified warning level) are returned.
	 * @param areas The areas for which the traffic incident Ids are requested.
	 * <!-- end-model-doc -->
	 * @model warningLevelsMany="true" categoryIdsMany="true" areasMany="true"
	 * @generated
	 */
  void getTrafficIncidentIdsInAreas(TrafficIncidentsListener listener, EList<WarningLevel> warningLevels, EList<Integer> categoryIds, EList<RectangularArea> areas);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * Get a number of Traffic Incidents.
	 * @param listener The class on which the callback function is called.
	 * @param trafficIncidentIds The Ids of the requested Traffic Incidents.
	 * @param includeTextFields The text fields in the returned Traffic Incident will only be filled in if this parameter is set to true.
	 * <!-- end-model-doc -->
	 * @model trafficIncidentIdsMany="true"
	 * @generated
	 */
  void getTrafficIncidents(TrafficIncidentsListener listener, EList<Integer> trafficIncidentIds, boolean includeTextFields);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * Get a number of Traffic Incidents, where only specific fields are filled in..
	 * @param listener The class on which the callback function is called.
	 * @param trafficIncidentIds The Ids of the requested Traffic Incidents.
	 * @param trafficIncidentFields The fields (attributes) to be filled in in the Traffic Incident.
	 * <!-- end-model-doc -->
	 * @model trafficIncidentIdsMany="true" trafficIncidentFieldsMany="true"
	 * @generated
	 */
  void getTrafficIncidentsFields(TrafficIncidentsListener listener, EList<Integer> trafficIncidentIds, EList<TrafficIncidentField> trafficIncidentFields);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * Get the texts for a number of Traffic Incidents.
	 * @param listener The class on which the callback function is called.
	 * @param trafficIncidentIds The Ids of the Traffic Incidents for which the texts are requested.
	 * @param textDetailLevel The amount of detail to be provided in the texts.
	 * <!-- end-model-doc -->
	 * @model trafficIncidentIdsMany="true"
	 * @generated
	 */
  void getTexts(TrafficIncidentsListener listener, EList<Integer> trafficIncidentIds, TextDetailLevel textDetailLevel);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * Add a listener which is notified in case of any change in Traffic Incidents status.
	 * In case of a status change, the TrafficIncidentsStatus() method of the listener is called.
	 * <!-- end-model-doc -->
	 * @model
	 * @generated
	 */
  void addTrafficIncidentsStatusListener(TrafficIncidentsListener listener, TrafficIncidentsListener trafficIncidentsStatusListener);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void addFeedInformationListener(TrafficIncidentsListener listener, TrafficIncidentsListener feedInformationListener);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void removeUpdateListener(TrafficIncidentsListener listener, TrafficIncidentsListener updateListener);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void removeAreasUpdateListener(TrafficIncidentsListener listener, TrafficIncidentsListener updateListener);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void removeTrafficIncidentsStatusListener(TrafficIncidentsListener listener, TrafficIncidentsListener trafficIncidentsStatusListener);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void removeFeedInformationListener(TrafficIncidentsListener listener, TrafficIncidentsListener feedInformationListener);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * Add a listener which is notified in case of any update in the traffic information.
	 * In case of an update the updates() method of the listener is called.
	 * @param listener The class on which the callback function is called.
	 * @param warningLevels
	 *   Only incidents with one of the specified warning levels will be returned.
	 *   In case of an empty list, traffic incidents with any warning level (and no specified warning level) are returned.
	 * <!-- end-model-doc -->
	 * @model warningLevelsMany="true" categoryIdsMany="true"
	 * @generated
	 */
  void addUpdateListener(TrafficIncidentsListener listener, EList<WarningLevel> warningLevels, EList<Integer> categoryIds, TrafficIncidentsListener updateListener);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * Add a listener which is notified in case of an update in the traffic information in one or more specific area's.
	 * In case of an update the updatesInAreas() method of the listener is called.
	 * @param listener The class on which the callback function is called.
	 * @param warningLevels
	 *   Only incidents with one of the specified warning levels will be returned.
	 *   In case of an empty list, traffic incidents with any warning level (and no specified warning level) are returned.
	 * @param areas The area's to be observed for changes.
	 * <!-- end-model-doc -->
	 * @model warningLevelsMany="true" categoryIdsMany="true" areasMany="true"
	 * @generated
	 */
  void addAreasUpdateListener(TrafficIncidentsListener listener, EList<WarningLevel> warningLevels, EList<Integer> categoryIds, EList<RectangularArea> areas, TrafficIncidentsListener updateListener);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * Get the current language.
	 * @param listener The class on which the callback function is called.
	 * <!-- end-model-doc -->
	 * @model
	 * @generated
	 */
  void getLanguage(TrafficIncidentsListener listener);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * Set the language.
	 * @param languageCode The language to be used.
	 * @param countryCode The country specific variant for the language to be used.
	 * <!-- end-model-doc -->
	 * @model
	 * @generated
	 */
  void setLanguage(TrafficIncidentsListener listener, String languageCode, String countryCode);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void setTimeFormat(TrafficIncidentsListener listener, String timeFormat);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void setDateFormat(TrafficIncidentsListener listener, String dateFormat);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void setLengthUnit(TrafficIncidentsListener listener, LengthUnit lengthUnit);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void setWeightUnit(TrafficIncidentsListener listener, WeightUnit weightUnit);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void reserveIconSetIds(TrafficIncidentsListener listener, int numberOfIds);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model iconSetIdsMany="true"
	 * @generated
	 */
  void freeIconSetIds(TrafficIncidentsListener listener, EList<Integer> iconSetIds);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void getIconSets(TrafficIncidentsListener listener);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model iconSetsMany="true"
	 * @generated
	 */
  void addIconSetDefinitions(TrafficIncidentsListener listener, EList<IconSet> iconSets);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model iconSetIdsMany="true"
	 * @generated
	 */
  void removeIconSetDefinitions(TrafficIncidentsListener listener, EList<Integer> iconSetIds);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model iconInfosMany="true"
	 * @generated
	 */
  void getIconDefinitions(TrafficIncidentsListener listener, EList<IconInfo> iconInfos);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model iconDefinitionsMany="true"
	 * @generated
	 */
  void addIconDefinitions(TrafficIncidentsListener listener, EList<IconDefinition> iconDefinitions);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model iconInfosMany="true"
	 * @generated
	 */
  void removeIconDefinitions(TrafficIncidentsListener listener, EList<IconInfo> iconInfos);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void reserveCategoryIds(TrafficIncidentsListener listener, int numberOfIds);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model categoryIdsMany="true"
	 * @generated
	 */
  void freeCategoryIds(TrafficIncidentsListener listener, EList<Integer> categoryIds);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void getCategoryDefinitions(TrafficIncidentsListener listener);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model categoryDefinitionsMany="true"
	 * @generated
	 */
  void addCategoryDefinitions(TrafficIncidentsListener listener, EList<CategoryDefinition> categoryDefinitions);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model categoryIdsMany="true"
	 * @generated
	 */
  void removeCategoryDefinitions(TrafficIncidentsListener listener, EList<Integer> categoryIds);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void getApplicability(TrafficIncidentsListener listener);

  /**
	 * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
  void setApplicability(TrafficIncidentsListener listener, String filterExpression);

} // TrafficIncidents