Tech-
invite
3GPP
space
IETF
RFCs
SIP
Quick
21
22
23
24
25
26
27
28
29
31
32
33
34
35
36
37
38
4‑5x
TS 29.198-05
Open Service Access (OSA) API –
Part 5: User Interaction Service Capability Feature (SCF)
3GPP‑Page
ETSI‑search
ToC
↓
V9.0.0 (PDF)
2009/12 74 p.
V8.0.0
2008/12 74 p.
V7.1.1
2006/09 74 p.
V6.5.1
2006/07 75 p.
V5.10.0
2005/06 57 p.
V4.10.0
2005/01 49 p.
Rapporteur:
Mr. Unmehopa, Musa
full Table of Contents for
TS 29.198-05
Word version: 9.0.0
0
Introduction
Word‑p. 7
1
Scope
Word‑p. 9
2
References
Word‑p. 9
3
Definitions and abbreviations
Word‑p. 10
3.1
Definitions
Word‑p. 10
3.2
Abbreviations
Word‑p. 10
4
Generic and Call User Interaction and Administration SCF
Word‑p. 10
4.1
Generic and Call User Interaction SCF
Word‑p. 10
4.2
Generic User Interaction Administration SCF
Word‑p. 11
4.3
Generic User Interaction SCF Design Aspects
Word‑p. 11
4.4
General requirements on support of methods
Word‑p. 12
5
Sequence Diagrams
Word‑p. 12
5.1
Generic and Call User Interaction Sequence Diagrams
Word‑p. 12
5.1.1
Alarm Call
Word‑p. 12
5.1.2
Call Barring 1
Word‑p. 14
5.1.3
Network Controlled Notifications
Word‑p. 15
5.1.4
Prepaid
Word‑p. 16
5.1.5
Pre-Paid with Advice of Charge (AoC)
Word‑p. 18
5.2
Generic User Interaction Administration Sequence Diagrams
Word‑p. 21
5.2.1
Message Administration
Word‑p. 21
6
Class Diagrams
Word‑p. 22
6.1
Generic and Call User Interaction Class Diagrams
Word‑p. 22
6.2
Generic User Interaction Administration Class Diagrams
Word‑p. 23
7
The Service Interface Specifications
Word‑p. 24
7.1
Interface Specification Format
Word‑p. 24
7.1.1
Interface Class
Word‑p. 24
7.1.2
Method descriptions
Word‑p. 25
7.1.3
Parameter descriptions
Word‑p. 25
7.1.4
State Model
Word‑p. 25
7.2
Base Interface
Word‑p. 25
7.2.1
Interface Class IpInterface
Word‑p. 25
7.3
Service Interfaces
Word‑p. 25
7.3.1
Overview
Word‑p. 25
7.4
Generic Service Interface
Word‑p. 25
7.4.1
Interface Class IpService
Word‑p. 25
7.4.1.1
Method setCallback()
Word‑p. 26
7.4.1.2
Method setCallbackWithSessionID()
Word‑p. 26
8
Generic User Interaction Interface Classes
Word‑p. 26
8.1
Generic and Call User Interaction Interface Classes
Word‑p. 26
8.1.1
Interface Class IpUIManager
Word‑p. 27
8.1.1.1
Method createUI()
Word‑p. 27
8.1.1.2
Method createUICall()
Word‑p. 28
8.1.1.3
Method createNotification()
Word‑p. 28
8.1.1.4
Method destroyNotification()
Word‑p. 29
8.1.1.5
Method changeNotification()
Word‑p. 29
8.1.1.6
Method getNotification()
Word‑p. 30
8.1.1.7
Method enableNotifications()
Word‑p. 30
8.1.1.8
Method disableNotifications()
Word‑p. 31
8.1.2
Interface Class IpAppUIManager
Word‑p. 31
8.1.2.1
Method userInteractionAborted()
Word‑p. 31
8.1.2.2
Method userInteractionNotificationInterrupted()
Word‑p. 32
8.1.2.3
Method userInteractionNotificationContinued()
Word‑p. 32
8.1.2.4
Method reportEventNotification()
Word‑p. 32
8.1.2.5
Method abortMultipleUserInteractions()
Word‑p. 32
8.1.2.6
Method <<new>> reportEventReq()
Word‑p. 33
8.1.3
Interface Class IpUI
Word‑p. 33
8.1.3.1
Method sendInfoReq()
Word‑p. 34
8.1.3.2
Method sendInfoAndCollectReq()
Word‑p. 35
8.1.3.3
Method release()
Word‑p. 36
8.1.3.4
Method setOriginatingAddress()
Word‑p. 36
8.1.3.5
Method getOriginatingAddress()
Word‑p. 37
8.1.3.6
Method <<new>> reportEventRes()
Word‑p. 37
8.1.3.7
Method <<new>> reportEventErr()
Word‑p. 37
8.1.4
Interface Class IpAppUI
Word‑p. 38
8.1.4.1
Method sendInfoRes()
Word‑p. 38
8.1.4.2
Method sendInfoErr()
Word‑p. 38
8.1.4.3
Method sendInfoAndCollectRes()
Word‑p. 39
8.1.4.4
Method sendInfoAndCollectErr()
Word‑p. 39
8.1.4.5
Method userInteractionFaultDetected()
Word‑p. 39
8.1.5
Interface Class IpUICall
Word‑p. 40
8.1.5.1
Method recordMessageReq()
Word‑p. 40
8.1.5.2
Method deleteMessageReq()
Word‑p. 41
8.1.5.3
Method abortActionReq()
Word‑p. 41
8.1.5.4
Method getMessageReq()
Word‑p. 42
8.1.6
Interface Class IpAppUICall
Word‑p. 42
8.1.6.1
Method recordMessageRes()
Word‑p. 43
8.1.6.2
Method recordMessageErr()
Word‑p. 43
8.1.6.3
Method deleteMessageRes()
Word‑p. 43
8.1.6.4
Method deleteMessageErr()
Word‑p. 44
8.1.6.5
Method abortActionRes()
Word‑p. 44
8.1.6.6
Method abortActionErr()
Word‑p. 44
8.1.6.7
Method getMessageRes()
Word‑p. 45
8.1.6.8
Method getMessageErr()
Word‑p. 45
8.2
Generic User Interaction Administration Interface Classes
Word‑p. 45
8.2.1
Interface Class IpUIAdminManager
Word‑p. 45
8.2.1.1
Method getMessageReq()
Word‑p. 46
8.2.1.2
Method putMessageReq()
Word‑p. 46
8.2.1.3
Method deleteMessageReq()
Word‑p. 46
8.2.1.4
Method getMessageListReq()
Word‑p. 47
8.2.2
Interface Class IpAppUIAdminManager
Word‑p. 47
8.2.2.1
Method getMessageRes()
Word‑p. 48
8.2.2.2
Method getMessageErr()
Word‑p. 48
8.2.2.3
Method deleteMessageRes()
Word‑p. 48
8.2.2.4
Method deleteMessageErr()
Word‑p. 49
8.2.2.5
Method putMessageRes()
Word‑p. 49
8.2.2.6
Method putMessageErr()
Word‑p. 49
8.2.2.7
Method getMessageListRes()
Word‑p. 49
8.2.2.8
Method getMessageListErr()
Word‑p. 50
9
State Transition Diagrams
Word‑p. 50
9.1
Generic and Call User Interaction State Transition Diagrams
Word‑p. 50
9.1.1
State Transition Diagrams for IpUIManager
Word‑p. 50
9.1.1.1
Active State
Word‑p. 51
9.1.1.2
Notification Terminated State
Word‑p. 51
9.1.2
State Transition Diagrams for IpUI
Word‑p. 51
9.1.2.1
Active State
Word‑p. 51
9.1.2.2
Release Pending State
Word‑p. 51
9.1.2.3
Finished State
Word‑p. 52
9.1.3
State Transition Diagrams for IpUICall
Word‑p. 52
9.1.3.1
Active State
Word‑p. 52
9.1.3.2
Release Pending State
Word‑p. 52
9.1.3.3
Finished State
Word‑p. 53
9.2
Generic User Interaction Administration State Transition Diagrams
Word‑p. 53
9.2.1
State Transition Diagrams for IpUIAdminManager
Word‑p. 53
9.2.1.1
Active State
Word‑p. 53
10
Service Properties
Word‑p. 54
10.1
User Interaction Service Properties
Word‑p. 54
11
Data Definitions
Word‑p. 54
11.1
TpUIFault
Word‑p. 54
11.2
IpUI
Word‑p. 54
11.3
IpUIRef
Word‑p. 55
11.4
IpAppUI
Word‑p. 55
11.5
IpAppUIRef
Word‑p. 55
11.6
IpAppUIManager
Word‑p. 55
11.7
IpAppUIManagerRef
Word‑p. 55
11.8
TpUICallIdentifier
Word‑p. 55
11.9
TpUICollectCriteria
Word‑p. 55
11.10
TpUIError
Word‑p. 57
11.11
TpUIEventCriteria
Word‑p. 57
11.12
TpUIEventCriteriaResultSet
Word‑p. 57
11.13
TpUIEventCriteriaResult
Word‑p. 57
11.14
TpUIEventInfoDataType
Word‑p. 58
11.15
TpUIIdentifier
Word‑p. 58
11.16
TpUIIdentifierSet
Word‑p. 58
11.17
TpUIInfo
Word‑p. 58
11.18
TpUIInfoType
Word‑p. 59
11.19
TpUIMessageCriteria
Word‑p. 59
11.20
TpUIReport
Word‑p. 60
11.21
TpUIResponseRequest
Word‑p. 60
11.22
TpUITargetObjectType
Word‑p. 60
11.23
TpUITargetObject
Word‑p. 61
11.24
TpUIVariableInfo
Word‑p. 61
11.25
TpUIVariableInfoSet
Word‑p. 61
11.26
TpUIVariablePartType
Word‑p. 61
11.27
TpUIEventNotificationInfo
Word‑p. 62
11.28
TpUISynthesisInfoData
Word‑p. 62
11.29
TpUISynthesisGender
Word‑p. 62
11.30
TpUISynthesisAge
Word‑p. 62
11.31
TpUISynthesisRate
Word‑p. 63
11.32
TpUISynthesisRange
Word‑p. 63
11.33
TpUIWordOverrideSet
Word‑p. 63
11.34
TpUIWordOverride
Word‑p. 63
11.35
TpUIPronounceType
Word‑p. 63
11.36
TpUICollectMode
Word‑p. 64
11.37
TpUIRecognitionCriteria
Word‑p. 64
11.38
TpUIRecognitionSpeakerID
Word‑p. 64
11.39
TpUIRecognitionPropertySet
Word‑p. 64
11.40
TpUIRecognitionProperty
Word‑p. 64
11.41
TpUIRecognitionGrammar
Word‑p. 65
11.42
TpMessageIDList
Word‑p. 66
12
Exception Classes
Word‑p. 66
A
(Normative) OMG IDL Description of User Interaction SCF
Word‑p. 67
B
WSDL Description of User Interaction SCF
Word‑p. 68
C
Java™ API Description of the User Interaction SCF
Word‑p. 69
D
Description of Generic User Interaction SCF for 3GPP2 cdma2000 networks
Word‑p. 70
D.1
General Exceptions
Word‑p. 70
D.2
Specific Exceptions
Word‑p. 70
D.2.1
Clause 1: Scope
Word‑p. 70
D.2.2
Clause 2: References
Word‑p. 70
D.2.3
Clause 3: Definitions and abbreviations
Word‑p. 70
D.2.4
Clause 4: Generic and Call User Interaction SCF
Word‑p. 70
D.2.5
Clause 5: Class Diagrams
Word‑p. 70
D.2.6
Clause 6: Class Diagrams
Word‑p. 71
D.2.7
Clause 7: The Service Interface Specifications
Word‑p. 71
D.2.8
Clause 8: Generic User Interaction Interface Classes Definitions
Word‑p. 71
D.2.9
Clause 9: State Transition Diagrams
Word‑p. 71
D.2.10
Clause 10: Service Properties
Word‑p. 71
D.2.11
Clause 11: Data Definitions
Word‑p. 71
D.2.12
Clause 12: Exception Classes
Word‑p. 71
D.2.13
Annex A (normative): OMG IDL Description of Generic User Interaction SCF
Word‑p. 71
D.2.14
Annex B (informative): W3C WSDL Description of Generic User Interaction SCF
Word‑p. 71
D.2.15
Annex C (informative): Java™ API Description of Generic User Interaction SCF
Word‑p. 71
$
Change history
Word‑p. 72