ETSI ES 204 915-5 V1.1.1 (2008-05)

Final draft ETSI ES 204 915-5 V1.1.1 (2008-02)
ETSI Standard


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



�

---------------------- Page: 1 ----------------------
2 Final draft ETSI ES 204 915-5 V1.1.1 (2008-02)



Reference
DES/TISPAN-01032-5-OSA
Keywords
API, IDL, OSA, UML
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: +33 4 92 94 42 00  Fax: +33 4 93 65 47 16

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, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
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 2008.
© The Parlay Group 2008.
All rights reserved.

TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
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: 2 ----------------------
3 Final draft ETSI ES 204 915-5 V1.1.1 (2008-02)
Contents
Intellectual Property Rights.7
Foreword.7
1 Scope.8
2 References.8
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Generic and Call User Interaction and Administration SCF .9
4.1 Generic and Call User Interaction SCF .9
4.2 Generic User Interaction Administration SCF .10
4.3 Generic User Interaction SCF Design Aspects.10
4.4 General requirements on support of methods.10
5 Sequence Diagrams.11
5.1 Generic and Call User Interaction Sequence Diagrams.11
5.1.1 Alarm Call.11
5.1.2 Call Barring 1 .12
5.1.3 Network Controlled Notifications.14
5.1.4 Prepaid.15
5.1.5 Pre-Paid with Advice of Charge (AoC) .16
5.2 Generic User Interaction Administration Sequence Diagrams.19
5.2.1 Message Administration.19
6 Class Diagrams.20
6.1 Generic and Call User Interaction Class Diagrams .20
6.2 Generic User Interaction Administration Class Diagrams .21
7 The Service Interface Specifications.22
7.1 Interface Specification Format .22
7.1.1 Interface Class.22
7.1.2 Method descriptions.22
7.1.3 Parameter descriptions.22
7.1.4 State Model.22
7.2 Base Interface.22
7.2.1 Interface Class IpInterface .22
7.3 Service Interfaces.23
7.3.1 Overview.23
7.4 Generic Service Interface .23
7.4.1 Interface Class IpService .23
7.4.1.1 Method setCallback().23
7.4.1.2 Method setCallbackWithSessionID().23
8 Generic User Interaction Interface Classes .24
8.1 Generic and Call User Interaction Interface Classes .24
8.1.1 Interface Class IpUIManager.24
8.1.1.1 Method createUI().25
8.1.1.2 Method createUICall().25
8.1.1.3 Method createNotification().25
8.1.1.4 Method destroyNotification().26
8.1.1.5 Method changeNotification().26
8.1.1.6 Method getNotification().27
8.1.1.7 Method enableNotifications().27
8.1.1.8 Method disableNotifications().27
8.1.2 Interface Class IpAppUIManager .28
8.1.2.1 Method userInteractionAborted().28
ETSI

---------------------- Page: 3 ----------------------
4 Final draft ETSI ES 204 915-5 V1.1.1 (2008-02)
8.1.2.2 Method userInteractionNotificationInterrupted().28
8.1.2.3 Method userInteractionNotificationContinued().29
8.1.2.4 Method reportEventNotification().29
8.1.2.5 Method abortMultipleUserInteractions().29
8.1.2.6 Method <> reportEventReq().30
8.1.3 Interface Class IpUI.30
8.1.3.1 Method sendInfoReq().31
8.1.3.2 Method sendInfoAndCollectReq().32
8.1.3.3 Method release().33
8.1.3.4 Method setOriginatingAddress().33
8.1.3.5 Method getOriginatingAddress().33
8.1.3.6 Method <> reportEventRes() .34
8.1.3.7 Method <> reportEventErr() .34
8.1.4 Interface Class IpAppUI .34
8.1.4.1 Method sendInfoRes().35
8.1.4.2 Method sendInfoErr().35
8.1.4.3 Method sendInfoAndCollectRes().36
8.1.4.4 Method sendInfoAndCollectErr().36
8.1.4.5 Method userInteractionFaultDetected().36
8.1.5 Interface Class IpUICall .37
8.1.5.1 Method recordMessageReq().37
8.1.5.2 Method deleteMessageReq().38
8.1.5.3 Method abortActionReq().38
8.1.5.4 Method getMessageReq().38
8.1.6 Interface Class IpAppUICall.39
8.1.6.1 Method recordMessageRes().39
8.1.6.2 Method recordMessageErr().40
8.1.6.3 Method deleteMessageRes().40
8.1.6.4 Method deleteMessageErr().40
8.1.6.5 Method abortActionRes().40
8.1.6.6 Method abortActionErr().41
8.1.6.7 Method getMessageRes().41
8.1.6.8 Method getMessageErr().41
8.2 Generic User Interaction Administration Interface Classes .41
8.2.1 Interface Class IpUIAdminManager.41
8.2.1.1 Method getMessageReq().42
8.2.1.2 Method putMessageReq().42
8.2.1.3 Method deleteMessageReq().43
8.2.1.4 Method getMessageListReq().43
8.2.2 Interface Class IpAppUIAdminManager .43
8.2.2.1 Method getMessageRes().44
8.2.2.2 Method getMessageErr().44
8.2.2.3 Method deleteMessageRes().44
8.2.2.4 Method deleteMessageErr().45
8.2.2.5 Method putMessageRes().45
8.2.2.6 Method putMessageErr().45
8.2.2.7 Method getMessageListRes().45
8.2.2.8 Method getMessageListErr().46
9 State Transition Diagrams.46
9.1 Generic and Call User Interaction State Transition Diagrams.46
9.1.1 State Transition Diagrams for IpUIManager .46
9.1.1.1 Active State.46
9.1.1.2 Notification Terminated State .47
9.1.2 State Transition Diagrams for IpUI .47
9.1.2.1 Active State.47
9.1.2.2 Release Pending State .47
9.1.2.3 Finished State.47
9.1.3 State Transition Diagrams for IpUICall.48
9.1.3.1 Active State.48
9.1.3.2 Release Pending State .48
9.1.3.3 Finished State.49
ETSI

