SIST ES 201 915-9 V1.4.1:2005

Open Service Access (OSA); Application Programming Interface (API); Part 9: Generic Messaging SCF (Parlay 3)

Maintenance update of ES 201 915 v.1.3.1.  Updated document will also be known as Parlay 3.3.  Only those parts requiring modification will be updated ( most parts require maintenance fixes )

Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 9. del: Generično sporočanje SCF

General Information

• Status: Published
• Publication Date: 31-Dec-2004
• ICS: 33.040.01 - Telecommunication systems in general
• Technical Committee: SPN - Services and Protocols for Networks
• Current Stage: 6060 - National Implementation/Publication (Adopted Project)
• Start Date: 01-Jan-2005
• Due Date: 01-Jan-2005
• Completion Date: 01-Jan-2005
• Ref Project: ETSI ES 201 915-9 V1.4.1 (2003-07) - Open Service Access (OSA); Application Programming Interface (API); Part 9: Generic Messaging SCF (Parlay 3)

Standards Content (Sample)

SLOVENSKI STANDARD
SIST ES 201 915-9 V1.4.1:2005
01-januar-2005
2GSUWLGRVWRSGRVWRULWYH26$±9PHVQLN]DDSOLNDFLMVNRSURJUDPLUDQMH$3,±
GHO*HQHULþQRVSRURþDQMH6&)
Open Service Access (OSA); Application Programming Interface (API); Part 9: Generic
Messaging SCF (Parlay 3)
Ta slovenski standard je istoveten z: ES 201 915-9 Version 1.4.1
ICS:
33.040.01 Telekomunikacijski sistemi Telecommunication systems
na splošno in general
SIST ES 201 915-9 V1.4.1:2005 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

---------------------- Page: 1 ----------------------

SIST ES 201 915-9 V1.4.1:2005

---------------------- Page: 2 ----------------------

SIST ES 201 915-9 V1.4.1:2005

ETSI ES 201 915-9 V1.4.1 (2003-07)
ETSI Standard


Open Service Access (OSA);
Application Programming Interface (API);
Part 9: Generic Messaging SCF
(Parlay 3)



�

---------------------- Page: 3 ----------------------

SIST ES 201 915-9 V1.4.1:2005
 2 ETSI ES 201 915-9 V1.4.1 (2003-07)



Reference
RES/SPAN-120095-9
Keywords
API, OSA, IDL, UML
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88

Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, send your comment to:
[e-mail]
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.

© European Telecommunications Standards Institute 2003.
© The Parlay Group 2003.
All rights reserved.

TM TM TM
DECT , PLUGTESTS and UMTS are Trade Marks of ETSI registered for the benefit of its Members.
TM
TIPHON and the TIPHON logo are Trade Marks currently being registered by ETSI for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI

---------------------- Page: 4 ----------------------

SIST ES 201 915-9 V1.4.1:2005
 3 ETSI ES 201 915-9 V1.4.1 (2003-07)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
