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