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

   1 //Source file: gms.idl
   2 //Date:  11 October 2004
   3 //Generic Messaging Interfaces and Data Types for ETSI ES 203 915-09 V1.1.1, DES/TISPAN-01005-09-OSA, Parlay 5.0
   4
   5 #ifndef __GMS_DEFINED
   6 #define __GMS_DEFINED
   7
   8
   9 #include "osa.idl"
  10
  11 module org {
  12
  13         module csapi {
  14
  15
  16                 module gms {
  17                         interface IpAppMessagingManager ;
  18                         interface IpMailbox ;
  19                         interface IpMailboxFolder ;
  20
  21
  22
  23                         enum TpMessagingFault {
  24
  25                                 P_MESSAGING_FAULT_UNDEFINED
  26                         };
  27
  28
  29                         enum TpMessagingEventName {
  30
  31                                 P_EVENT_GMS_NAME_UNDEFINED,
  32                                 P_EVENT_GMS_NEW_MESSAGE_ARRIVED
  33                         };
  34
  35
  36                         enum TpMessageStatus {
  37
  38                                 P_MESSAGING_MESSAGE_STATUS_READ_MESSAGE,
  39                                 P_MESSAGING_MESSAGE_STATUS_UNREAD_MESSAGE,
  40                                 P_MESSAGING_MESSAGE_STATUS_FORWARDED_MESSAGE,
  41                                 P_MESSAGING_MESSAGE_STATUS_REPLIED_TO_MESSAGE,
  42                                 P_MESSAGING_MESSAGE_STATUS_SAVED_OR_UNSENT_MESSAGE,
  43                                 P_MESSAGING_MESSAGE_STATUS_NOTIFICATION_THAT_A_MESSAGE_WAS_DELIVERED,
  44                                 P_MESSAGING_MESSAGE_STATUS_NOTIFICATION_THAT_A_MESSAGE_WAS_READ,
  45                                 P_MESSAGING_MESSAGE_STATUS_NOTIFICATION_THAT_A_MESSAGE_WAS_NOT_DELIVERED,
  46                                 P_MESSAGING_MESSAGE_STATUS_NOTIFICATION_THAT_A_MESSAGE_WAS_NOT_READ
  47                         };
  48
  49
  50                         enum TpMessagePriority {
  51
  52                                 P_MESSAGING_MESSAGE_PRIORITY_UNDEFINED,
  53                                 P_MESSAGING_MESSAGE_PRIORITY_HIGH,
  54                                 P_MESSAGING_MESSAGE_PRIORITY_LOW
  55                         };
  56
  57
  58                         enum TpMessageInfoPropertyName {
  59
  60                                 P_MESSAGING_MESSAGE_UNDEFINED,
  61                                 P_MESSAGING_MESSAGE_ID,
  62                                 P_MESSAGING_MESSAGE_SUBJECT,
  63                                 P_MESSAGING_MESSAGE_DATE_SENT,
  64                                 P_MESSAGING_MESSAGE_DATE_RECEIVED,
  65                                 P_MESSAGING_MESSAGE_DATE_CHANGED,
  66                                 P_MESSAGING_MESSAGE_SENT_FROM,
  67                                 P_MESSAGING_MESSAGE_SENT_TO,
  68                                 P_MESSAGING_MESSAGE_CC_TO,
  69                                 P_MESSAGING_MESSAGE_BCC_TO,
  70                                 P_MESSAGING_MESSAGE_SIZE,
  71                                 P_MESSAGING_MESSAGE_PRIORITY,
  72                                 P_MESSAGING_MESSAGE_FORMAT,
  73                                 P_MESSAGING_MESSAGE_FOLDER,
  74                                 P_MESSAGING_MESSAGE_STATUS
  75                         };
  76
  77
  78                         enum TpMessageFormat {
  79
  80                                 P_MESSAGING_MESSAGE_FORMAT_UNDEFINED,
  81                                 P_MESSAGING_MESSAGE_FORMAT_TEXT,
  82                                 P_MESSAGING_MESSAGE_FORMAT_BINARY,
  83                                 P_MESSAGING_MESSAGE_FORMAT_UUENCODED,
  84                                 P_MESSAGING_MESSAGE_FORMAT_MIME,
  85                                 P_MESSAGING_MESSAGE_FORMAT_WAVE,
  86                                 P_MESSAGING_MESSAGE_FORMAT_AU
  87                         };
  88
  89
  90                         union TpMessageInfoProperty switch(TpMessageInfoPropertyName) {
  91                                 case P_MESSAGING_MESSAGE_ID: TpString MessagingMessageID;
  92                                 case P_MESSAGING_MESSAGE_SUBJECT: TpString MessagingMessageSubject;
  93                                 case P_MESSAGING_MESSAGE_DATE_SENT: TpDateAndTime MessagingMessageDateSent;
  94                                 case P_MESSAGING_MESSAGE_DATE_RECEIVED: TpDateAndTime MessagingMessageDateReceived;
  95                                 case P_MESSAGING_MESSAGE_DATE_CHANGED: TpDateAndTime MessagingMessageDateChanged;
  96                                 case P_MESSAGING_MESSAGE_SENT_FROM: TpAddress MessagingMessageSentFrom;
  97                                 case P_MESSAGING_MESSAGE_SENT_TO: TpAddress MessagingMessageSentTo;
  98                                 case P_MESSAGING_MESSAGE_CC_TO: TpAddress MessagingMessageCCTo;
  99                                 case P_MESSAGING_MESSAGE_BCC_TO: TpAddress MessagingMessageBCCTo;
 100                                 case P_MESSAGING_MESSAGE_SIZE: TpInt32 MessagingMessageSize;
 101                                 case P_MESSAGING_MESSAGE_PRIORITY: TpMessagePriority MessagingMessagePriority;
 102                                 case P_MESSAGING_MESSAGE_FORMAT: TpMessageFormat MessagingMessageFormat;
 103                                 case P_MESSAGING_MESSAGE_FOLDER: TpString MessagingMessageFolder;
 104                                 case P_MESSAGING_MESSAGE_STATUS: TpMessageStatus MessagingMessageStatus;
 105                                 default: short Dummy;
 106                         };
 107
 108
 109                         typedef sequence <TpMessageInfoProperty> TpMessageInfoPropertySet;
 110
 111
 112                         enum TpMailboxInfoPropertyName {
 113
 114                                 P_MESSAGING_MAILBOX_UNDEFINED,
 115                                 P_MESSAGING_MAILBOX_ID,
 116                                 P_MESSAGING_MAILBOX_OWNER,
 117                                 P_MESSAGING_MAILBOX_FOLDER,
 118                                 P_MESSAGING_MAILBOX_DATE_CREATED,
 119                                 P_MESSAGING_MAILBOX_DATE_CHANGED
 120                         };
 121
 122
 123                         union TpMailboxInfoProperty switch(TpMailboxInfoPropertyName) {
 124                                 case P_MESSAGING_MAILBOX_ID: TpAddress MessagingMailboxID;
 125                                 case P_MESSAGING_MAILBOX_OWNER: TpString MessagingMailboxOwner;
 126                                 case P_MESSAGING_MAILBOX_FOLDER: TpString MessagingMailboxFolder;
 127                                 case P_MESSAGING_MAILBOX_DATE_CREATED: TpDateAndTime MessagingMailboxDateCreated;
 128                                 case P_MESSAGING_MAILBOX_DATE_CHANGED: TpDateAndTime MessagingMailboxDateChanged;
 129                                 default: short Dummy;
 130                         };
 131
 132
 133                         typedef sequence <TpMailboxInfoProperty> TpMailboxInfoPropertySet;
 134
 135
 136                         struct TpGMSNewMessageArrivedInfo {
 137                                 TpAddress MailboxID;
 138                                 TpString FolderID;
 139                                 TpString MessageID;
 140                                 TpInt32 NumberOfProperties;
 141                         };
 142
 143
 144                         union TpMessagingEventInfo switch(TpMessagingEventName) {
 145                                 case P_EVENT_GMS_NAME_UNDEFINED: TpString EventNameUndefined;
 146                                 case P_EVENT_GMS_NEW_MESSAGE_ARRIVED: TpGMSNewMessageArrivedInfo EventGMSNewMessageArrived;
 147                         };
 148
 149
 150                         struct TpGMSNewMessageArrivedCriteria {
 151                                 TpAddress MailboxID;
 152                                 TpString AuthenticationInfo;
 153                         };
 154
 155
 156                         union TpMessagingEventCriteria switch(TpMessagingEventName) {
 157                                 case P_EVENT_GMS_NEW_MESSAGE_ARRIVED: TpGMSNewMessageArrivedCriteria EventGMSNewMessageArrived;
 158                                 default: short Dummy;
 159                         };
 160
 161
 162                         enum TpFolderInfoPropertyName {
 163
 164                                 P_MESSAGING_FOLDER_UNDEFINED,
 165                                 P_MESSAGING_FOLDER_ID,
 166                                 P_MESSAGING_FOLDER_MESSAGE,
 167                                 P_MESSAGING_FOLDER_SUBFOLDER,
 168                                 P_MESSAGING_FOLDER_DATE_CREATED,
 169                                 P_MESSAGING_FOLDER_DATE_CHANGED
 170                         };
 171
 172
 173                         union TpFolderInfoProperty switch(TpFolderInfoPropertyName) {
 174                                 case P_MESSAGING_FOLDER_ID: TpString MessagingFolderID;
 175                                 case P_MESSAGING_FOLDER_MESSAGE: TpString MessagingFolderMessage;
 176                                 case P_MESSAGING_FOLDER_SUBFOLDER: TpString MessagingFolderSubfolder;
 177                                 case P_MESSAGING_FOLDER_DATE_CREATED: TpDateAndTime MessagingFolderDateCreated;
 178                                 case P_MESSAGING_FOLDER_DATE_CHANGED: TpDateAndTime MessagingFolderDateChanged;
 179                                 default: short Dummy;
 180                         };
 181
 182
 183                         typedef sequence <TpFolderInfoProperty> TpFolderInfoPropertySet;
 184
 185
 186                         exception P_GMS_INVALID_FOLDER_ID {
 187                                 TpString ExtraInformation;
 188                         };
 189
 190
 191                         exception P_GMS_INSUFFICIENT_PRIVILEGE {
 192                                 TpString ExtraInformation;
 193                         };
 194
 195
 196                         exception P_GMS_INVALID_AUTHENTICATION_INFORMATION {
 197                                 TpString ExtraInformation;
 198                         };
 199
 200
 201                         exception P_GMS_INVALID_MAILBOX {
 202                                 TpString ExtraInformation;
 203                         };
 204
 205
 206                         exception P_GMS_INVALID_MESSAGE_ID {
 207                                 TpString ExtraInformation;
 208                         };
 209
 210
 211                         exception P_GMS_LOCKING_LOCKED_MAILBOX {
 212                                 TpString ExtraInformation;
 213                         };
 214
 215
 216                         exception P_GMS_MESSAGE_NOT_REMOVED {
 217                                 TpString ExtraInformation;
 218                         };
 219
 220
 221                         exception P_GMS_NUMBER_NOT_POSITIVE {
 222                                 TpString ExtraInformation;
 223                         };
 224
 225
 226                         exception P_GMS_UNLOCKING_UNLOCKED_MAILBOX {
 227                                 TpString ExtraInformation;
 228                         };
 229
 230
 231                         exception P_GMS_MAILBOX_LOCKED {
 232                                 TpString ExtraInformation;
 233                         };
 234
 235
 236                         exception P_GMS_CANNOT_UNLOCK_MAILBOX {
 237                                 TpString ExtraInformation;
 238                         };
 239
 240
 241                         exception P_GMS_PROPERTY_NOT_SET {
 242                                 TpString ExtraInformation;
 243                         };
 244
 245
 246                         exception P_GMS_FOLDER_IS_OPEN {
 247                                 TpString ExtraInformation;
 248                         };
 249
 250
 251                         exception P_GMS_MAILBOX_OPEN {
 252                                 TpString ExtraInformation;
 253                         };
 254
 255
 256                         typedef TpLongString TpMessage;
 257
 258
 259                         struct TpMailboxIdentifier {
 260                                 IpMailbox Mailbox;
 261                                 TpSessionID SessionID;
 262                         };
 263
 264
 265                         struct TpMailboxFolderIdentifier {
 266                                 IpMailboxFolder MailboxFolder;
 267                                 TpSessionID SessionID;
 268                         };
 269
 270
 271                         interface IpMessagingManager : IpService {
 272
 273                                 TpMailboxIdentifier openMailbox (
 274                                         in TpAddress mailboxID,
 275                                         in TpString authenticationInfo
 276                                         )
 277                                         raises (TpCommonExceptions,P_GMS_INVALID_MAILBOX,P_GMS_INVALID_AUTHENTICATION_INFORMATION);
 278
 279                                 TpAssignmentID enableMessagingNotification (
 280                                         in IpAppMessagingManager appInterface,
 281                                         in TpMessagingEventCriteria eventCriteria
 282                                         )
 283                                         raises (TpCommonExceptions,P_INVALID_CRITERIA);
 284
 285                                 void disableMessagingNotification (
 286                                         in TpAssignmentID assignmentID
 287                                         )
 288                                         raises (TpCommonExceptions,P_INVALID_ASSIGNMENT_ID);
 289
 290                         };
 291
 292
 293                         interface IpAppMessagingManager : IpInterface {
 294                                 void mailboxTerminated (
 295                                         in IpMailbox mailbox,
 296                                         in TpSessionID mailboxSessionID
 297                                         );
 298
 299                                 void mailboxFaultDetected (
 300                                         in IpMailbox mailbox,
 301                                         in TpSessionID mailboxSessionID,
 302                                         in TpMessagingFault fault
 303                                         );
 304
 305                                 void messagingEventNotify (
 306                                         in IpMessagingManager messagingManager,
 307                                         in TpMessagingEventInfo eventInfo,
 308                                         in TpAssignmentID assignmentID
 309                                         );
 310
 311                                 void messagingNotificationTerminated ();
 312
 313                         };
 314
 315
 316                         interface IpMailbox : IpService {
 317
 318                                 void close (
 319                                         in TpSessionID mailboxSessionID
 320                                         )
 321                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 322
 323                                 void lock (
 324                                         in TpSessionID mailboxSessionID
 325                                         )
 326                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_LOCKING_LOCKED_MAILBOX);
 327
 328                                 void unlock (
 329                                         in TpSessionID mailboxSessionID
 330                                         )
 331                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_UNLOCKING_UNLOCKED_MAILBOX,P_GMS_CANNOT_UNLOCK_MAILBOX);
 332
 333                                 TpInt32 getInfoAmount (
 334                                         in TpSessionID mailboxSessionID
 335                                         )
 336                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 337
 338                                 TpMailboxInfoPropertySet getInfoProperties (
 339                                         in TpSessionID mailboxSessionID,
 340                                         in TpInt32 firstProperty,
 341                                         in TpInt32 numberOfProperties
 342                                         )
 343                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_NUMBER_NOT_POSITIVE);
 344
 345                                 void setInfoProperties (
 346                                         in TpSessionID mailboxSessionID,
 347                                         in TpInt32 firstProperty,
 348                                         in TpMailboxInfoPropertySet mailboxInfoProperties
 349                                         )
 350                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_PROPERTY_NOT_SET,P_GMS_MAILBOX_LOCKED);
 351
 352                                 TpMailboxFolderIdentifier openFolder (
 353                                         in TpSessionID mailboxSessionID,
 354                                         in TpString folderID
 355                                         )
 356                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_FOLDER_IS_OPEN,P_GMS_INVALID_FOLDER_ID,P_GMS_MAILBOX_LOCKED);
 357
 358                                 void createFolder (
 359                                         in TpSessionID mailboxSessionID,
 360                                         in TpString folderID
 361                                         )
 362                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_INVALID_FOLDER_ID,P_GMS_MAILBOX_LOCKED);
 363
 364                                 void remove (
 365                                         in TpAddress mailboxID,
 366                                         in TpString authenticationInfo
 367                                         )
 368                                         raises (TpCommonExceptions,P_GMS_INSUFFICIENT_PRIVILEGE,P_GMS_INVALID_MAILBOX,P_GMS_MAILBOX_LOCKED,P_GMS_MAILBOX_OPEN,P_GMS_INVALID_AUTHENTICATION_INFORMATION);
 369
 370                         };
 371
 372                         interface IpMessage : IpService {
 373
 374                                 TpInt32 getInfoAmount (
 375                                         in TpSessionID folderSessionID,
 376                                         in TpString messageID
 377                                         )
 378                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_INVALID_MESSAGE_ID);
 379
 380                                 TpMessageInfoPropertySet getInfoProperties (
 381                                         in TpSessionID folderSessionID,
 382                                         in TpString messageID,
 383                                         in TpInt32 firstProperty,
 384                                         in TpInt32 numberOfProperties
 385                                         )
 386                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_NUMBER_NOT_POSITIVE,P_GMS_INVALID_MESSAGE_ID);
 387
 388                                 void setInfoProperties (
 389                                         in TpSessionID folderSessionID,
 390                                         in TpString messageID,
 391                                         in TpInt32 firstProperty,
 392                                         in TpMessageInfoPropertySet messageInfoProperties
 393                                         )
 394                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_INVALID_MESSAGE_ID,P_GMS_PROPERTY_NOT_SET);
 395
 396                                 void remove (
 397                                         in TpSessionID folderSessionID,
 398                                         in TpString messageID
 399                                         )
 400                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_INSUFFICIENT_PRIVILEGE,P_GMS_MESSAGE_NOT_REMOVED,P_GMS_INVALID_MESSAGE_ID);
 401
 402                                 TpMessage getContent (
 403                                         in TpSessionID folderSessionID,
 404                                         in TpString messageID
 405                                         )
 406                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_INVALID_MESSAGE_ID);
 407
 408                         };
 409
 410                         interface IpMailboxFolder : IpService {
 411
 412                                 TpInt32 getInfoAmount (
 413                                         in TpSessionID folderSessionID
 414                                         )
 415                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 416
 417                                 TpFolderInfoPropertySet getInfoProperties (
 418                                         in TpSessionID folderSessionID,
 419                                         in TpInt32 firstProperty,
 420                                         in TpInt32 numberOfProperties
 421                                         )
 422                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_NUMBER_NOT_POSITIVE);
 423
 424                                 void setInfoProperties (
 425                                         in TpSessionID folderSessionID,
 426                                         in TpInt32 firstProperty,
 427                                         in TpFolderInfoPropertySet folderInfoProperties
 428                                         )
 429                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_PROPERTY_NOT_SET);
 430
 431                                 void putMessage (
 432                                         in TpSessionID folderSessionID,
 433                                         in TpMessage message,
 434                                         in TpMessageInfoPropertySet messageInfoProperties
 435                                         )
 436                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 437
 438                                 IpMessage getMessage (
 439                                         in TpSessionID folderSessionID,
 440                                         in TpString messageID
 441                                         )
 442                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_INVALID_MESSAGE_ID);
 443
 444                                 void close (
 445                                         in TpSessionID mailboxSessionID,
 446                                         in TpSessionID folderSessionID
 447                                         )
 448                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 449
 450                                 void remove (
 451                                         in TpSessionID mailboxSessionID,
 452                                         in TpString folderID
 453                                         )
 454                                         raises (TpCommonExceptions,P_INVALID_SESSION_ID,P_GMS_INSUFFICIENT_PRIVILEGE,P_GMS_INVALID_FOLDER_ID,P_GMS_FOLDER_IS_OPEN);
 455
 456                         };
 457
 458                 };
 459
 460         };
 461
 462 };
 463
 464 #endif