aboutsummaryrefslogtreecommitdiffstats
path: root/idl/parlay/ui_interfaces.idl
blob: c88d5301d05cbb76c694af71c5b9f3e04cd5e988 (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
//Source file: ui_interfaces.idl
//Date:  8 October 2004
//User Interaction Interfaces for ETSI ES 203 915-05 V1.1.1, DES/TISPAN-01005-05-OSA, Parlay 5.0


#ifndef __UI_INTERFACES_DEFINED
#define __UI_INTERFACES_DEFINED


#include "osa.idl"
#include "ui_data.idl"
#include "gcc_interfaces.idl"
#include "mpcc_interfaces.idl"

module org {
	
	module csapi {
		
		
		module ui {
			interface IpUI;
			interface IpUICall;
			
			enum TpUITargetObjectType {

				P_UI_TARGET_OBJECT_CALL,
				P_UI_TARGET_OBJECT_MULTI_PARTY_CALL,
				P_UI_TARGET_OBJECT_CALL_LEG				
			};
			
			
			union TpUITargetObject switch(TpUITargetObjectType) {
				case P_UI_TARGET_OBJECT_CALL: cc::gccs::TpCallIdentifier Call;
				case P_UI_TARGET_OBJECT_MULTI_PARTY_CALL: cc::mpccs::TpMultiPartyCallIdentifier MultiPartyCall;
				case P_UI_TARGET_OBJECT_CALL_LEG: cc::mpccs::TpCallLegIdentifier CallLeg;
			};
			
			
			struct TpUIIdentifier {
				IpUI UIRef;
				TpSessionID UserInteractionSessionID;
			};
			
			
			typedef sequence <TpUIIdentifier> TpUIIdentifierSet;
			
			struct TpUICallIdentifier {
				IpUICall UICallRef;
				TpSessionID UserInteractionSessionID;
			};
			
			
			
			interface IpAppUI : IpInterface {
				void sendInfoRes (
					in TpSessionID userInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpUIReport response	
					);
					
				void sendInfoErr (
					in TpSessionID userInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpUIError error	
					);
					
				void sendInfoAndCollectRes (
					in TpSessionID userInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpUIReport response,	
					in TpString collectedInfo	
					);
					
				void sendInfoAndCollectErr (
					in TpSessionID userInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpUIError error	
					);
					
				void userInteractionFaultDetected (
					in TpSessionID userInteractionSessionID,	
					in TpUIFault fault	
					);
					
			};
			
			
			interface IpAppUICall : IpAppUI {
				void recordMessageRes (
					in TpSessionID userInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpUIReport response,	
					in TpInt32 messageID	
					);
					
				void recordMessageErr (
					in TpSessionID userInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpUIError error	
					);
					
				void deleteMessageRes (
					in TpSessionID usrInteractionSessionID,	
					in TpUIReport response,	
					in TpAssignmentID assignmentID	
					);
					
				void deleteMessageErr (
					in TpSessionID usrInteractionSessionID,	
					in TpUIError error,	
					in TpAssignmentID assignmentID	
					);
					
				void abortActionRes (
					in TpSessionID userInteractionSessionID,	
					in TpAssignmentID assignmentID	
					);
					
				void abortActionErr (
					in TpSessionID userInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpUIError error	
					);
					
				void getMessageRes (
					in TpSessionID userInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpUIInfo message	
					);
					
				void getMessageErr (
					in TpSessionID userInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpUIError error	
					);
					
			};
			
			
			interface IpAppUIManager : IpInterface {
				void userInteractionAborted (
					in TpUIIdentifier userInteraction	
					);
					
				void userInteractionNotificationInterrupted ();
					
				void userInteractionNotificationContinued ();
					
				IpAppUI reportEventNotification (
					in TpUIIdentifier userInteraction,	
					in TpUIEventNotificationInfo eventNotificationInfo,	
					in TpAssignmentID assignmentID	
					);
					
				void abortMultipleUserInteractions (
					in TpUIIdentifierSet userInteractionSet	
					);
					
			};
			
			
			interface IpUI : IpService {
				TpAssignmentID sendInfoReq (
					in TpSessionID userInteractionSessionID,	
					in TpUIInfo info,	
					in TpLanguage language,	
					in TpUIVariableInfoSet variableInfo,	
					in TpInt32 repeatIndicator,	
					in TpUIResponseRequest responseRequested	
					)					
					raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE,P_ILLEGAL_ID,P_ID_NOT_FOUND);
					
				TpAssignmentID sendInfoAndCollectReq (
					in TpSessionID userInteractionSessionID,	
					in TpUIInfo info,	
					in TpLanguage language,	
					in TpUIVariableInfoSet variableInfo,	
					in TpUICollectCriteria criteria,	
					in TpUIResponseRequest responseRequested	
					)					
					raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE,P_ILLEGAL_ID,P_ID_NOT_FOUND,P_ILLEGAL_RANGE,P_INVALID_COLLECTION_CRITERIA);
					
				void release (
					in TpSessionID userInteractionSessionID	
					)					
					raises (TpCommonExceptions,P_INVALID_SESSION_ID);
					
				void setOriginatingAddress (
					in TpSessionID userInteractionSessionID,	
					in TpString origin	
					)					
					raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE,P_INVALID_ADDRESS);
					
				TpString getOriginatingAddress (
					in TpSessionID userInteractionSessionID	
					)					
					raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE);
					
			};
			
			
			interface IpUICall : IpUI {
				TpAssignmentID recordMessageReq (
					in TpSessionID userInteractionSessionID,	
					in TpUIInfo info,	
					in TpUIMessageCriteria criteria	
					)					
					raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE,P_ILLEGAL_ID,P_ID_NOT_FOUND,P_INVALID_CRITERIA);
					
				TpAssignmentID deleteMessageReq (
					in TpSessionID usrInteractionSessionID,	
					in TpInt32 messageID	
					)					
					raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_ILLEGAL_ID,P_ID_NOT_FOUND);
					
				void abortActionReq (
					in TpSessionID userInteractionSessionID,	
					in TpAssignmentID assignmentID	
					)					
					raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_ASSIGNMENT_ID);
					
				TpAssignmentID getMessageReq (
					in TpSessionID userInteractionSessionID,	
					in TpInt32 messageID	
					)					
					raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE,P_ILLEGAL_ID,P_ID_NOT_FOUND);
					
			};
			
			
			interface IpUIManager : IpService {
				TpUIIdentifier createUI (
					in IpAppUI appUI,	
					in TpAddress userAddress	
					)					
					raises (TpCommonExceptions,P_INVALID_NETWORK_STATE,P_INVALID_INTERFACE_TYPE);
					
				TpUICallIdentifier createUICall (
					in IpAppUICall appUI,	
					in TpUITargetObject uiTargetObject	
					)					
					raises (TpCommonExceptions,P_INVALID_NETWORK_STATE,P_INVALID_INTERFACE_TYPE);
					
				TpAssignmentID createNotification (
					in IpAppUIManager appUIManager,	
					in TpUIEventCriteria eventCriteria	
					)					
					raises (TpCommonExceptions,P_INVALID_CRITERIA,P_INVALID_INTERFACE_TYPE);
					
				void destroyNotification (
					in TpAssignmentID assignmentID	
					)					
					raises (TpCommonExceptions,P_INVALID_ASSIGNMENT_ID);
					
				void changeNotification (
					in TpAssignmentID assignmentID,	
					in TpUIEventCriteria eventCriteria	
					)					
					raises (TpCommonExceptions,P_INVALID_ASSIGNMENT_ID,P_INVALID_CRITERIA);
					
				TpUIEventCriteriaResultSet getNotification ()					
					raises (TpCommonExceptions);
					
				TpAssignmentID enableNotifications (
					in IpAppUIManager appUIManager	
					)					
					raises (TpCommonExceptions);
					
				void disableNotifications ()					
					raises (TpCommonExceptions);
					
			};
			
			
			interface IpAppUIAdminManager : IpInterface {
				void getMessageRes (
					in TpSessionID usrInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpUIInfo message	
					);
					
				void getMessageErr (
					in TpSessionID usrInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpUIError error	
					);
					
				void deleteMessageRes (
					in TpSessionID usrInteractionSessionID,	
					in TpUIReport response,	
					in TpAssignmentID assignmentID	
					);
					
				void deleteMessageErr (
					in TpSessionID usrInteractionSessionID,	
					in TpUIError error,	
					in TpAssignmentID assignmentID	
					);
					
				void putMessageRes (
					in TpSessionID usrInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpInt32 messageID	
					);
					
				void putMessageErr (
					in TpSessionID usrInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpUIError error	
					);
					
				void getMessageListRes (
					in TpSessionID usrInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpMessageIDList messageIDList,	
					in TpBoolean final	
					);
					
				void getMessageListErr (
					in TpSessionID usrInteractionSessionID,	
					in TpAssignmentID assignmentID,	
					in TpUIError error	
					);
					
			};
			
			
			interface IpUIAdminManager : IpService {
				TpAssignmentID getMessageReq (
					in TpSessionID usrInteractionSessionID,	
					in TpInt32 messageID	
					)					
					raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE,P_ILLEGAL_ID,P_ID_NOT_FOUND);
					
				TpAssignmentID putMessageReq (
					in TpSessionID usrInteractionSessionID,	
					in TpUIInfo info	
					)					
					raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_ILLEGAL_ID,P_ID_NOT_FOUND);
					
				TpAssignmentID deleteMessageReq (
					in TpSessionID usrInteractionSessionID,	
					in TpInt32 messageID	
					)					
					raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_ILLEGAL_ID,P_ID_NOT_FOUND);
					
				TpAssignmentID getMessageListReq (
					in TpSessionID usrInteractionSessionID,	
					in TpBoolean reset	
					)					
					raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE);
					
			};
			
		};
		
	};
	
};

#endif