epan/dissectors/corba-idl/parlay/pam_data.idl

   1 //Source file: pam_data.idl
   2 //Date:  13 October 2004
   3 //Presence and Availability Management Data Types for ES 203 915-14 V1.1.1, DES/TISPAN-01005-14-OSA, Parlay 5.0
   4
   5 #ifndef __PAM_DATA_DEFINED
   6 #define __PAM_DATA_DEFINED
   7
   8
   9 #include "osa.idl"
  10
  11 module org {
  12
  13         module csapi {
  14
  15                 module pam {
  16
  17
  18                         typedef TpInt64 TpPAMTimeInterval;
  19
  20
  21                         typedef TpURN TpPAMFQName;
  22
  23
  24                         typedef sequence <TpPAMFQName> TpPAMFQNameList;
  25
  26
  27                         typedef TpOctetSet TpPAMCredential;
  28
  29
  30                         typedef TpString TpPAMCapability;
  31
  32
  33                         typedef sequence <TpPAMCapability> TpPAMCapabilityList;
  34
  35
  36                         struct TpPAMAttributeDef {
  37                                 TpString Name;
  38                                 TpString Type;
  39                                 TpBoolean IsStatic;
  40                                 TpBoolean IsRevertOnExpiration;
  41                                 TpAny DefaultValues;
  42                         };
  43
  44
  45                         typedef sequence <TpPAMAttributeDef> TpPAMAttributeDefList;
  46
  47
  48                         struct TpPAMAttribute {
  49                                 TpString AttributeName;
  50                                 TpAttributeValue AttributeValue;
  51                                 TpPAMTimeInterval ExpiresIn;
  52                         };
  53
  54
  55                         typedef sequence <TpPAMAttribute> TpPAMAttributeList;
  56
  57                         const TpInt64 PAM_MAX_LONGINT = 0x7fffffff;
  58
  59                         exception P_PAM_UNKNOWN_TYPE {
  60                                 TpString ExtraInformation;
  61                         };
  62
  63
  64                         exception P_PAM_UNKNOWN_MEMBER {
  65                                 TpString ExtraInformation;
  66                         };
  67
  68
  69                         exception P_PAM_UNKNOWN_IDENTITY {
  70                                 TpString ExtraInformation;
  71                         };
  72
  73
  74                         exception P_PAM_UNKNOWN_GROUP {
  75                                 TpString ExtraInformation;
  76                         };
  77
  78
  79                         exception P_PAM_UNKNOWN_CAPABILITY {
  80                                 TpString ExtraInformation;
  81                         };
  82
  83
  84                         exception P_PAM_UNKNOWN_ATTRIBUTES {
  85                                 TpString ExtraInformation;
  86                         };
  87
  88
  89                         exception P_PAM_UNKNOWN_ATTRIBUTE {
  90                                 TpString ExtraInformation;
  91                         };
  92
  93
  94                         exception P_PAM_UNKNOWN_ASSIGNMENT {
  95                                 TpString ExtraInformation;
  96                         };
  97
  98
  99                         exception P_PAM_UNKNOWN_ALIAS {
 100                                 TpString ExtraInformation;
 101                         };
 102
 103
 104                         exception P_PAM_UNKNOWN_AGENT {
 105                                 TpString ExtraInformation;
 106                         };
 107
 108
 109                         exception P_PAM_UNASSIGNED_ALIAS {
 110                                 TpString ExtraInformation;
 111                         };
 112
 113
 114                         exception P_PAM_TYPE_EXISTS {
 115                                 TpString ExtraInformation;
 116                         };
 117
 118
 119                         exception P_PAM_TYPE_ASSOCIATED {
 120                                 TpString ExtraInformation;
 121                         };
 122
 123
 124                         exception P_PAM_NOT_REGISTERED {
 125                                 TpString ExtraInformation;
 126                         };
 127
 128
 129                         exception P_PAM_NOT_MEMBER {
 130                                 TpString ExtraInformation;
 131                         };
 132
 133
 134                         exception P_PAM_NO_CAPABILITY {
 135                                 TpString ExtraInformation;
 136                         };
 137
 138
 139                         exception P_PAM_MEMBER_EXISTS {
 140                                 TpString ExtraInformation;
 141                         };
 142
 143
 144                         exception P_PAM_IS_CYCLIC {
 145                                 TpString ExtraInformation;
 146                         };
 147
 148
 149                         exception P_PAM_IDENTITY_EXISTS {
 150                                 TpString ExtraInformation;
 151                         };
 152
 153
 154                         exception P_PAM_DISASSOCIATED_TYPE {
 155                                 TpString ExtraInformation;
 156                         };
 157
 158
 159                         exception P_PAM_ATTRIBUTE_EXISTS {
 160                                 TpString ExtraInformation;
 161                         };
 162
 163
 164                         exception P_PAM_ALIAS_NOT_UNIQUE {
 165                                 TpString ExtraInformation;
 166                         };
 167
 168
 169                         exception P_PAM_ALIAS_EXISTS {
 170                                 TpString ExtraInformation;
 171                         };
 172
 173
 174                         exception P_PAM_AGENT_EXISTS {
 175                                 TpString ExtraInformation;
 176                         };
 177
 178
 179                         struct TpPAMPresenceData {
 180                                 TpString Name;
 181                                 TpString subscriberStatus;
 182                                 TpString networkStatus;
 183                                 TpPAMCapability communicationMeans;
 184                                 TpAddress contactAddress;
 185                                 TpString subscriberProvidedLocation;
 186                                 TpString networkProvidedLocation;
 187                                 TpInt32 Priority;
 188                                 TpString otherInfo;
 189                         };
 190
 191
 192                         typedef sequence <TpPAMPresenceData> TpPAMPresenceDataList;
 193
 194
 195                         typedef TpString TpPAMPrivacyCode;
 196
 197
 198                         struct TpPAMAvailabilityProfile {
 199                                 TpPAMPrivacyCode PrivacyCode;
 200                                 TpPAMPresenceData AvailabilityData;
 201                         };
 202
 203
 204                         typedef sequence <TpPAMAvailabilityProfile> TpPAMAvailabilityProfileList;
 205
 206
 207                         enum TpPAMContextName {
 208
 209                                 PAM_CONTEXT_ANY,
 210                                 PAM_CONTEXT_COMMUNICATION
 211                         };
 212
 213
 214                         struct TpPAMCommunicationContext {
 215                                 TpPAMCapability CommunicationCapability;
 216                         };
 217
 218
 219                         union TpPAMContextData switch(TpPAMContextName) {
 220                                 case PAM_CONTEXT_COMMUNICATION: TpPAMCommunicationContext CommunicationContext;
 221                                 default: short Dummy;
 222                         };
 223
 224
 225                         struct TpPAMContext {
 226                                 TpPAMContextData ContextData;
 227                                 TpAttributeList AskerData;
 228                         };
 229
 230
 231                         typedef sequence <TpPAMContext> TpPAMContextList;
 232
 233
 234                         enum TpPAMACLDefault {
 235
 236                                 PAM_ACCESS_ALLOW,
 237                                 PAM_ACCESS_DENY
 238                         };
 239
 240
 241                         struct TpPAMAccessControlData {
 242                                 TpPAMACLDefault DefaultPolicy;
 243                                 TpPAMFQNameList AllowList;
 244                                 TpPAMFQNameList DenyList;
 245                         };
 246
 247
 248                         typedef TpString TpPAMPreferenceOp;
 249
 250
 251                         enum TpPAMPreferenceType {
 252
 253                                 PAM_ACCESS_LIST,
 254                                 PAM_EXTERNAL_CONTROL
 255                         };
 256
 257
 258                         enum TpPAMEventName {
 259
 260                                 PAM_CE_IDENTITY_PRESENCE_SET,
 261                                 PAM_CE_AVAILABILITY_CHANGED,
 262                                 PAM_CE_WATCHERS_CHANGED,
 263                                 PAM_CE_IDENTITY_CREATED,
 264                                 PAM_CE_IDENTITY_DELETED,
 265                                 PAM_CE_GROUP_MEMBERSHIP_CHANGED,
 266                                 PAM_CE_AGENT_CREATED,
 267                                 PAM_CE_AGENT_DELETED,
 268                                 PAM_CE_AGENT_ASSIGNED,
 269                                 PAM_CE_AGENT_UNASSIGNED,
 270                                 PAM_CE_CAPABILITY_CHANGED,
 271                                 PAM_CE_AGENT_CAPABILITY_PRESENCE_SET,
 272                                 PAM_CE_AGENT_PRESENCE_SET
 273                         };
 274
 275
 276                         typedef sequence <TpPAMEventName> TpPAMEventNameList;
 277
 278
 279                         struct TpPAMICEventData {
 280                                 TpStringList IdentityType;
 281                         };
 282
 283
 284                         struct TpPAMICNotificationData {
 285                                 TpPAMFQNameList Identities;
 286                         };
 287
 288
 289                         struct TpPAMIDEventData {
 290                                 TpPAMFQNameList IdentityName;
 291                                 TpStringList IdentityType;
 292                         };
 293
 294
 295                         struct TpPAMIDNotificationData {
 296                                 TpPAMFQNameList Identities;
 297                         };
 298
 299
 300                         struct TpPAMGMCEventData {
 301                                 TpPAMFQNameList GroupName;
 302                                 TpStringList GroupType;
 303                         };
 304
 305
 306                         struct TpPAMGMCNotificationData {
 307                                 TpPAMFQNameList Groups;
 308                         };
 309
 310
 311                         struct TpPAMACEventData {
 312                                 TpStringList AgentType;
 313                         };
 314
 315
 316                         struct TpPAMACNotificationData {
 317                                 TpPAMFQNameList Agents;
 318                         };
 319
 320
 321                         struct TpPAMADEventData {
 322                                 TpPAMFQNameList AgentName;
 323                                 TpStringList AgentType;
 324                         };
 325
 326
 327                         struct TpPAMADNotificationData {
 328                                 TpPAMFQNameList Agents;
 329                         };
 330
 331
 332                         struct TpPAMAAEventData {
 333                                 TpPAMFQNameList IdentityName;
 334                                 TpStringList IdentityType;
 335                                 TpPAMFQNameList AgentName;
 336                                 TpStringList AgentType;
 337                         };
 338
 339
 340                         struct TpPAMAANotificationData {
 341                                 TpPAMFQName Identity;
 342                                 TpPAMFQName Agent;
 343                         };
 344
 345
 346                         struct TpPAMAUEventData {
 347                                 TpPAMFQNameList IdentityName;
 348                                 TpStringList IdentityType;
 349                                 TpPAMFQNameList AgentName;
 350                                 TpStringList AgentType;
 351                         };
 352
 353
 354                         struct TpPAMAUNotificationData {
 355                                 TpPAMFQName Identity;
 356                                 TpPAMFQName Agent;
 357                         };
 358
 359
 360                         struct TpPAMCCEventData {
 361                                 TpPAMFQNameList IdentityName;
 362                                 TpStringList IdentityType;
 363                                 TpPAMCapabilityList Capabilities;
 364                         };
 365
 366
 367                         struct TpPAMCCNotificationData {
 368                                 TpPAMFQName Identity;
 369                                 TpPAMCapabilityList Capabilities;
 370                         };
 371
 372
 373                         struct TpPAMACPSEventData {
 374                                 TpPAMFQNameList AgentName;
 375                                 TpStringList AgentType;
 376                                 TpPAMCapabilityList Capabilities;
 377                                 TpStringList AttributeNames;
 378                                 TpPAMTimeInterval ReportingPeriod;
 379                         };
 380
 381
 382                         struct TpPAMACPSNotificationData {
 383                                 TpPAMFQName Agent;
 384                                 TpPAMCapability Capability;
 385                                 TpStringList AttributeNames;
 386                         };
 387
 388
 389                         struct TpPAMAPSEventData {
 390                                 TpPAMFQNameList AgentName;
 391                                 TpStringList AgentType;
 392                                 TpStringList AttributeNames;
 393                                 TpPAMTimeInterval ReportingPeriod;
 394                         };
 395
 396
 397                         struct TpPAMAPSNotificationData {
 398                                 TpPAMFQName Agent;
 399                                 TpStringList AttributeNames;
 400                         };
 401
 402
 403                         struct TpPAMIPSEventData {
 404                                 TpPAMFQNameList IdentityName;
 405                                 TpStringList IdentityType;
 406                                 TpStringList AttributeNames;
 407                                 TpPAMTimeInterval ReportingPeriod;
 408                         };
 409
 410
 411                         struct TpPAMIPSNotificationData {
 412                                 TpPAMFQName Identity;
 413                                 TpPAMPresenceDataList Attributes;
 414                         };
 415
 416
 417                         struct TpPAMAVCEventData {
 418                                 TpPAMFQNameList IdentityName;
 419                                 TpStringList IdentityType;
 420                                 TpPAMContextList PAMContext;
 421                                 TpStringList AttributeNames;
 422                                 TpPAMTimeInterval ReportingPeriod;
 423                         };
 424
 425
 426                         struct TpPAMAVCNotificationData {
 427                                 TpPAMFQName Identity;
 428                                 TpPAMAvailabilityProfileList Availability;
 429                         };
 430
 431
 432                         struct TpPAMWCEventData {
 433                                 TpPAMEventNameList Events;
 434                                 TpPAMFQNameList IdentityName;
 435                                 TpStringList IdentityType;
 436                                 TpPAMTimeInterval ReportingPeriod;
 437                         };
 438
 439
 440                         union TpPAMEventInfo switch(TpPAMEventName) {
 441                                 case PAM_CE_IDENTITY_PRESENCE_SET: TpPAMIPSEventData IdentityPresenceSet;
 442                                 case PAM_CE_AVAILABILITY_CHANGED: TpPAMAVCEventData AvailabilityChanged;
 443                                 case PAM_CE_WATCHERS_CHANGED: TpPAMWCEventData WatchersChanged;
 444                                 case PAM_CE_IDENTITY_CREATED: TpPAMICEventData IdentityCreated;
 445                                 case PAM_CE_IDENTITY_DELETED: TpPAMIDEventData IdentityDeleted;
 446                                 case PAM_CE_GROUP_MEMBERSHIP_CHANGED: TpPAMGMCEventData GroupMembershipChanged;
 447                                 case PAM_CE_AGENT_CREATED: TpPAMACEventData AgentCreated;
 448                                 case PAM_CE_AGENT_DELETED: TpPAMADEventData AgentDeleted;
 449                                 case PAM_CE_AGENT_ASSIGNED: TpPAMAAEventData AgentAssigned;
 450                                 case PAM_CE_AGENT_UNASSIGNED: TpPAMAUEventData AgentUnassigned;
 451                                 case PAM_CE_CAPABILITY_CHANGED: TpPAMCCEventData CapabilityChanged;
 452                                 case PAM_CE_AGENT_CAPABILITY_PRESENCE_SET: TpPAMACPSEventData AgentCapabilityPresenceSet;
 453                                 case PAM_CE_AGENT_PRESENCE_SET: TpPAMAPSEventData AgentPresenceSet;
 454                         };
 455
 456
 457                         enum TpPAMwatcherChangeType {
 458
 459                                 PAM_WATCHERS_PERIODIC,
 460                                 PAM_WATCHERS_ADDED,
 461                                 PAM_WATCHERS_DELETED
 462                         };
 463
 464
 465                         struct TpPAMWCNotificationData {
 466                                 TpPAMEventName Event;
 467                                 TpPAMwatcherChangeType ChangeType;
 468                                 TpPAMFQName Identity;
 469                                 TpPAMFQNameList Watchers;
 470                         };
 471
 472
 473                         union TpPAMNotificationInfo switch(TpPAMEventName) {
 474                                 case PAM_CE_IDENTITY_PRESENCE_SET: TpPAMIPSNotificationData IdentityPresenceSetNotify;
 475                                 case PAM_CE_AVAILABILITY_CHANGED: TpPAMAVCNotificationData AvailabilityChangedNotify;
 476                                 case PAM_CE_WATCHERS_CHANGED: TpPAMWCNotificationData WatchersChangedNotify;
 477                                 case PAM_CE_IDENTITY_CREATED: TpPAMICNotificationData IdentityCreatedNotify;
 478                                 case PAM_CE_IDENTITY_DELETED: TpPAMIDNotificationData IdentityDeletedNotify;
 479                                 case PAM_CE_GROUP_MEMBERSHIP_CHANGED: TpPAMGMCNotificationData GroupMembershipChangedNotify;
 480                                 case PAM_CE_AGENT_CREATED: TpPAMACNotificationData AgentCreatedNotify;
 481                                 case PAM_CE_AGENT_DELETED: TpPAMADNotificationData AgentDeletedNotify;
 482                                 case PAM_CE_AGENT_ASSIGNED: TpPAMAANotificationData AgentAssignedNotify;
 483                                 case PAM_CE_AGENT_UNASSIGNED: TpPAMAUNotificationData AgentUnassignedNotify;
 484                                 case PAM_CE_CAPABILITY_CHANGED: TpPAMCCNotificationData CapabilityChangedNotify;
 485                                 case PAM_CE_AGENT_CAPABILITY_PRESENCE_SET: TpPAMACPSNotificationData AgentCapabilityPresenceSetNotify;
 486                                 case PAM_CE_AGENT_PRESENCE_SET: TpPAMAPSNotificationData AgentPresenceSetNotify;
 487                         };
 488
 489
 490                         typedef TpString TpPAMProvisioningInterfaceName;
 491
 492
 493                         typedef TpString TpPAMPresenceAvailabilityInterfaceName;
 494
 495
 496                         typedef TpString TpPAMEventInterfaceName;
 497
 498
 499                         typedef sequence <TpPAMEventInfo> TpPAMEventInfoList;
 500
 501
 502                         typedef sequence <TpPAMNotificationInfo> TpPAMNotificationInfoList;
 503
 504
 505                         enum TpPAMErrorCause {
 506
 507                                 P_PAM_CAUSE_UNDEFINED,
 508                                 P_PAM_CAUSE_INVALID_ADDRESS,
 509                                 P_PAM_CAUSE_SYSTEM_FAILURE,
 510                                 P_PAM_CAUSE_INFO_UNAVAILABLE,
 511                                 P_PAM_CAUSE_EVENT_REGISTRATION_CANCELLED
 512                         };
 513
 514
 515                         struct TpPAMErrorInfo {
 516                                 TpPAMErrorCause Cause;
 517                                 TpPAMNotificationInfo ErrorData;
 518                         };
 519
 520
 521                         exception P_PAM_UNAVAILABLE_INTERFACE {
 522                                 TpString ExtraInformation;
 523                         };
 524
 525
 526                         typedef TpInt32 TpPAMClientID;
 527
 528
 529                         typedef TpAssignmentID TpPAMEventID;
 530
 531
 532                         exception P_PAM_INVALID_CREDENTIAL {
 533                                 TpString ExtraInformation;
 534                         };
 535
 536
 537                         const TpPAMCapability P_PAM_VOICE = "P_PAM_VOICE";
 538
 539                         const TpPAMCapability P_PAM_SMS = "P_PAM_SMS";
 540
 541                         const TpPAMCapability P_PAM_IM = "P_PAM_IM";
 542
 543                         const TpPAMCapability P_PAM_MMS = "P_PAM_MMS";
 544                 };
 545
 546         };
 547
 548 };
 549
 550 #endif