Fix svn properties where needed:
[obnox/wireshark/wip.git] / idl / parlay / termcap.idl
1 //Source file: termcap.idl
2 //Date:  11 October 2004
3 //Terminal Capability Interfaces and Data Types for ETSI ES 203 915-07 V1.1.1, DES/TISPAN-01005-07-OSA, Parlay 5.0
4
5 #ifndef __TERMCAP_DEFINED
6 #define __TERMCAP_DEFINED
7
8
9 #include "osa.idl"
10
11 module org {
12         
13         module csapi {
14                 
15                 
16                 module termcap {
17                         
18                         
19                         struct TpTerminalCapabilities {
20                                 TpString TerminalCapabilities;
21                                 TpBoolean StatusCode;
22                         };
23                         
24                         
25                         enum TpTerminalCapabilitiesError {
26
27                                 P_TERMCAP_ERROR_UNDEFINED,
28                                 P_TERMCAP_INVALID_TERMINALID,
29                                 P_TERMCAP_SYSTEM_FAILURE,
30                                 P_TERMCAP_INFO_UNAVAILABLE                              
31                         };
32                         
33                         
34                         exception P_INVALID_TERMINAL_ID {
35                                 TpString ExtraInformation;
36                         };
37                         
38                         
39                         typedef TpInt32 TpTerminalCapabilityChangeCriteria;
40                         
41                         
42                         const TpTerminalCapabilityChangeCriteria P_TERMINAL_CAPABILITY_CHANGE_CRITERIA_UNDEFINED = 0;
43                         
44                         const TpTerminalCapabilityChangeCriteria P_TERMINAL_CAPABILITY_CHANGE_CRITERIA_GENERAL = 1;
45                         
46                         const TpTerminalCapabilityChangeCriteria P_TERMINAL_CAPABILITY_CHANGE_CRITERIA_HW_UPDATE = 2;
47                         
48                         const TpTerminalCapabilityChangeCriteria P_TERMINAL_CAPABILITY_CHANGE_CRITERIA_SW_UPDATE = 4;
49                         
50                         const TpTerminalCapabilityChangeCriteria P_TERMINAL_CAPABILITY_CHANGE_CRITERIA_INITIAL = 8;
51                         
52                         enum TpTerminalCapabilityScopeType {
53
54                                 P_TERMINAL_CAPABILITY_SCOPE_TYPE_UNDEFINED,
55                                 P_TERMINAL_CAPABILITY_SCOPE_TYPE_CCPP                           
56                         };
57                         
58                         
59                         struct TpTerminalCapabilityScope {
60                                 TpTerminalCapabilityScopeType ScopeType;
61                                 TpString Scope;
62                         };
63                         
64                         
65                         interface IpTerminalCapabilities : IpService {
66                                 TpTerminalCapabilities getTerminalCapabilities (
67                                         in TpString terminalIdentity    
68                                         )                                       
69                                         raises (TpCommonExceptions,P_INVALID_TERMINAL_ID);
70                                         
71                         };
72                         
73                         
74                         interface IpAppExtendedTerminalCapabilities : IpInterface {
75                                 void triggeredTerminalCapabilityReport (
76                                         in TpAssignmentID assignmentID, 
77                                         in TpAddressSet terminals,      
78                                         in TpTerminalCapabilityChangeCriteria criteria, 
79                                         in TpTerminalCapabilities capabilities  
80                                         );
81                                         
82                                 void triggeredTerminalCapabilityReportErr (
83                                         in TpAssignmentID assignmentId, 
84                                         in TpAddressSet terminals,      
85                                         in TpTerminalCapabilitiesError cause    
86                                         );
87                                         
88                         };
89                         
90                         
91                         interface IpExtendedTerminalCapabilities : IpTerminalCapabilities {
92                                 TpAssignmentID triggeredTerminalCapabilityStartReq (
93                                         in IpAppExtendedTerminalCapabilities appTerminalCapabilities,   
94                                         in TpAddressSet terminals,      
95                                         in TpTerminalCapabilityScope capabilityScope,   
96                                         in TpTerminalCapabilityChangeCriteria criteria  
97                                         )                                       
98                                         raises (TpCommonExceptions,P_INFORMATION_NOT_AVAILABLE,P_INVALID_INTERFACE_TYPE,P_INVALID_CRITERIA,P_INVALID_TERMINAL_ID);
99                                         
100                                 void triggeredTerminalCapabilityStop (
101                                         in TpAssignmentID assignmentID  
102                                         )                                       
103                                         raises (TpCommonExceptions,P_INVALID_ASSIGNMENT_ID);
104                                         
105                         };
106                         
107                 };
108                 
109         };
110         
111 };
112
113 #endif