idl/parlay/mpcc_data.idl

   1 //Source file: mpcc_data.idl
   2 //Date:  7 October 2004
   3 //Multi Party Call Control Data Types for ETSI ES 203 915-04-3 V1.1.1, DES/TISPAN-01005-04-3-OSA, Parlay 5.0
   4
   5 #ifndef __MPCC_DATA_DEFINED
   6 #define __MPCC_DATA_DEFINED
   7
   8
   9 #include "osa.idl"
  10 #include "common_cc_data.idl"
  11
  12 module org {
  13
  14         module csapi {
  15
  16                 module cc {
  17
  18                         enum TpCallAppInfoType {
  19
  20                                 P_CALL_APP_UNDEFINED,
  21                                 P_CALL_APP_ALERTING_MECHANISM,
  22                                 P_CALL_APP_NETWORK_ACCESS_TYPE,
  23                                 P_CALL_APP_TELE_SERVICE,
  24                                 P_CALL_APP_BEARER_SERVICE,
  25                                 P_CALL_APP_PARTY_CATEGORY,
  26                                 P_CALL_APP_PRESENTATION_ADDRESS,
  27                                 P_CALL_APP_GENERIC_INFO,
  28                                 P_CALL_APP_ADDITIONAL_ADDRESS,
  29                                 P_CALL_APP_ORIGINAL_DESTINATION_ADDRESS,
  30                                 P_CALL_APP_REDIRECTING_ADDRESS,
  31                                 P_CALL_APP_HIGH_PROBABILITY_COMPLETION,
  32                                 P_CALL_APP_CARRIER
  33                         };
  34
  35
  36                         enum TpCallEventType {
  37
  38                                 P_CALL_EVENT_UNDEFINED,
  39                                 P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT,
  40                                 P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED,
  41                                 P_CALL_EVENT_ADDRESS_COLLECTED,
  42                                 P_CALL_EVENT_ADDRESS_ANALYSED,
  43                                 P_CALL_EVENT_ORIGINATING_SERVICE_CODE,
  44                                 P_CALL_EVENT_ORIGINATING_RELEASE,
  45                                 P_CALL_EVENT_TERMINATING_CALL_ATTEMPT,
  46                                 P_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED,
  47                                 P_CALL_EVENT_ALERTING,
  48                                 P_CALL_EVENT_ANSWER,
  49                                 P_CALL_EVENT_TERMINATING_RELEASE,
  50                                 P_CALL_EVENT_REDIRECTED,
  51                                 P_CALL_EVENT_TERMINATING_SERVICE_CODE,
  52                                 P_CALL_EVENT_QUEUED
  53                         };
  54
  55
  56                         union TpCallAdditionalEventInfo switch(TpCallEventType) {
  57                                 case P_CALL_EVENT_ADDRESS_COLLECTED: TpAddress CollectedAddress;
  58                                 case P_CALL_EVENT_ADDRESS_ANALYSED: TpAddress CalledAddress;
  59                                 case P_CALL_EVENT_ORIGINATING_SERVICE_CODE: TpCallServiceCode OriginatingServiceCode;
  60                                 case P_CALL_EVENT_ORIGINATING_RELEASE: TpReleaseCause OriginatingReleaseCause;
  61                                 case P_CALL_EVENT_TERMINATING_RELEASE: TpReleaseCause TerminatingReleaseCause;
  62                                 case P_CALL_EVENT_REDIRECTED: TpAddress ForwardAddress;
  63                                 case P_CALL_EVENT_TERMINATING_SERVICE_CODE: TpCallServiceCode TerminatingServiceCode;
  64                                 default: short Dummy;
  65                         };
  66
  67
  68                         struct TpCallNotificationScope {
  69                                 TpAddressRange DestinationAddress;
  70                                 TpAddressRange OriginatingAddress;
  71                         };
  72
  73
  74                         struct TpCallNotificationReportScope {
  75                                 TpAddress DestinationAddress;
  76                                 TpAddress OriginatingAddress;
  77                         };
  78
  79
  80                         typedef sequence<TpReleaseCause> TpReleaseCauseSet;
  81
  82
  83                         union TpAdditionalCallEventCriteria switch(TpCallEventType) {
  84                                 case P_CALL_EVENT_ADDRESS_COLLECTED: TpInt32 MinAddressLength;
  85                                 case P_CALL_EVENT_ORIGINATING_SERVICE_CODE: TpCallServiceCodeSet OriginatingServiceCode;
  86                                 case P_CALL_EVENT_ORIGINATING_RELEASE: TpReleaseCauseSet OriginatingReleaseCauseSet;
  87                                 case P_CALL_EVENT_TERMINATING_RELEASE: TpReleaseCauseSet TerminatingReleaseCauseSet;
  88                                 case P_CALL_EVENT_TERMINATING_SERVICE_CODE: TpCallServiceCodeSet TerminatingServiceCode;
  89                                 default: short Dummy;
  90                         };
  91
  92
  93                         struct TpCallEventRequest {
  94                                 TpCallEventType CallEventType;
  95                                 TpAdditionalCallEventCriteria AdditionalCallEventCriteria;
  96                                 TpCallMonitorMode CallMonitorMode;
  97                         };
  98
  99
 100                         typedef sequence <TpCallEventRequest> TpCallEventRequestSet;
 101
 102
 103                         struct TpCallNotificationRequest {
 104                                 TpCallNotificationScope CallNotificationScope;
 105                                 TpCallEventRequestSet CallEventsRequested;
 106                         };
 107
 108
 109                         struct TpNotificationRequested {
 110                                 TpCallNotificationRequest AppCallNotificationRequest;
 111                                 TpInt32 AssignmentID;
 112                         };
 113
 114
 115                         typedef sequence <TpNotificationRequested> TpNotificationRequestedSet;
 116
 117
 118                         enum TpCallLegAttachMechanism {
 119
 120                                 P_CALLLEG_ATTACH_IMPLICITLY,
 121                                 P_CALLLEG_ATTACH_EXPLICITLY
 122                         };
 123
 124
 125                         struct TpCallLegConnectionProperties {
 126                                 TpCallLegAttachMechanism AttachMechanism;
 127                         };
 128
 129
 130                         const TpInt32 P_CALL_LEG_INFO_UNDEFINED = 0;
 131
 132                         const TpInt32 P_CALL_LEG_INFO_TIMES = 1;
 133
 134                         const TpInt32 P_CALL_LEG_INFO_RELEASE_CAUSE = 2;
 135
 136                         const TpInt32 P_CALL_LEG_INFO_ADDRESS = 4;
 137
 138                         const TpInt32 P_CALL_LEG_INFO_APPINFO = 8;
 139
 140                         typedef TpInt32 TpCallLegInfoType;
 141
 142
 143                         struct TpCallEventInfo {
 144                                 TpCallEventType CallEventType;
 145                                 TpCallAdditionalEventInfo AdditionalCallEventInfo;
 146                                 TpCallMonitorMode CallMonitorMode;
 147                                 TpDateAndTime CallEventTime;
 148                         };
 149
 150
 151                         typedef TpInt32 TpCallLegSuperviseTreatment;
 152
 153
 154                         const TpInt32 P_CALL_LEG_SUPERVISE_RELEASE = 1;
 155
 156                         const TpInt32 P_CALL_LEG_SUPERVISE_RESPOND = 2;
 157
 158                         const TpInt32 P_CALL_LEG_SUPERVISE_APPLY_TONE = 4;
 159
 160                         typedef TpInt32 TpCallHighProbabilityCompletion;
 161
 162
 163                         struct TpNotificationRequestedSetEntry {
 164                                 TpNotificationRequestedSet NotificationRequestSet;
 165                                 TpBoolean Final;
 166                         };
 167
 168
 169                         typedef TpOctetSet TpCarrierID;
 170
 171
 172                         enum TpCarrierSelectionField {
 173
 174                                 P_CIC_UNDEFINED,
 175                                 P_CIC_NO_INPUT,
 176                                 P_CIC_INPUT,
 177                                 P_CIC_UNDETERMINED,
 178                                 P_CIC_NOT_PRESCRIBED
 179                         };
 180
 181
 182                         struct TpCarrier {
 183                                 TpCarrierID CarrierID;
 184                                 TpCarrierSelectionField CarrierSelectionField;
 185                         };
 186
 187
 188                         typedef sequence <TpCarrier> TpCarrierSet;
 189
 190
 191                         union TpCallAppInfo switch(TpCallAppInfoType) {
 192                                 case P_CALL_APP_ALERTING_MECHANISM: TpCallAlertingMechanism CallAppAlertingMechanism;
 193                                 case P_CALL_APP_NETWORK_ACCESS_TYPE: TpCallNetworkAccessType CallAppNetworkAccessType;
 194                                 case P_CALL_APP_TELE_SERVICE: TpCallTeleService CallAppTeleService;
 195                                 case P_CALL_APP_BEARER_SERVICE: TpCallBearerService CallAppBearerService;
 196                                 case P_CALL_APP_PARTY_CATEGORY: TpCallPartyCategory CallAppPartyCategory;
 197                                 case P_CALL_APP_PRESENTATION_ADDRESS: TpAddress CallAppPresentationAddress;
 198                                 case P_CALL_APP_GENERIC_INFO: TpString CallAppGenericInfo;
 199                                 case P_CALL_APP_ADDITIONAL_ADDRESS: TpAddress CallAppAdditionalAddress;
 200                                 case P_CALL_APP_ORIGINAL_DESTINATION_ADDRESS: TpAddress CallAppOriginalDestinationAddress;
 201                                 case P_CALL_APP_REDIRECTING_ADDRESS: TpAddress CallAppRedirectingAddress;
 202                                 case P_CALL_APP_HIGH_PROBABILITY_COMPLETION: TpCallHighProbabilityCompletion CallHighProbabilityCompletion;
 203                                 case P_CALL_APP_CARRIER: TpCarrierSet CallAppCarrier;
 204                                 default: short Dummy;
 205                         };
 206
 207
 208                         typedef sequence <TpCallAppInfo> TpCallAppInfoSet;
 209
 210
 211                         struct TpCallNotificationInfo {
 212                                 TpCallNotificationReportScope CallNotificationReportScope;
 213                                 TpCallAppInfoSet CallAppInfo;
 214                                 TpCallEventInfo CallEventInfo;
 215                         };
 216
 217
 218                         struct TpCallLegInfoReport {
 219                                 TpCallLegInfoType CallLegInfoType;
 220                                 TpDateAndTime CallLegStartTime;
 221                                 TpDateAndTime CallLegConnectedToResourceTime;
 222                                 TpDateAndTime CallLegConnectedToAddressTime;
 223                                 TpDateAndTime CallLegEndTime;
 224                                 TpAddress ConnectedAddress;
 225                                 TpReleaseCause CallLegReleaseCause;
 226                                 TpCallAppInfoSet CallAppInfo;
 227                         };
 228
 229
 230                         typedef TpString TpCallLegPropertyName;
 231
 232
 233                         const TpCallLegPropertyName P_CALL_LEG_PROPERTY_INFO = "P_CALL_LEG_PROPERTY_INFO";
 234
 235                         const TpCallLegPropertyName P_CALL_LEG_PROPERTY_ICON = "P_CALL_LEG_PROPERTY_ICON";
 236
 237                         const TpCallLegPropertyName P_CALL_LEG_PROPERTY_CARD = "P_CALL_LEG_PROPERTY_CARD";
 238
 239                         typedef sequence <TpCallLegPropertyName> TpCallLegPropertyNameList;
 240
 241
 242                         typedef TpString TpCallLegPropertyValue;
 243
 244
 245                         struct TpCallLegProperty {
 246                                 TpCallLegPropertyName CallLegPropertyName;
 247                                 TpCallLegPropertyValue CallLegPropertyValue;
 248                         };
 249
 250
 251                         typedef sequence <TpCallLegProperty> TpCallLegPropertyList;
 252
 253                 };
 254
 255         };
 256
 257 };
 258
 259 #endif