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