SIST ES 202 915-5 V1.2.1:2005

Open Service Access (OSA); Application Programming Interface (API); Part 5: User Interaction SCF (Parlay 4)

Maintenance update of ES 202 915-5 V1.1.1 to produce ES 202 915-5 V1.2.1 Updated document will also be known as PARLAY 4.1. Only those parts requiring modification will be updated ( most parts require maintenance fixes )

Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 5. del: Medsebojno vplivanje uporabnikov 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 202 915-5 V1.2.1 (2003-08) - Open Service Access (OSA); Application Programming Interface (API); Part 5: User Interaction SCF (Parlay 4)

Standards Content (Sample)

SLOVENSKI STANDARD
SIST ES 202 915-5 V1.2.1:2005
01-januar-2005
Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 5.
del: Medsebojno vplivanje uporabnikov SCF
Open Service Access (OSA); Application Programming Interface (API); Part 5: User
Interaction SCF (Parlay 4)
Ta slovenski standard je istoveten z: ES 202 915-5 Version 1.2.1
ICS:
33.040.01 Telekomunikacijski sistemi Telecommunication systems
na splošno in general
SIST ES 202 915-5 V1.2.1:2005 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

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

SIST ES 202 915-5 V1.2.1:2005

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

SIST ES 202 915-5 V1.2.1:2005

ETSI ES 202 915-5 V1.2.1 (2003-08)
ETSI Standard


Open Service Access (OSA);
Application Programming Interface (API);
Part 5: User Interaction SCF
(Parlay 4)



�

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

SIST ES 202 915-5 V1.2.1:2005
 2 ETSI ES 202 915-5 V1.2.1 (2003-08)



Reference
RES/SPAN-120096-5
Keywords
API, IDL, OSA, 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 202 915-5 V1.2.1:2005
 3 ETSI ES 202 915-5 V1.2.1 (2003-08)
Contents
Intellectual Property Rights.6
Foreword.6
1 Scope.7
2 References.7
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.7
4 Generic and Call User Interaction SCF.8
4.1 General requirements on support of methods.9
5 Sequence Diagrams.9
5.1 Alarm Call.9
5.2 Call Barring 1 .11
5.3 Network Controlled Notifications .12
5.4 Prepaid.13
5.5 Pre-Paid with Advice of Charge (AoC).15
6 Class Diagrams.18
7 The Service Interface Specifications.19
7.1 Interface Specification Format .19
7.1.1 Interface Class.19
7.1.2 Method descriptions.19
7.1.3 Parameter descriptions.19
7.1.4 State Model.19
7.2 Base Interface.19
7.2.1 Interface Class IpInterface .19
7.3 Service Interfaces.20
7.3.1 Overview.20
7.4 Generic Service Interface .20
7.4.1 Interface Class IpService .20
7.4.1.1 Method setCallback().20
7.4.1.2 Method setCallbackWithSessionID().20
8 Generic User Interaction Interface Classes .21
8.1 Interface Class IpUIManager .21
8.1.1 Method createUI().21
8.1.2 Method createUICall().22
8.1.3 Method createNotification().22
8.1.4 Method destroyNotification().23
8.1.5 Method changeNotification().23
8.1.6 Method getNotification().24
8.1.7 Method <> enableNotifications().24
8.1.8 Method <> disableNotifications().25
8.2 Interface Class IpAppUIManager.25
8.2.1 Method userInteractionAborted().25
8.2.2 Method <> reportNotification() .25
8.2.3 Method userInteractionNotificationInterrupted().26
8.2.4 Method userInteractionNotificationContinued().26
8.2.5 Method <> reportEventNotification().26
8.3 Interface Class IpUI.27
8.3.1 Method sendInfoReq().27
8.3.2 Method sendInfoAndCollectReq().28
8.3.3 Method release().29
8.4 Interface Class IpAppUI.29
ETSI

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

SIST ES 202 915-5 V1.2.1:2005
 4 ETSI ES 202 915-5 V1.2.1 (2003-08)