---------------------- Page: 4 ----------------------
5 Final draft ETSI ES 204 915-5 V1.1.1 (2008-02)
9.2 Generic User Interaction Administration State Transition Diagrams.49
9.2.1 State Transition Diagrams for IpUIAdminManager .49
9.2.1.1 Active State.49
10 Service Properties.49
10.1 User Interaction Service Properties .49
11 Data Definitions.50
11.1 TpUIFault.50
11.2 IpUI.50
11.3 IpUIRef.50
11.4 IpAppUI.50
11.5 IpAppUIRef.50
11.6 IpAppUIManager.51
11.7 IpAppUIManagerRef.51
11.8 TpUICallIdentifier.51
11.9 TpUICollectCriteria.51
11.10 TpUIError.52
11.11 TpUIEventCriteria.53
11.12 TpUIEventCriteriaResultSet.53
11.13 TpUIEventCriteriaResult.53
11.14 TpUIEventInfoDataType.53
11.15 TpUIIdentifier.53
11.16 TpUIIdentifierSet.53
11.17 TpUIInfo.54
11.18 TpUIInfoType.55
11.19 TpUIMessageCriteria.55
11.20 TpUIReport.55
11.21 TpUIResponseRequest .56
11.22 TpUITargetObjectType.56
11.23 TpUITargetObject.56
11.24 TpUIVariableInfo.57
11.25 TpUIVariableInfoSet.57
11.26 TpUIVariablePartType.57
11.27 TpUIEventNotificationInfo.57
11.28 TpUISynthesisInfoData.57
11.29 TpUISynthesisGender.58
11.30 TpUISynthesisAge.58
11.31 TpUISynthesisRate.58
11.32 TpUISynthesisRange.58
11.33 TpUIWordOverrideSet.58
11.34 TpUIWordOverride.59
11.35 TpUIPronounceType.59
11.36 TpUICollectMode.59
11.37 TpUIRecognitionCriteria.59
11.38 TpUIRecognitionSpeakerID.60
11.39 TpUIRecognitionPropertySet.60
11.40 TpUIRecognitionProperty.60
11.41 TpUIRecognitionGrammar.60
11.42 TpMessageIDList.61
12 Exception Classes.62
Annex A (normative): OMG IDL Description of User Interaction SCF.63
Annex B (informative): W3C WSDL Description of User Interaction SCF .64
Annex C (informative): Java™ API Description of the User Interaction SCF.65
Annex D (informative): Contents of 3GPP OSA R7 User Interaction.66
Annex E (informative): Description of Generic User Interaction SCF for 3GPP2 cdma2000
networks.67
ETSI

---------------------- Page: 5 ----------------------
6 Final draft ETSI ES 204 915-5 V1.1.1 (2008-02)
E.1 General Exceptions.67
E.2 Specific Exceptions.67
E.2.1 Clause 1: Scope .67
E.2.2 Clause 2: References .67
E.2.3 Clause 3: Definitions and abbreviations.67
E.2.4 Clause 4: Generic and Call User Interaction SCF .67
E.2.5 Clause 5: Class Diagrams.67
E.2.6 Clause 6: Class Diagrams.67
E.2.7 Clause 7: The Service Interface Specifications .68
E.2.8 Clause 8: Generic User Interaction Interface Classes Definitions.68
E.2.9 Clause 9: State Transition Diagrams .
...

