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