21386e92403074eca2315cdd3f58d5d172db766b
[obnox/wireshark/wip.git] / idl / parlay / ui_interfaces.idl
1 //Source file: ui_interfaces.idl\r
2 //Date:  8 October 2004\r
3 //User Interaction Interfaces for ETSI ES 203 915-05 V1.1.1, DES/TISPAN-01005-05-OSA, Parlay 5.0\r
4 \r
5 \r
6 #ifndef __UI_INTERFACES_DEFINED\r
7 #define __UI_INTERFACES_DEFINED\r
8 \r
9 \r
10 #include "osa.idl"\r
11 #include "ui_data.idl"\r
12 #include "gcc_interfaces.idl"\r
13 #include "mpcc_interfaces.idl"\r
14 \r
15 module org {\r
16         \r
17         module csapi {\r
18                 \r
19                 \r
20                 module ui {\r
21                         interface IpUI;\r
22                         interface IpUICall;\r
23                         \r
24                         enum TpUITargetObjectType {\r
25 \r
26                                 P_UI_TARGET_OBJECT_CALL,\r
27                                 P_UI_TARGET_OBJECT_MULTI_PARTY_CALL,\r
28                                 P_UI_TARGET_OBJECT_CALL_LEG                             \r
29                         };\r
30                         \r
31                         \r
32                         union TpUITargetObject switch(TpUITargetObjectType) {\r
33                                 case P_UI_TARGET_OBJECT_CALL: cc::gccs::TpCallIdentifier Call;\r
34                                 case P_UI_TARGET_OBJECT_MULTI_PARTY_CALL: cc::mpccs::TpMultiPartyCallIdentifier MultiPartyCall;\r
35                                 case P_UI_TARGET_OBJECT_CALL_LEG: cc::mpccs::TpCallLegIdentifier CallLeg;\r
36                         };\r
37                         \r
38                         \r
39                         struct TpUIIdentifier {\r
40                                 IpUI UIRef;\r
41                                 TpSessionID UserInteractionSessionID;\r
42                         };\r
43                         \r
44                         \r
45                         typedef sequence <TpUIIdentifier> TpUIIdentifierSet;\r
46                         \r
47                         struct TpUICallIdentifier {\r
48                                 IpUICall UICallRef;\r
49                                 TpSessionID UserInteractionSessionID;\r
50                         };\r
51                         \r
52                         \r
53                         \r
54                         interface IpAppUI : IpInterface {\r
55                                 void sendInfoRes (\r
56                                         in TpSessionID userInteractionSessionID,        \r
57                                         in TpAssignmentID assignmentID, \r
58                                         in TpUIReport response  \r
59                                         );\r
60                                         \r
61                                 void sendInfoErr (\r
62                                         in TpSessionID userInteractionSessionID,        \r
63                                         in TpAssignmentID assignmentID, \r
64                                         in TpUIError error      \r
65                                         );\r
66                                         \r
67                                 void sendInfoAndCollectRes (\r
68                                         in TpSessionID userInteractionSessionID,        \r
69                                         in TpAssignmentID assignmentID, \r
70                                         in TpUIReport response, \r
71                                         in TpString collectedInfo       \r
72                                         );\r
73                                         \r
74                                 void sendInfoAndCollectErr (\r
75                                         in TpSessionID userInteractionSessionID,        \r
76                                         in TpAssignmentID assignmentID, \r
77                                         in TpUIError error      \r
78                                         );\r
79                                         \r
80                                 void userInteractionFaultDetected (\r
81                                         in TpSessionID userInteractionSessionID,        \r
82                                         in TpUIFault fault      \r
83                                         );\r
84                                         \r
85                         };\r
86                         \r
87                         \r
88                         interface IpAppUICall : IpAppUI {\r
89                                 void recordMessageRes (\r
90                                         in TpSessionID userInteractionSessionID,        \r
91                                         in TpAssignmentID assignmentID, \r
92                                         in TpUIReport response, \r
93                                         in TpInt32 messageID    \r
94                                         );\r
95                                         \r
96                                 void recordMessageErr (\r
97                                         in TpSessionID userInteractionSessionID,        \r
98                                         in TpAssignmentID assignmentID, \r
99                                         in TpUIError error      \r
100                                         );\r
101                                         \r
102                                 void deleteMessageRes (\r
103                                         in TpSessionID usrInteractionSessionID, \r
104                                         in TpUIReport response, \r
105                                         in TpAssignmentID assignmentID  \r
106                                         );\r
107                                         \r
108                                 void deleteMessageErr (\r
109                                         in TpSessionID usrInteractionSessionID, \r
110                                         in TpUIError error,     \r
111                                         in TpAssignmentID assignmentID  \r
112                                         );\r
113                                         \r
114                                 void abortActionRes (\r
115                                         in TpSessionID userInteractionSessionID,        \r
116                                         in TpAssignmentID assignmentID  \r
117                                         );\r
118                                         \r
119                                 void abortActionErr (\r
120                                         in TpSessionID userInteractionSessionID,        \r
121                                         in TpAssignmentID assignmentID, \r
122                                         in TpUIError error      \r
123                                         );\r
124                                         \r
125                                 void getMessageRes (\r
126                                         in TpSessionID userInteractionSessionID,        \r
127                                         in TpAssignmentID assignmentID, \r
128                                         in TpUIInfo message     \r
129                                         );\r
130                                         \r
131                                 void getMessageErr (\r
132                                         in TpSessionID userInteractionSessionID,        \r
133                                         in TpAssignmentID assignmentID, \r
134                                         in TpUIError error      \r
135                                         );\r
136                                         \r
137                         };\r
138                         \r
139                         \r
140                         interface IpAppUIManager : IpInterface {\r
141                                 void userInteractionAborted (\r
142                                         in TpUIIdentifier userInteraction       \r
143                                         );\r
144                                         \r
145                                 void userInteractionNotificationInterrupted ();\r
146                                         \r
147                                 void userInteractionNotificationContinued ();\r
148                                         \r
149                                 IpAppUI reportEventNotification (\r
150                                         in TpUIIdentifier userInteraction,      \r
151                                         in TpUIEventNotificationInfo eventNotificationInfo,     \r
152                                         in TpAssignmentID assignmentID  \r
153                                         );\r
154                                         \r
155                                 void abortMultipleUserInteractions (\r
156                                         in TpUIIdentifierSet userInteractionSet \r
157                                         );\r
158                                         \r
159                         };\r
160                         \r
161                         \r
162                         interface IpUI : IpService {\r
163                                 TpAssignmentID sendInfoReq (\r
164                                         in TpSessionID userInteractionSessionID,        \r
165                                         in TpUIInfo info,       \r
166                                         in TpLanguage language, \r
167                                         in TpUIVariableInfoSet variableInfo,    \r
168                                         in TpInt32 repeatIndicator,     \r
169                                         in TpUIResponseRequest responseRequested        \r
170                                         )                                       \r
171                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE,P_ILLEGAL_ID,P_ID_NOT_FOUND);\r
172                                         \r
173                                 TpAssignmentID sendInfoAndCollectReq (\r
174                                         in TpSessionID userInteractionSessionID,        \r
175                                         in TpUIInfo info,       \r
176                                         in TpLanguage language, \r
177                                         in TpUIVariableInfoSet variableInfo,    \r
178                                         in TpUICollectCriteria criteria,        \r
179                                         in TpUIResponseRequest responseRequested        \r
180                                         )                                       \r
181                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE,P_ILLEGAL_ID,P_ID_NOT_FOUND,P_ILLEGAL_RANGE,P_INVALID_COLLECTION_CRITERIA);\r
182                                         \r
183                                 void release (\r
184                                         in TpSessionID userInteractionSessionID \r
185                                         )                                       \r
186                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID);\r
187                                         \r
188                                 void setOriginatingAddress (\r
189                                         in TpSessionID userInteractionSessionID,        \r
190                                         in TpString origin      \r
191                                         )                                       \r
192                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE,P_INVALID_ADDRESS);\r
193                                         \r
194                                 TpString getOriginatingAddress (\r
195                                         in TpSessionID userInteractionSessionID \r
196                                         )                                       \r
197                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE);\r
198                                         \r
199                         };\r
200                         \r
201                         \r
202                         interface IpUICall : IpUI {\r
203                                 TpAssignmentID recordMessageReq (\r
204                                         in TpSessionID userInteractionSessionID,        \r
205                                         in TpUIInfo info,       \r
206                                         in TpUIMessageCriteria criteria \r
207                                         )                                       \r
208                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE,P_ILLEGAL_ID,P_ID_NOT_FOUND,P_INVALID_CRITERIA);\r
209                                         \r
210                                 TpAssignmentID deleteMessageReq (\r
211                                         in TpSessionID usrInteractionSessionID, \r
212                                         in TpInt32 messageID    \r
213                                         )                                       \r
214                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_ILLEGAL_ID,P_ID_NOT_FOUND);\r
215                                         \r
216                                 void abortActionReq (\r
217                                         in TpSessionID userInteractionSessionID,        \r
218                                         in TpAssignmentID assignmentID  \r
219                                         )                                       \r
220                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_ASSIGNMENT_ID);\r
221                                         \r
222                                 TpAssignmentID getMessageReq (\r
223                                         in TpSessionID userInteractionSessionID,        \r
224                                         in TpInt32 messageID    \r
225                                         )                                       \r
226                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE,P_ILLEGAL_ID,P_ID_NOT_FOUND);\r
227                                         \r
228                         };\r
229                         \r
230                         \r
231                         interface IpUIManager : IpService {\r
232                                 TpUIIdentifier createUI (\r
233                                         in IpAppUI appUI,       \r
234                                         in TpAddress userAddress        \r
235                                         )                                       \r
236                                         raises (TpCommonExceptions,P_INVALID_NETWORK_STATE,P_INVALID_INTERFACE_TYPE);\r
237                                         \r
238                                 TpUICallIdentifier createUICall (\r
239                                         in IpAppUICall appUI,   \r
240                                         in TpUITargetObject uiTargetObject      \r
241                                         )                                       \r
242                                         raises (TpCommonExceptions,P_INVALID_NETWORK_STATE,P_INVALID_INTERFACE_TYPE);\r
243                                         \r
244                                 TpAssignmentID createNotification (\r
245                                         in IpAppUIManager appUIManager, \r
246                                         in TpUIEventCriteria eventCriteria      \r
247                                         )                                       \r
248                                         raises (TpCommonExceptions,P_INVALID_CRITERIA,P_INVALID_INTERFACE_TYPE);\r
249                                         \r
250                                 void destroyNotification (\r
251                                         in TpAssignmentID assignmentID  \r
252                                         )                                       \r
253                                         raises (TpCommonExceptions,P_INVALID_ASSIGNMENT_ID);\r
254                                         \r
255                                 void changeNotification (\r
256                                         in TpAssignmentID assignmentID, \r
257                                         in TpUIEventCriteria eventCriteria      \r
258                                         )                                       \r
259                                         raises (TpCommonExceptions,P_INVALID_ASSIGNMENT_ID,P_INVALID_CRITERIA);\r
260                                         \r
261                                 TpUIEventCriteriaResultSet getNotification ()                                   \r
262                                         raises (TpCommonExceptions);\r
263                                         \r
264                                 TpAssignmentID enableNotifications (\r
265                                         in IpAppUIManager appUIManager  \r
266                                         )                                       \r
267                                         raises (TpCommonExceptions);\r
268                                         \r
269                                 void disableNotifications ()                                    \r
270                                         raises (TpCommonExceptions);\r
271                                         \r
272                         };\r
273                         \r
274                         \r
275                         interface IpAppUIAdminManager : IpInterface {\r
276                                 void getMessageRes (\r
277                                         in TpSessionID usrInteractionSessionID, \r
278                                         in TpAssignmentID assignmentID, \r
279                                         in TpUIInfo message     \r
280                                         );\r
281                                         \r
282                                 void getMessageErr (\r
283                                         in TpSessionID usrInteractionSessionID, \r
284                                         in TpAssignmentID assignmentID, \r
285                                         in TpUIError error      \r
286                                         );\r
287                                         \r
288                                 void deleteMessageRes (\r
289                                         in TpSessionID usrInteractionSessionID, \r
290                                         in TpUIReport response, \r
291                                         in TpAssignmentID assignmentID  \r
292                                         );\r
293                                         \r
294                                 void deleteMessageErr (\r
295                                         in TpSessionID usrInteractionSessionID, \r
296                                         in TpUIError error,     \r
297                                         in TpAssignmentID assignmentID  \r
298                                         );\r
299                                         \r
300                                 void putMessageRes (\r
301                                         in TpSessionID usrInteractionSessionID, \r
302                                         in TpAssignmentID assignmentID, \r
303                                         in TpInt32 messageID    \r
304                                         );\r
305                                         \r
306                                 void putMessageErr (\r
307                                         in TpSessionID usrInteractionSessionID, \r
308                                         in TpAssignmentID assignmentID, \r
309                                         in TpUIError error      \r
310                                         );\r
311                                         \r
312                                 void getMessageListRes (\r
313                                         in TpSessionID usrInteractionSessionID, \r
314                                         in TpAssignmentID assignmentID, \r
315                                         in TpMessageIDList messageIDList,       \r
316                                         in TpBoolean final      \r
317                                         );\r
318                                         \r
319                                 void getMessageListErr (\r
320                                         in TpSessionID usrInteractionSessionID, \r
321                                         in TpAssignmentID assignmentID, \r
322                                         in TpUIError error      \r
323                                         );\r
324                                         \r
325                         };\r
326                         \r
327                         \r
328                         interface IpUIAdminManager : IpService {\r
329                                 TpAssignmentID getMessageReq (\r
330                                         in TpSessionID usrInteractionSessionID, \r
331                                         in TpInt32 messageID    \r
332                                         )                                       \r
333                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE,P_ILLEGAL_ID,P_ID_NOT_FOUND);\r
334                                         \r
335                                 TpAssignmentID putMessageReq (\r
336                                         in TpSessionID usrInteractionSessionID, \r
337                                         in TpUIInfo info        \r
338                                         )                                       \r
339                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_ILLEGAL_ID,P_ID_NOT_FOUND);\r
340                                         \r
341                                 TpAssignmentID deleteMessageReq (\r
342                                         in TpSessionID usrInteractionSessionID, \r
343                                         in TpInt32 messageID    \r
344                                         )                                       \r
345                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_ILLEGAL_ID,P_ID_NOT_FOUND);\r
346                                         \r
347                                 TpAssignmentID getMessageListReq (\r
348                                         in TpSessionID usrInteractionSessionID, \r
349                                         in TpBoolean reset      \r
350                                         )                                       \r
351                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_INVALID_NETWORK_STATE);\r
352                                         \r
353                         };\r
354                         \r
355                 };\r
356                 \r
357         };\r
358         \r
359 };\r
360 \r
361 #endif\r