SLOVENSKI STANDARD
SIST ES 204 915-5 V1.1.1:2008
01-september-2008
Odprti dostop do storitve (OSA) - Aplikacijski programski vmesnik (API) - 5. del:
Lastnost storitvene zmožnosti (SCF) za medsebojno vplivanje z uporabnikom
(Parlay 6)
Open Service Access (OSA) - Application Programming Interface (API) - Part 5: User
Interaction SCF (Parlay 6)
Ta slovenski standard je istoveten z: ES 204 915-5 Version 1.1.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
SIST ES 204 915-5 V1.1.1:2008 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

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

SIST ES 204 915-5 V1.1.1:2008

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

SIST ES 204 915-5 V1.1.1:2008

ETSI ES 204 915-5 V1.1.1 (2008-05)
ETSI Standard


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



�

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

SIST ES 204 915-5 V1.1.1:2008
 2 ETSI ES 204 915-5 V1.1.1 (2008-05)



Reference
DES/TISPAN-01032-5-OSA
Keywords
API, IDL, OSA, UML
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: +33 4 92 94 42 00  Fax: +33 4 93 65 47 16

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, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
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 2008.
© The Parlay Group 2008.
All rights reserved.

TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
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 204 915-5 V1.1.1:2008
 3 ETSI ES 204 915-5 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.7
Foreword.7
1 Scope.8
2 References.8
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Generic and Call User Interaction and Administration SCF .9
4.1 Generic and Call User Interaction SCF .9
4.2 Generic User Interaction Administration SCF .10
4.3 Generic User Interaction SCF Design Aspects.10
4.4 General requirements on support of methods.10
5 Sequence Diagrams.11
5.1 Generic and Call User Interaction Sequence Diagrams.11
5.1.1 Alarm Call.11
5.1.2 Call Barring 1 .12
5.1.3 Network Controlled Notifications.14
5.1.4 Prepaid.15
5.1.5 Pre-Paid with Advice of Charge (AoC) .16
5.2 Generic User Interaction Administration Sequence Diagrams.19
5.2.1 Message Administration.19
6 Class Diagrams.20
6.1 Generic and Call User Interaction Class Diagrams .20
6.2 Generic User Interaction Administration Class Diagrams .21
7 The Service Interface Specifications.22
7.1 Interface Specification Format .22
7.1.1 Interface Class.22
7.1.2 Method descriptions.22
7.1.3 Parameter descriptions.22
7.1.4 State Model.22
7.2 Base Interface.22
7.2.1 Interface Class IpInterface .22
7.3 Service Interfaces.23
7.3.1 Overview.23
7.4 Generic Service Interface .23
7.4.1 Interface Class IpService .23
7.4.1.1 Method setCallback().23
7.4.1.2 Method setCallbackWithSessionID().23
8 Generic User Interaction Interface Classes .24
8.1 Generic and Call User Interaction Interface Classes .24
8.1.1 Interface Class IpUIManager.24
8.1.1.1 Method createUI().25
8.1.1.2 Method createUICall().25
8.1.1.3 Method createNotification().25
8.1.1.4 Method destroyNotification().26
8.1.1.5 Method changeNotification().26
8.1.1.6 Method getNotification().27
8.1.1.7 Method enableNotifications().27
8.1.1.8 Method disableNotifications().27
8.1.2 Interface Class IpAppUIManager .28
8.1.2.1 Method userInteractionAborted().28
ETSI

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

SIST ES 204 915-5 V1.1.1:2008
 4 ETSI ES 204 915-5 V1.1.1 (2008-05)
