ETSI ES 201 915-2-2006 Open Service Access (OSA) Application Programming Interface (API) Part 2 Common Data Definitions (Parlay 3) (V1 6 1 Includes Diskette)《开放业务接入(OSA) 应用编程接口(API.pdf

1、 ETSI ES 201 915-2 V1.6.1 (2006-12)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 2: Common Data Definitions(Parlay 3)floppy3 ETSI ETSI ES 201 915-2 V1.6.1 (2006-12) 2 Reference RES/TISPAN-01027-02-OSA Keywords API, OSA, IDL, UML ETSI 650 Route des Lucioles F-06

2、921 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.ets

3、i.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

4、 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.

5、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 fore

6、going 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 curre

7、ntly 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-2 V1.6.1 (2006-12) 3 Contents Intellectual Property Rights5 Foreword.5 1 Scope 6 2 References 6 3 Defin

8、itions and abbreviations.6 3.1 Definitions6 3.2 Abbreviations .6 4 Common data definitions .6 5 Common system data definitions .7 5.1 Standard data types.7 5.1.1 TpBoolean.7 5.1.2 TpInt32 .7 5.1.3 TpFloat7 5.1.4 TpLongString7 5.1.5 TpOctet .7 5.1.6 TpOctetSet 7 5.1.7 TpString7 5.1.8 TpAssignmentID.7

9、 5.1.9 TpSessionID .7 5.1.10 TpSessionIDSet 8 5.1.11 TpAny.8 5.1.12 TpAttribute .8 5.1.13 TpAttributeType .8 5.1.14 TpAttributeList .8 5.1.15 TpAttributeSet 8 5.1.16 TpUnorderedOctetSet .9 5.2 Other Data Sorts .9 5.2.1 Sequence of Data Elements 9 5.2.2 Tagged Choice of Data Elements .9 5.2.3 Numbere

10、d Set of Data Elements.9 5.2.4 Reference 10 5.2.5 Numbered List of Data Elements10 5.3 Interface Related Data Definitions .10 5.3.1 IpInterface.10 5.3.2 IpInterfaceRef.10 5.4 Exception Classes.10 5.4.1 Underlying Technology Exceptions .10 5.4.2 TpCommonExceptions .11 5.4.3 Constants associated with

11、TpCommonExceptions .11 5.4.4 Exceptions available to all methods on all interfaces .11 5.5 Date and Time Related Data Definitions12 5.5.1 TpDate 12 5.5.2 TpTime .12 5.5.3 TpDateAndTime .13 5.5.4 TpDuration13 5.5.5 TpTimeInterval .13 5.6 Address Related Data Definitions 14 5.6.1 TpAddress.14 5.6.2 Tp

12、AddressSet15 5.6.3 TpAddressPresentation .15 5.6.4 TpAddressScreening.15 5.6.5 TpAddressPlan15 5.6.6 TpAddressError 16 ETSI ETSI ES 201 915-2 V1.6.1 (2006-12) 4 5.6.7 TpAddressRange.16 5.6.8 TpURL17 5.7 Price-related Data Definitions 17 5.7.1 TpPrice17 5.7.2 TpAoCInfo18 5.7.3 TpAoCOrder.18 5.7.4 TpC

13、allAoCOrderCategory18 5.7.5 TpChargeAdviceInfo 18 5.7.6 TpCAIElements 19 5.7.7 TpChargePerTime.19 5.7.8 TpLanguage 19 Annex A (normative): OMG IDL Description of the Common Data definitions .20 Annex B (informative): Record of changes 21 B.1 Data Definitions .21 B.1.1 New 21 B.1.2 Modified.21 B.1.3

14、Removed.21 B.2 Exceptions 22 B.2.1 New 22 B.2.2 Modified.22 B.2.3 Removed.22 B.3 Others .22 History 23 ETSI ETSI ES 201 915-2 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

15、these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found in ETSI SR 000 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. Lat

16、est updates are available on the ETSI Web server (http:/webapp.etsi.org/IPR/home.asp). Pursuant to the ETSI IPR Policy, 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 update

17、s on the ETSI Web server) which are, or may be, or may become, essential to the present document. Foreword This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN). The present document is

