1、 ETSI ES 201 915-5 V1.6.1 (2006-12)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 5: User Interaction SCF(Parlay 3)floppy3 ETSI ETSI ES 201 915-5 V1.6.1 (2006-12) 2 Reference RES/TISPAN-01027-05-OSA Keywords API, OSA, IDL, 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 201 915-5 V1.6.1 (2006-12) 3 Contents Intellectual Property Rights5 Foreword.5 1 Scope 6 2 References 6 3 Definiti
8、ons and abbreviations.6 3.1 Definitions6 3.2 Abbreviations .6 4 Generic and Call User Interaction SCF6 4.1 General requirements on support of methods.8 5 Sequence Diagrams 8 5.1 Alarm Call8 5.2 Call Barring 1 .10 5.3 Prepaid11 5.4 Pre-Paid with Advice of Charge (AoC)13 6 Class Diagrams.16 7 The Serv
9、ice Interface Specifications17 7.1 Interface Specification Format .17 7.1.1 Interface Class 17 7.1.2 Method descriptions17 7.1.3 Parameter descriptions17 7.1.4 State Model.17 7.2 Base Interface.17 7.2.1 Interface Class IpInterface 17 7.3 Service Interfaces .18 7.3.1 Overview 18 7.4 Generic Service I
10、nterface .18 7.4.1 Interface Class IpService 18 8 Generic User Interaction Interface Classes 19 8.1 Interface Class IpUIManager .19 8.2 Interface Class IpAppUIManager.22 8.3 Interface Class IpUI24 8.4 Interface Class IpAppUI.26 8.5 Interface Class IpUICall.29 8.6 Interface Class IpAppUICall 30 9 Sta
11、te Transition Diagrams33 9.1 State Transition Diagrams for IpUIManager33 9.1.1 Active State.33 9.1.2 Notification Terminated State.34 9.2 State Transition Diagrams for IpUI35 9.2.1 Active State.36 9.2.2 Release Pending State.36 9.2.3 Finished State36 9.3 State Transition Diagrams for IpUICall .37 9.
12、3.1 Active State.38 9.3.2 Release Pending State.38 9.3.3 Finished State38 10 Service Properties.38 10.1 User Interaction Service Properties 38 11 Data Definitions .39 11.1 TpUIFault.39 ETSI ETSI ES 201 915-5 V1.6.1 (2006-12) 4 11.2 IpUI 39 11.3 IpUIRef 39 11.4 IpAppUI .39 11.5 IpAppUIRef39 11.6 IpAp
13、pUIManager .39 11.7 IpAppUIManagerRef39 11.8 TpUICallIdentifier40 11.9 TpUICollectCriteria40 11.10 TpUIError.41 11.11 TpUIEventCriteria41 11.12 TpUIEventCriteriaResultSet.41 11.13 TpUIEventCriteriaResult41 11.14 TpUIEventInfo .42 11.15 TpUIEventInfoDataType42 11.16 TpUIIdentifier 42 11.17 TpUIInfo.4
14、2 11.18 TpUIInfoType 43 11.19 TpUIMessageCriteria .43 11.20 TpUIReport 43 11.21 TpUIResponseRequest .44 11.22 TpUITargetObjectType 44 11.23 TpUITargetObject 44 11.24 TpUIVariableInfo.44 11.25 TpUIVariableInfoSet45 11.26 TpUIVariablePartType.45 11.27 TpUIEventNotificationInfo 45 12 Exception Classes.
15、45 Annex A (normative): OMG IDL Description of User Interaction SCF.46 Annex B (informative): Contents of 3GPP OSA R4 User Interaction.47 Annex C (informative): Record of changes 48 C.1 Interfaces 48 C.1.1 New 48 C.1.2 Deprecated48 C.1.3 Removed.48 C.2 Methods49 C.2.1 New 49 C.2.2 Deprecated49 C.2.3
16、 Modified.49 C.2.4 Removed.49 C.3 Data Definitions .50 C.3.1 New 50 C.3.2 Modified.50 C.3.3 Removed.50 C.4 Service Properties.50 C.4.1 New 50 C.4.2 Deprecated51 C.4.3 Modified.51 C.4.4 Removed.51 C.5 Exceptions 51 C.5.1 New 51 C.5.2 Modified.52 C.5.3 Removed.52 C.6 Others .52 History 53 ETSI ETSI ES
17、 201 915-5 V1.6.1 (2006-12) 5 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 0
18、00 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 Pol
19、icy, 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 ETS
20、I Standard (ES) 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
21、identified below. The API specification (ES 201 915) is structured in the following parts: Part 1: “Overview“; Part 2: “Common Data Definitions“; Part 3: “Framework“; Part 4: “Call Control SCF“; Part 5: “User Interaction SCF“; Part 6: “Mobility SCF“; Part 7: “Terminal Capabilities SCF“; Part 8: “Dat
22、a Session Control SCF“; Part 9: “Generic Messaging SCF“; Part 10: “Connectivity Manager SCF“; Part 11: “Account Management SCF“; Part 12: “Charging 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
23、JAIN Community (http:/ member companies. The present document forms part of the Parlay 3.5 set of specifications. The present document is equivalent to 3GPP TS 29.198-5 V4.10.0 (Release 4). ETSI ETSI ES 201 915-5 V1.6.1 (2006-12) 6 1 Scope The present document is part 5 of the Stage 3 specification
24、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 Inte
25、raction (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
26、 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 201 915-1 contain provisions which, through reference in this text, constitute pro
27、visions of the present document. ETSI ES 201 915-1: “Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview (Parlay 3)“. 3 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in ES 201 915-1 apply. 3.2
28、Abbreviations For the purposes of the present document, the abbreviations defined in ES 201 915-1 apply. 4 Generic and Call User Interaction SCF The Generic User Interaction service capability feature is used by applications to interact with end users. It consists of three interfaces: 1) User Intera
29、ction Manager, containing management functions for User Interaction related issues. 2) Generic User 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. ETSI ETSI ES 201 915-5 V1.6.1 (2006-12) 7 The
30、 Generic User Interaction service capability feature is described in terms of the methods in the Generic User Interaction interfaces. Table 1 gives an overview of the Generic User Interaction methods and to which interfaces these methods belong. Table 1: Overview of Generic User Interaction interfac
31、es and their methods User Interaction Manager Generic User Interaction createUI sendInfoReq createUICall sendInfoRes createNotification sendInfoErr destroyUINotification sendInfoAndCollectReq reportEventNotification sendInfoAndCollectRes userInteractionAborted sendInfoAndCollectErr userInteractionNo
32、tificationInterrupted release userInteractionNotificationContinued userInteractionFaultDetected changeNotification getNotification Table 2 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 th
33、eir methods User Interaction Manager 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 I
34、nterface provides functions to 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 gath
35、er information from the user (or 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 Cl
36、ass relationships clause show 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 (ST
37、D) show the transition between 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. The Data Definitions clause show a detailed expansion of each of the data typ
38、es 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 of the present document. ETSI ETSI ES 201 915-5 V1.6.1 (2006-12) 8 4.1 General requirements on support of methods An implemen
39、tation of this API which supports or implements 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 Servic
40、e interface, the exception P_METHOD_NOT_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 follow
41、ing sequence diagram shows a “reminder message“, 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 201 915-5 V1
42、.6.1 (2006-12) 9 : IpCallControlManager: IpAppCall : IpCall : IpUICall : IpUIManager : IpAppUICall: (Logical View:IpAppLogic)5: routeR es( )10: sendI nf oRes( )1: new()2: createCall( )3: new()4: routeReq( )9: sendInf oReq( )6: f orward ev ent 7: createUICall( )8: new()11: f orward ev ent12: release(
43、 )13: release( )1: This message is used 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 implementi
44、ng 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 message passes the result of the call being answered to
45、its callback object. 6: This message is used to forward the previous message to the IpAppLogic. 7: The application requests a new UICall object that is associated with the call object. 8: Assuming all criteria are met, a new UICall object is created by the service. 9: This message instructs the obje
46、ct implementing the IpUICall interface to send the alarm to the customers call. 10: When the announcement ends this is reported to the call back interface. 11: The event is forwarded to the application logic. ETSI ETSI ES 201 915-5 V1.6.1 (2006-12) 1012: The application releases the UICall object, s
47、ince no further announcements are required. Alternatively, the application could have indicated P_FINAL_REQUEST in the sendInfoReq in which case the UICall object would have been implicitly released after the announcement was played. 13: The application releases the call and all associated parties.
48、5.2 Call Barring 1 The following sequence diagram shows a call barring service, initiated as a result of a prearranged event being received by the call control service. Before the call is routed to the destination number, the calling party is asked for a PIN code. The code is accepted and the call i
49、s routed to the original called party. : (Logical View:IpAppLogic): IpAppCallControlManager: IpAppCall : IpCall : IpUICall : IpUIManager: IpCallControlManager: IpAppUICall1: new()13: routeRes( )14: forward event12: routeReq( )15: callEnded( )16: “forward event“17: deassignCall( )8: sendInfoAndCollectReq( )11: release( )6: createUICall( )7: new()3: callEventNotify( )4: forward event5: new()2: enableCallNotification( )9: sendInfoAndCollectRes( )10: forward event1: This message is used by the appl