3 Definitions and abbreviations.6
3.1 Definitions.6
3.2 Abbreviations.6
4 Generic Messaging SCF.7
5 Sequence Diagrams.7
5.1 Prepare Mailbox.7
5.2 Open Mailbox.8
5.3 Get Message.8
5.4 Get Folder Information.9
5.5 Close Mailbox.10
6 Class Diagrams.10
7 The Service Interface Specifications.11
7.1 Interface Specification Format .11
7.1.1 Interface Class.11
7.1.2 Method descriptions.11
7.1.3 Parameter descriptions.12
7.1.4 State Model.12
7.2 Base Interface.12
7.2.1 Interface Class IpInterface .12
7.3 Service Interfaces.12
7.3.1 Overview.12
7.4 Generic Service Interface .12
7.4.1 Interface Class IpService .12
8 Generic Messaging Interface Classes.13
8.1 Interface Class IpMessagingManager .14
8.2 Interface Class IpAppMessagingManager.16
8.3 Interface Class IpMailbox .17
8.4 Interface Class IpMailboxFolder.22
8.5 Interface Class IpMessage.26
9 State Transition Diagrams.29
10 Data Definitions.29
10.1 Event notification Definitions.29
10.1.1 TpMessagingEventName.29
10.1.2 TpMessagingEventCriteria.29
10.1.3 TpGMSNewMessageArrivedCriteria.29
10.1.4 TpMessagingEventInfo.30
10.1.5 TpGMSNewMessageArrivedInfo.30
10.2 Generic Messaging Data Definitions.30
10.2.1 IpMessagingManager.30
10.2.2 IpMessagingManagerRef.30
10.2.3 IpAppMessagingManager.30
10.2.4 IpAppMessagingManagerRef.30
10.2.5 IpMailbox.30
10.2.6 IpMailboxRef.30
10.2.7 IpMailboxFolder.31
10.2.8 IpMailboxFolderRef.31
ETSI

---------------------- Page: 5 ----------------------

SIST ES 201 915-9 V1.4.1:2005
 4 ETSI ES 201 915-9 V1.4.1 (2003-07)
10.2.9 IpMessage.31
10.2.10 IpMessageRef.31
10.2.11 TpFolderInfoProperty.31
10.2.12 TpFolderInfoPropertyName.31
10.2.13 TpFolderInfoPropertySet.31
10.2.14 TpMailboxFolderIdentifier.32
10.2.15 TpMailboxIdentifier.32
10.2.16 TpMailboxInfoProperty.32
10.2.17 TpMailboxInfoPropertyName.32
10.2.18 TpMailboxInfoPropertySet.32
10.2.19 TpMessage.32
10.2.20 TpMessageFormat.33
10.2.21 TpMessageInfoProperty.33
10.2.22 TpMessageInfoPropertyName.34
10.2.23 TpMessageInfoPropertySet.34
10.2.24 TpMessagePriority.34
10.2.25 TpMessageStatus.35
10.2.26 TpMessagingFault.35
11 Exception Classes.36
Annex A (normative): OMG IDL Description of Generic Messaging SCF .37
Annex B (informative): Record of changes .38
B.1 Interfaces.38
B.1.1 New.38
B.1.2 Deprecated.38
B.1.3 Removed.38
B.2 Methods.38
B.2.1 New.38
B.2.2 Deprecated.38
B.2.3 Modified.39
B.2.4 Removed.39
B.3 Data Definitions.39
B.3.1 New.39
B.3.2 Modified.39
B.3.3 Removed.39
B.4 Service Properties.39
B.4.1 New.39
B.4.2 Deprecated.40
B.4.3 Modified.40
B.4.4 Removed.40
B.5 Exceptions.40
B.5.1 New.40
B.5.2 Modified.40
B.5.3 Removed.40
B.6 Others.40
History .41

ETSI

---------------------- Page: 6 ----------------------

SIST ES 201 915-9 V1.4.1:2005
 5 ETSI ES 201 915-9 V1.4.1 (2003-07)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Services and Protocols for Advanced
Networks (SPAN).
The present document is part 9 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 201 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control SCF";
Part 5: "User Interaction SCF";
Part 6: "Mobility SCF";
Part 7: "Terminal Capabilities SCF";
Part 8: "Data Session Control SCF";
Part 9: "Generic Messaging SCF";
Part 10: "Connectivity Manager SCF";
Part 11: "Account Management SCF";
Part 12: "Charging SCF".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP,
in co-operation with a number of JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 3.3 set of specifications.
ETSI

---------------------- Page: 7 ----------------------

SIST ES 201 915-9 V1.4.1:2005
 6 ETSI ES 201 915-9 V1.4.1 (2003-07)
