1、 ETSI ES 202 915-5 V1.4.1 (2006-12)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 5: User Interaction SCF(Parlay 4)floppy3 ETSI ETSI ES 202 915-5 V1.4.1 (2006-12) 2 Reference RES/TISPAN-01028-05-OSA Keywords API, IDL, OSA, UML ETSI 650 Route des Lucioles F-06921
2、 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 enregistre la Sous-Prfecture de Grasse (06) N 7803/88 Important notice Individual copies of the present document can be downloaded from: http:/www.etsi.o
3、rg 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 ET
4、SI 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.ets
5、i.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 foregoi
6、ng restriction extend to reproduction in all media. European Telecommunications Standards Institute 2006. The Parlay Group 2006. All rights reserved. DECTTM, PLUGTESTSTM and UMTSTM are Trade Marks of ETSI registered for the benefit of its Members. TIPHONTMand the TIPHON logo are Trade Marks currentl
7、y being registered by ETSI for the benefit of its Members. 3GPPTM is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners. ETSI ETSI ES 202 915-5 V1.4.1 (2006-12) 3 Contents Intellectual Property Rights6 Foreword.6 1 Scope 7 2 References 7 3 Definiti
8、ons and abbreviations.7 3.1 Definitions7 3.2 Abbreviations .7 4 Generic and Call User Interaction SCF7 4.1 General requirements on support of methods.9 5 Sequence Diagrams 9 5.1 Alarm Call9 5.2 Call Barring 1 .11 5.3 Network Controlled Notifications 12 5.4 Prepaid14 5.5 Pre-Paid with Advice of Charg
9、e (AoC)15 6 Class Diagrams.18 7 The Service Interface Specifications19 7.1 Interface Specification Format .19 7.1.1 Interface Class 19 7.1.2 Method descriptions19 7.1.3 Parameter descriptions19 7.1.4 State Model.19 7.2 Base Interface.19 7.2.1 Interface Class IpInterface 19 7.3 Service Interfaces .20
10、 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(
11、)22 8.1.3 Method createNotification()22 8.1.4 Method destroyNotification() .23 8.1.5 Method changeNotification()23 8.1.6 Method getNotification() 23 8.1.7 Method enableNotifications().24 8.1.8 Method disableNotifications()24 8.2 Interface Class IpAppUIManager.25 8.2.1 Method userInteractionAborted()
12、 .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 IpUI26 8.3.1 Method sendInfoReq()27 8.3.2 Method sendInfoAndCollectReq()28 8.3.3 Metho
13、d release() .29 8.3.4 Method setOriginatingAddress()29 ETSI ETSI ES 202 915-5 V1.4.1 (2006-12) 4 8.3.5 Method getOriginatingAddress() .29 8.4 Interface Class IpAppUI.30 8.4.1 Method sendInfoRes() 30 8.4.2 Method sendInfoErr() .31 8.4.3 Method sendInfoAndCollectRes()31 8.4.4 Method sendInfoAndCollect
14、Err().31 8.4.5 Method userInteractionFaultDetected() 32 8.5 Interface Class IpUICall.32 8.5.1 Method recordMessageReq()32 8.5.2 Method deleteMessageReq() 33 8.5.3 Method abortActionReq().33 8.6 Interface Class IpAppUICall 33 8.6.1 Method recordMessageRes() 34 8.6.2 Method recordMessageErr() .34 8.6.
15、3 Method deleteMessageRes().35 8.6.4 Method deleteMessageErr()35 8.6.5 Method abortActionRes() .35 8.6.6 Method abortActionErr() 35 9 State Transition Diagrams36 9.1 State Transition Diagrams for IpUIManager36 9.1.1 Active State.36 9.1.2 Notification Terminated State.36 9.2 State Transition Diagrams
16、 for IpUI37 9.2.1 Active State.37 9.2.2 Release Pending State.37 9.2.3 Finished State37 9.3 State Transition Diagrams for IpUICall .37 9.3.1 Active State.38 9.3.2 Release Pending State.38 9.3.3 Finished State39 10 Service Properties.39 10.1 User Interaction Service Properties 39 11 Data Definitions
17、.39 11.1 TpUIFault.40 11.2 IpUI 40 11.3 IpUIRef 40 11.4 IpAppUI .40 11.5 IpAppUIRef40 11.6 IpAppUIManager .40 11.7 IpAppUIManagerRef40 11.8 TpUICallIdentifier40 11.9 TpUICollectCriteria40 11.10 TpUIError.42 11.11 TpUIEventCriteria42 11.12 TpUIEventCriteriaResultSet.42 11.13 TpUIEventCriteriaResult42
18、 11.14 TpUIEventInfo .43 11.15 TpUIEventInfoDataType43 11.16 TpUIIdentifier 43 11.17 TpUIInfo.43 11.18 TpUIInfoType 44 11.19 TpUIMessageCriteria .44 11.20 TpUIReport 45 11.21 TpUIResponseRequest .45 11.22 TpUITargetObjectType 45 11.23 TpUITargetObject 46 11.24 TpUIVariableInfo.46 11.25 TpUIVariableI
19、nfoSet46 11.26 TpUIVariablePartType.46 11.27 TpUIEventNotificationInfo 47 ETSI ETSI ES 202 915-5 V1.4.1 (2006-12) 5 12 Exception Classes.47 Annex A (normative): OMG IDL Description of User Interaction SCF.48 Annex B (informative): W3C WSDL Description of User Interaction SCF .49 Annex C (informative
20、): Java API Description of the User Interaction SCF.50 Annex D (informative): Contents of 3GPP OSA R5 User Interaction.51 Annex E (informative): Record of changes 52 E.1 Interfaces 52 E.1.1 New 52 E.1.2 Deprecated52 E.1.3 Removed.52 E.2 Methods53 E.2.1 New 53 E.2.2 Deprecated53 E.2.3 Modified.53 E.2
21、.4 Removed.53 E.3 Data Definitions .54 E.3.1 New 54 E.3.2 Modified.54 E.3.3 Removed.54 E.4 Service Properties.55 E.4.1 New 55 E.4.2 Deprecated55 E.4.3 Modified.55 E.4.4 Removed.55 E.5 Exceptions 56 E.5.1 New 56 E.5.2 Modified.56 E.5.3 Removed.56 E.6 Others .56 History 57 ETSI ETSI ES 202 915-5 V1.4.
22、1 (2006-12) 6 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: “Intelle
23、ctual 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 investig
24、ation, 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)
25、has been produced by ETSI Technical Committee Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN). The present document is part 5 of a multi-part deliverable covering Open Service Access (OSA); Application Programming Interface (API), as identified below
26、. 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 SC
27、F“; 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 (h
28、ttp:/www.parlay.org) and the 3GPP, in co-operation with a number of JAIN Community (http:/ member companies. The present document forms part of the Parlay 4.3 set of specifications. The present document is equivalent to 3GPP TS 29.198-5 V5.10.0 (Release 5). ETSI ETSI ES 202 915-5 V1.4.1 (2006-12) 7
29、1 Scope The present document is part 5 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 interf
30、ace, 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 descripti
31、ons. 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
32、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 (
33、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. 4 Generic and Call User Interactio
34、n SCF The Generic User Interaction service capability feature is used by applications to interact with end users. It consists of three interfaces: 1) User Interaction Manager, containing management functions for User Interaction related issues. ETSI ETSI ES 202 915-5 V1.4.1 (2006-12) 8 2) Generic Us
35、er Interaction, containing methods to interact with an end-user. 3) Call User Interaction, containing methods to interact with an end-user engaged in a call. The Generic User Interaction service capability feature is described in terms of the methods in the Generic User Interaction interfaces. The f
36、ollowing table gives an overview of the Generic User Interaction methods and to which interfaces these methods belong. Table 1: Overview of Generic User Interaction interfaces and their methods User Interaction Manager Generic User Interaction createUI sendInfoReq createUICall sendInfoRes createNoti
37、fication sendInfoErr destroyUINotification sendInfoAndCollectReq reportEventNotification sendInfoAndCollectRes userInteractionAborted sendInfoAndCollectErr userInteractionNotificationInterrupted release userInteractionNotificationContinued userInteractionFaultDetected changeNotification setOriginati
38、ngAddress getNotification getOriginatingAddressenableNotifications disableNotifications The following table gives an overview of the Call User Interaction methods and to which interfaces these methods belong. Table 2: Overview of Call User Interaction interfaces and their methods User Interaction Ma
39、nager Call User Interaction As defined for the Generic User Interaction SCF Inherits from Generic User Interaction and adds: recordMessageReq recordMessageRes recordMessageErr deleteMessageReqeMessageResdeleteMessageErr abortActionReq ctionRes abortActionErr The IpUI Interface provides functions to
40、send information to, or gather information from the user, i.e. this interface allows applications to send SMS and USSD messages. An application can use this interface independently of other SCFs. The IpUICall Interface provides functions to send information to, or gather information from the user (o
41、r call party) attached to a call. The following clauses describe each aspect of the Generic User Interaction Service Capability Feature (SCF). The order is as follows: The Sequence diagrams give the reader a practical idea of how each of the SCFs is implemented. The Class relationships clause shows
42、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. This clause also includes Call User interaction. The State Transition Diagrams (STD) show the transition between
43、 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. ETSI ETSI ES 202 915-5 V1.4.1 (2006-12) 9 The Data Definitions clause shows a detailed expansion of each of
44、 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 ES 202 915-2. 4.1 General requirements on support of methods An implementation of this API which supports or imp
45、lements a method described in the present document, shall support or implement the functionality described for that method, for at least one valid set of values for the parameters of that method. Where a method is not supported by an implementation of a Service interface, the exception P_METHOD_NOT_
46、SUPPORTED shall be returned to any call of that method. Where a method is not supported by an implementation of an Application interface, a call to that method shall be possible, and no exception shall be returned. 5 Sequence Diagrams 5.1 Alarm Call The following sequence diagram shows a reminder me
47、ssage, in the form of an alarm, being delivered to a customer as a result of a trigger from an application. Typically, the application would be set to trigger at a certain time, however, the application could also trigger on events. ETSI ETSI ES 202 915-5 V1.4.1 (2006-12) 10: IpCallControlManager: I
48、pAppCall : IpCall : IpUICall : IpUIManager : IpAppUICall: (Logical View:IpAppLogic)5: ro ut eR es ( )10: sendI nf oRes( )1: new()2: createCall( )3: new()4: routeReq( )9: sendInfoReq( )6: f orward ev ent 7: createUICall( )8: new()11: f orward ev ent12: release( )13: release( )1: This message is used
49、to create an object implementing the IpAppCall interface. 2: This message requests the object implementing the IpCallControlManager interface to create an object implementing the IpCall interface. 3: Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) are met it is created. 4: This message instructs the object implementing the IpCall interface to route the call to the customer destined to receive the reminder message. 5: This mes