18、part 2 of a multi-part deliverable covering Open Service Access (OSA); Application Programming Interface (API), as 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 Cont

19、rol SCF“; Part 5: “User Interaction SCF“; Part 6: “Mobility SCF“; Part 7: “Terminal Capabilities SCF“; Part 8: “Data 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 d

20、efined jointly between ETSI, The Parlay Group (http:/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 3.5 set of specifications. The present document is equivalent to 3GPP TS 29.198-2 V4.8.0 (Release

21、 4). ETSI ETSI ES 201 915-2 V1.6.1 (2006-12) 6 1 Scope The present document is part 2 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 fu

22、nctionality through an open standardized interface, i.e. the OSA APIs. The present document specifies the Common Data Definitions of the OSA. The Common Data Definitions contain data-types that are common across the rest of the OSA API. All aspects of the Common Data are defined here, these being: D

23、ata Definitions. IDL Description of the interfaces. 2 References The references listed in clause 2 of ES 201 915-1 contain provisions which, through reference in this text, constitute provisions of the present document. ETSI ES 201 915-1: “Open Service Access (OSA); Application Programming Interface

24、 (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 Abbreviations For the purposes of the present document, the abbreviations defined in ES 201 915-1 apply. 4 Common

25、 data definitions The following clauses describe each aspect of the common data definitions. The order is as follows: The Data Definitions clause shows a detailed expansion of each of the data types associated with the methods within the classes. Note that some data types are used in other methods a

26、nd classes and are therefore defined within the Common Data types part of the present document. ETSI ETSI ES 201 915-2 V1.6.1 (2006-12) 7 5 Common system data definitions These data definitions are assumed to be provided by the client operating system. 5.1 Standard data types The APIs assume that th

27、e following data types can be supported. 5.1.1 TpBoolean Defines a Boolean data type. 5.1.2 TpInt32 Defines a signed 32-bit integer. 5.1.3 TpFloat Defines a single precision real number. 5.1.4 TpLongString Defines a Byte string, comprising length and data. The length must be at least a 32-bit intege

28、r. 5.1.5 TpOctet Defines an 8-bit quantity that is not translated during transmission. 5.1.6 TpOctetSet Defines a Numbered List of Data elements of TpOctet. Note that this is an ordered list. 5.1.7 TpString Defines a Byte string, comprising length and data. The length must be at least a 16-bit integ

29、er. 5.1.8 TpAssignmentID Defines an assignment ID with a value that is unique within any instance of an implementation of a given interface, irrespective of the method invoked on that interface instance. This ID may be used for example to identify single or multiple event notifications enabled by a

30、requesting interface implementation, or may be used by a requesting interface implementation to modify or stop functionality associated with a previously supplied assignment ID, e.g. event notifications, call load control, abort requests. The assignment ID is identical to a TpInt32 type. 5.1.9 TpSes

31、sionID Defines a session ID with a value that is at least unique within the context of a specific instance of an SCF. An instance of an SCF is a single service manager instance plus the associated subordinate instances. For example, a single MultiPartyCallControlManager instance plus all associated

32、MultiPartyCall and MultiPartyCallLeg instances. The session ID is used to identify different sessions (e.g. different call or call leg sessions) of an interface capable of handling multiple sessions. ETSI ETSI ES 201 915-2 V1.6.1 (2006-12) 8 Example 1, myCallObject may implement the IpCall interface

33、. If so, myCallObject may handle multiple call sessions, and each call session will be identified by a call session ID value (e.g. 1, 2, 3) that is unique within the context of the SCF instance. Example 2, myCallAndCallLegObject may implement the IpCall and IpCallLeg interfaces. If so, myCallAndCall

34、LegObject may handle multiple call sessions and multiple call leg sessions. Each call session will be identified by a call session ID value (e.g. 1, 2, 3) that is unique within the context of the SCF instance. Similarly, each call leg session will be identified by a call leg session ID value (e.g. 1

35、, 2, 3, 4, 5, 6) that is also unique within the context of the SCF instance. Because call session IDs and call leg session IDs are different data types, overlapping values are permitted and their uniqueness still remains. The session ID is identical to a TpInt32 type. 5.1.10 TpSessionIDSet Defines a

36、 Numbered Set of Data Elements of TpSessionID. 5.1.11 TpAny Defines a type that can hold any type. This is not restricted to only the primitive types. 5.1.12 TpAttribute This is a Sequence of Data Elements containing the attribute name, type, and value. The attribute Value is interpreted based on th

37、e value of the attribute Type. Sequence Element Name Sequence Element Type Notes AttributeName TpString The name of the attribute. AttributeType TpAttributeType The type of the attribute. Valid values for Type must include at least TpString, TpInt32 and TpFloat. AttributeValue TpAny The values for t

38、he attribute. This model allows multi-valued attributes. Cannot be an empty list. 5.1.13 TpAttributeType This data type is identical to a TpString, and is defined as a string of characters that uniquely identifies the type of an attribute. Other Network operator specific capabilities may also be use

39、d, but should be preceded by the string “SP_“. The following values are defined. Character String Value Description NULL An empty (NULL) string indicates no attribute type P_STRING Attribute type is type TpString. P_INT32 Attribute type is type TpInt32. P_FLOAT Attribute type is type TpFloat. 5.1.14

40、 TpAttributeList This is a Numbered List of Data Elements of type TpAttribute. 5.1.15 TpAttributeSet This is a Numbered Set of Data Elements of type TpAttribute. ETSI ETSI ES 201 915-2 V1.6.1 (2006-12) 9 5.1.16 TpUnorderedOctetSet Defines a Numbered Set of Data Elements of TpOctet. Note that this is

41、 an un-ordered set. Note that this type should not be removed from the present document, even if unused by any part of the OSA specifications. It is included to ensure that TpOctetSet is correctly used as a Numbered List of Data Elements, and not a Numbered Set. 5.2 Other Data Sorts The APIs assumes

42、 that the following data syntaxes can be supported. 5.2.1 Sequence of Data Elements This describes a sequence of data types. This may be defined as a structure (for example, in C+) or simply a sequence of data elements within a structure. EXAMPLE: The TpAddress data type may be defined in C+ as: typ

43、edef struct TpAddressPlan Plan; TpString AddrString; TpString Name; TpAddressPresentation Presentation; TpAddressScreening Screening; TpString SubAddressString; TpAddress; 5.2.2 Tagged Choice of Data Elements This describes a data type which actually evaluates to one of a choice of a number of data

44、elements. This data element contains two parts: a tag data type (the tag part) which is used to identify the chosen data type, and the chosen data type itself (the union part). This form of data type is also referred to as a tagged union. This data type can be implemented (for example, in C+) as a s

45、tructure containing an integer for the tag part, and a union for the union part. This data type is implementation specific. Please refer to the appropriate IDL documents (and the resulting language mappings) to see how this data type is implemented. EXAMPLE: The TpCallError data type may be defined

46、in C+ as: typedef struct TpCallErrorType Tag; union TpCallErrorInfoUndefined Undefined; TpCallErrorInfoRoutingAborted RoutingAborted; TpCallErrorInfoCallAbandoned CallAbandoned; TpCallErrorInfoInvalidAddress InvalidAddress; TpCallErrorInfoInvalidState InvalidState; TpCallErrorInfoInvalidCriteria Inv

47、alidCriteria; callErrorInfo; TpCallError; 5.2.3 Numbered Set of Data Elements This describes a data type which comprises an integer which indicates the total number of data elements in the set (the number part), and an unordered set of data elements (the data part). Set data types do not contain dup

48、licate data elements. ETSI ETSI ES 201 915-2 V1.6.1 (2006-12) 10Note that TpOctetSet is a Numbered List of Data Elements, not a Numbered Set. EXAMPLE: The TpAddressSet data type may be defined in MIDL as: typedef struct TpAddressSet TpInt32 Number; size_is(Number) TpAddress Set; TpAddressSet; 5.2.4

49、Reference This describes a reference (or pointer) to a data type. When one interface inherits directly from another interface, a reference to the inheriting interface can be used when the base interface reference is required. For example, the references to Multi-Media Call Control interfaces can be used in Multi-Party Call Control methods that have been inherited by Multi-Media Call Control from Multi-Party Call Control interfaces. 5.2.5 Numbered List of Data Elements This describes a data type which com