8.4.1 Method sendInfoRes().30
8.4.2 Method sendInfoErr().30
8.4.3 Method sendInfoAndCollectRes().30
8.4.4 Method sendInfoAndCollectErr().31
8.4.5 Method userInteractionFaultDetected().31
8.5 Interface Class IpUICall.31
8.5.1 Method recordMessageReq().32
8.5.2 Method deleteMessageReq().32
8.5.3 Method abortActionReq().33
8.6 Interface Class IpAppUICall .33
8.6.1 Method recordMessageRes().33
8.6.2 Method recordMessageErr().34
8.6.3 Method deleteMessageRes().34
8.6.4 Method deleteMessageErr().34
8.6.5 Method abortActionRes().35
8.6.6 Method abortActionErr().35
9 State Transition Diagrams.36
9.1 State Transition Diagrams for IpUIManager.36
9.1.1 Active State.36
9.1.2 Notification Terminated State.36
9.2 State Transition Diagrams for IpUI.37
9.2.1 Active State.37
9.2.2 Release Pending State.37
9.2.3 Finished State.37
9.3 State Transition Diagrams for IpUICall .38
9.3.1 Active State.38
9.3.2 Release Pending State.38
9.3.3 Finished State.39
10 Service Properties.39
10.1 User Interaction Service Properties .39
11 Data Definitions.39
11.1 TpUIFault.39
11.2 IpUI.39
11.3 IpUIRef.40
11.4 IpAppUI.40
11.5 IpAppUIRef.40
11.6 IpAppUIManager.40
11.7 IpAppUIManagerRef.40
11.8 TpUICallIdentifier.40
11.9 TpUICollectCriteria.40
11.10 TpUIError.41
11.11 TpUIEventCriteria.42
11.12 TpUIEventCriteriaResultSet.42
11.13 TpUIEventCriteriaResult.42
11.14 TpUIEventInfo.42
11.15 TpUIEventInfoDataType.42
11.16 TpUIIdentifier.43
11.17 TpUIInfo.43
11.18 TpUIInfoType.43
11.19 TpUIMessageCriteria.43
11.20 TpUIReport.44
11.21 TpUIResponseRequest.44
11.22 TpUITargetObjectType.44
11.23 TpUITargetObject.45
11.24 TpUIVariableInfo.45
11.25 TpUIVariableInfoSet.45
11.26 TpUIVariablePartType.45
11.27 TpUIEventNotificationInfo.46
12 Exception Classes.46
ETSI

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

SIST ES 202 915-5 V1.2.1:2005
 5 ETSI ES 202 915-5 V1.2.1 (2003-08)
Annex A (normative): OMG IDL Description of User Interaction SCF.47
Annex B (informative): W3C WSDL Description of User Interaction SCF .48
Annex C (informative): Java API Description of User Interaction SCF.49
Annex D (informative): Contents of 3GPP OSA R4 User Interaction.50
Annex E (informative): Record of changes .51
E.1 Interfaces.51
E.1.1 New.51
E.1.2 Deprecated.51
E.1.3 Removed.51
E.2 Methods.51
E.2.1 New.51
E.2.2 Deprecated.52
E.2.3 Modified.52
E.2.4 Removed.52
E.3 Data Definitions.52
E.3.1 New.52
E.3.2 Modified.52
E.3.3 Removed.53
E.4 Service Properties.53
E.4.1 New.53
E.4.2 Deprecated.53
E.4.3 Modified.53
E.4.4 Removed.53
E.5 Exceptions.54
E.5.1 New.54
E.5.2 Modified.54
E.5.3 Removed.54
E.6 Others.54
History .55

ETSI

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

SIST ES 202 915-5 V1.2.1:2005
 6 ETSI ES 202 915-5 V1.2.1 (2003-08)
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 5 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 202 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control";
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";
Part 13: "Policy management SCF";
Part 14: "Presence and Availability Management 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 4.1 set of specifications.
The present document is equivalent to 3GPP TS 29.198-5 V5.2.0 (Release 5).
ETSI

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

SIST ES 202 915-5 V1.2.1:2005
 7 ETSI ES 202 915-5 V1.2.1 (2003-08)
1 Scope
The present document is part 4 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 User Interaction (UI) Service Capability Feature (SCF) aspects of the interface. All
aspects of the User Interaction 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
• WSDL Description of the interfaces
• Reference to the Java API 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 202 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 202 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 4)".
ETSI ES 202 915-2: "Open Service Access (OSA); Application Programming Interface (API); Part 2: Common Data
Definitions (Parlay 4)".
ETSI ES 202 915-4-2: "Open Service Access (OSA); Application Programming Interface (API); Part 4: Call Control;
Sub-part 2: Generic Call Control SCF (Parlay 4)".
ETSI ES 202 915-4-3: "Open Service Access (OSA); Application Programming Interface (API); Part 4: Call Control;
Sub-part 3: Multi-Party Call Control SCF (Parlay 4)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 915-1 apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations defined in ES 202 915-1 apply.
ETSI

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

SIST ES 202 915-5 V1.2.1:2005
 8 ETSI ES 202 915-5 V1.2.1 (2003-08)
4 Generic and Call User Interaction SCF
The Generic User Interaction service capability f
...