1 Scope
The present document is part 9 of the Stage 3 specification for an Application Programming Interface (API) for Open
Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardised interface, i.e. the OSA APIs.
The present document specifies the Generic Messaging Service Capability Feature (SCF) aspects of the interface. All
aspects of the Generic Messaging SCF are defined here, these being:
• Sequence Diagrams
• Class Diagrams
• Interface specification plus detailed method descriptions
• State Transition diagrams
• Data Definitions
• IDL Description of the interfaces
The process by which this task is accomplished is through the use of object modelling techniques described by the
Unified Modelling Language (UML).
2 References
The references listed in clause 2 of ES 201 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 201 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 201 915-1 apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations defined in ES 201 915-1 apply.
ETSI

---------------------- Page: 8 ----------------------

SIST ES 201 915-9 V1.4.1:2005
 7 ETSI ES 201 915-9 V1.4.1 (2003-07)
4 Generic Messaging SCF
The following clauses describe each aspect of the Generic Messaging Service Capability Feature (SCF).
The order is as follows:
• The Sequence diagrams give the reader a practical idea of how each of the SCF is implemented.
• The Class relationships clause show how each of the interfaces applicable to the SCF, relate to one another.
• The Interface specification clause describes in detail each of the interfaces shown within the Class diagram
part.
• The State Transition Diagrams (STD) show the transition between states in the SCF. The states and transitions
are well-defined; either methods specified in the Interface specification or events occurring in the underlying
networks cause state transitions.
• The Data Definitions clause show a detailed expansion of each of the data types associated with the methods
within the classes. Note that some data types are used in other methods and classes and are therefore defined
within the Common Data types part of the present document.
5 Sequence Diagrams
5.1 Prepare Mailbox
: : :
IpAppLogic IpAppMess agingManager IpMessagingManager
1: new()
2: enableMessagingNotification( )
3: messagingEventNotify(  )
4: 'forward event'

1: This message is used by the application to create an object implementing the IpAppMessagingManager
interface.
2: This message is used to enable the notification mechanism so that events can be sent to the application.
When new mail, that matches the event criteria set in message 2, arrives a message indicating the presence of new mail
(not shown) is directed to the object implementing the IpMessagingManager.
ETSI

---------------------- Page: 9 ----------------------

SIST ES 201 915-9 V1.4.1:2005
 8 ETSI ES 201 915-9 V1.4.1 (2003-07)
3: This message is used to pass the new mail event to the object implementing the IpAppMessagingManager
interface.
4: This message is used to forward message 3 to the IpAppLogic.
5.2 Open Mailbox
: : : IpMailbox
IpAppLogic IpMessagingManager
1: openMailbox( )
2: new()

1: This message requests the object implementing the IpMessagingManager interface to create an object
implementing the IpMailbox interface.
2: Assuming that the criteria for creating an object implementing the IpMailbox interface is met, message 2 is
used to create it.
5.3 Get Message
: : IpMailbox : IpMailboxFolder : IpMessage
IpAppLogic
1: openFolder( )
2: getInfoAmount( )
3: getInfoProperties(  )
4: getMessage( )
5: new()

ETSI

---------------------- Page: 10 ----------------------

SIST ES 201 915-9 V1.4.1:2005
 9 ETSI ES 201 915-9 V1.4.1 (2003-07)
1: This message requests a folder to be opened and returns a reference to that folder.
2: This message requests the number of folder information properties of the opened folder.
3: This message requests all of the folder information properties.
4: This message requests a message from the opened mailbox folder.
5: Assuming that the criteria for creating an object implementing the IpMessage interface are met, the (internal)
message 5 is used to create it.
5.4 Get Folder Information
: :
IpAppLogic IpMailboxFolder
1: getInfoAmount( )
2: getInfoProperties(  )
3: getInfoProperties(  )

1: This message requests the number of folder information properties of the specified folder.
2: This message requests the first set of folder information properties.
3: This message requests the second set of folder information properties.
ETSI

---------------------- Page: 11 ----------------------