8.1.2.2 Method userInteractionNotificationInterrupted().28
8.1.2.3 Method userInteractionNotificationContinued().29
8.1.2.4 Method reportEventNotification().29
8.1.2.5 Method abortMultipleUserInteractions().29
8.1.2.6 Method <> reportEventReq().30
8.1.3 Interface Class IpUI.30
8.1.3.1 Method sendInfoReq().31
8.1.3.2 Method sendInfoAndCollectReq().32
8.1.3.3 Method release().33
8.1.3.4 Method setOriginatingAddress().33
8.1.3.5 Method getOriginatingAddress().33
8.1.3.6 Method <> reportEventRes() .34
8.1.3.7 Method <> reportEventErr() .34
8.1.4 Interface Class IpAppUI .35
8.1.4.1 Method sendInfoRes().35
8.1.4.2 Method sendInfoErr().35
8.1.4.3 Method sendInfoAndCollectRes().36
8.1.4.4 Method sendInfoAndCollectErr().36
8.1.4.5 Method userInteractionFaultDetected().36
8.1.5 Interface Class IpUICall .37
8.1.5.1 Method recordMessageReq().37
8.1.5.2 Method deleteMessageReq().38
8.1.5.3 Method abortActionReq().38
8.1.5.4 Method getMessageReq().38
8.1.6 Interface Class IpAppUICall.39
8.1.6.1 Method recordMessageRes().39
8.1.6.2 Method recordMessageErr().40
8.1.6.3 Method deleteMessageRes().40
8.1.6.4 Method deleteMessageErr().40
8.1.6.5 Method abortActionRes().40
8.1.6.6 Method abortActionErr().41
8.1.6.7 Method getMessageRes().41
8.1.6.8 Method getMessageErr().41
8.2 Generic User Interaction Administration Interface Classes .41
8.2.1 Interface Class IpUIAdminManager.41
8.2.1.1 Method getMessageReq().42
8.2.1.2 Method putMessageReq().42
8.2.1.3 Method deleteMessageReq().43
8.2.1.4 Method getMessageListReq().43
8.2.2 Interface Class IpAppUIAdminManager .43
8.2.2.1 Method getMessageRes().44
8.2.2.2 Method getMessageErr().44
8.2.2.3 Method deleteMessageRes().44
8.2.2.4 Method deleteMessageErr().45
8.2.2.5 Method putMessageRes().45
8.2.2.6 Method putMessageErr().45
8.2.2.7 Method getMessageListRes().45
8.2.2.8 Method getMessageListErr().46
9 State Transition Diagrams.46
9.1 Generic and Call User Interaction State Transition Diagrams.46
9.1.1 State Transition Diagrams for IpUIManager .46
9.1.1.1 Active State.46
9.1.1.2 Notification Terminated State .47
9.1.2 State Transition Diagrams for IpUI .47
9.1.2.1 Active State.47
9.1.2.2 Release Pending State .47
9.1.2.3 Finished State.47
9.1.3 State Transition Diagrams for IpUICall.48
9.1.3.1 Active State.48
9.1.3.2 Release Pending State .48
9.1.3.3 Finished State.49
ETSI

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

SIST ES 204 915-5 V1.1.1:2008
 5 ETSI ES 204 915-5 V1.1.1 (2008-05)
9.2 Generic User Interaction Administration State Transition Diagrams.49
9.2.1 State Transition Diagrams for IpUIAdminManager .49
9.2.1.1 Active State.49
10 Service Properties.49
10.1 User Interaction Service Properties .49
11 Data Definitions.50
11.1 TpUIFault.50
11.2 IpUI.50
11.3 IpUIRef.50
11.4 IpAppUI.50
11.5 IpAppUIRef.50
11.6 IpAppUIManager.51
11.7 IpAppUIManagerRef.51
11.8 TpUICallIdentifier.51
11.9 TpUICollectCriteria.51
11.10 TpUIError.52
11.11 TpUIEventCriteria.53
11.12 TpUIEventCriteriaResultSet.53
11.13 TpUIEventCriteriaResult.53
11.14 TpUIEventInfoDataType.53
11.15 TpUIIdentifier.53
11.16 TpUIIdentifierSet.53
11.17 TpUIInfo.54
11.18 TpUIInfoType.55
11.19 TpUIMessageCriteria.55
11.20 TpUIReport.55
11.21 TpUIResponseRequest .56
11.22 TpUITargetObjectType.56
11.23 TpUITargetObject.56
11.24 TpUIVariableInfo.57
11.25 TpUIVariableInfoSet.57
11.26 TpUIVariablePartType.57
11.27 TpUIEventNotificationInfo.57
11.28 TpUISynthesisInfoData.57
11.29 TpUISynthesisGender.58
11.30 TpUISynthesisAge.58
11.31 TpUISynthesisRate.58
11.32 TpUISynthesisRange.58
11.33 TpUIWordOverrideSet.58
11.34 TpUIWordOverride.59
11.35 TpUIPronounceType.59
11.36 TpUICollectMode.59
11.37 TpUIRecognitionCriteria.59
11.38 TpUIRecognitionSpeakerID.60
11.39 TpUIRecognitionPropertySet.60
11.40 TpUIRecognitionProperty.60
11.41 TpUIRecognitionGrammar.60
11.42 TpMessageIDList.61
12 Exception Classes.62
Annex A (normative): OMG IDL Description of User Interaction SCF.63
Annex B (informative): W3C WSDL Description of User Interaction SCF .64
Annex C (informative): Java™ API Description of the User Interaction SCF.65
Annex D (informative): Contents of 3GPP OSA R7 User Interaction.66
Annex E (informative): Description of Generic User Interaction SCF for 3GPP2 cdma2000
networks.67
ETSI

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

SIST ES 204 915-5 V1.1.1:2008
 6 ETSI ES 204 915-5 V1.1.1 (2008-05)
E.1 General Exceptions.67
E.2 Specific Exceptions.67
E.2.1 Clause 1: Scope .67
E.2.2 Clause 2: References .67
E.2.3 Clause 3: Definitions and abbreviations.
...