SIST ES 201 915-9 V1.4.1:2005
 10 ETSI ES 201 915-9 V1.4.1 (2003-07)
5.5 Close Mailbox
: : IpMailbox
IpAppLogic
1: close( )

1: This message requests the object implementing the IpMailbox interface to de-assign.
6 Class Diagrams
<>
IpService
(f ro m c sap i)
setCallback()
setCallbackWithSessionID()
<> <> <> <>
IpMessagingManager IpMailbox IpMailboxFolder IpMessage
(from gms) (from gms) (from gms) (from gms)
00.n.n
11 00.n.n 11 22.n.n 11

Figure 1: Package Overview: Service Interfaces
The application generic messaging service package consists of only one IpAppMessagingManager interface.
The generic messaging service package consists of one IpMessagingManager interface, zero or more IpMailbox
interfaces, zero or more IpMailboxFolder and zero or more IpMessage interfaces.
The class diagram in the following figure shows the interfaces that make up the application generic messaging service
package and the generic messaging service package. Communication between these packages is done via the +uses the
IpMessagingManager channels. Communication with the IpMailbox and IpMailboxFolder interfaces has to be done via
the application logic (not shown).
ETSI

---------------------- Page: 12 ----------------------

SIST ES 201 915-9 V1.4.1:2005
 11 ETSI ES 201 915-9 V1.4.1 (2003-07)
<>
IpInterface
(from csapi)
<>
IpAppMessagingManager
(from gms)
mailboxTerminated()
mailboxFaultDetected()
messagingEventNotify()
messagingNotificationTerminated()
1
<>
<>
IpMailbox <>
1
IpMailboxFolder <>
(from gms)
<> (from gms) IpMessage
IpMessagingManager (from gms)
close()
(from gms)
lock() getInfoAmount()
unlock() getInfoProperties() getInfoAmount()
1100.nn
openMailbox() 1100.nn getInfoAmount() 121 2.nn setInfoProperties() getInfoProperties()
enableMessagingNotification() getInfoProperties() putMessage() setInfoProperties()
disableMessagingNotification() setInfoProperties() getMessage() remove()
openFolder() close() getContent()
createFolder() remove()
remove()

Figure 2: Package Overview: Application and Service Interfaces
7 The Service Interface Specifications
7.1 Interface Specification Format
This clause defines the interfaces, methods and parameters that form a part of the API specification. The Unified
Modelling Language (UML) is used to specify the interface classes. The general format of an interface specification is
described below.
7.1.1 Interface Class
This shows a UML interface class description of the methods supported by that interface, and the relevant parameters
and types. The Service and Framework interfaces for enterprise-based client applications are denoted by classes with
name Ip. The callback interfaces to the applications are denoted by classes with name IpApp. For
the interfaces between a Service and the Framework, the Service interfaces are typically denoted by classes with name
IpSvc, while the Framework interfaces are denoted by classes with name IpFw
7.1.2 Method descriptions
Each method (API method “call”) is described. Both synchronous and asynchronous methods are used in the API.
Asynchronous methods are identified by a 'Req' suffix for a method request, and, if applicable, are served by
asynchronous methods identified by either a 'Res' or 'Err' suffix for method results and errors, respectively. To handle
responses and reports, the application or service developer must implement the relevant IpApp or
IpSvc interfaces to provide the callback mechanism.
ETSI

---------------------- Page: 13 ----------------------

SIST ES 201 915-9 V1.4.1:2005
 12 ETSI ES 201 915-9 V1.4.1 (2003-07)
7.1.3 Parameter descriptions
Each method parameter and its possible values are described. Parameters described as 'in' represent those that must have
a value when the method is called. Those described as 'out' are those that contain the return result of the method when
the method returns.
7.1.4 State Model
If relevant, a state model is shown to illustrate the states of the objects that implement the described interface.
7.2 Base Interface
7.2.1 Interface Class IpInterface
All application, fram
...