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

1、 ETSI ES 202 915-2 V1.4.1 (2006-12)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 2: Common Data Definitions(Parlay 4)floppy3 ETSI ETSI ES 202 915-2 V1.4.1 (2006-12) 2 Reference RES/TISPAN-01028-02-OSA Keywords API, IDL, OSA, 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 202 915-2 V1.4.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 Definitions6 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 5.

9、1.9 TpSessionID .7 5.1.10 TpSessionIDSet 8 5.1.11 TpAny.8 5.1.12 TpAttribute .8 5.1.13 TpAttributeValue8 5.1.14 TpAttributeList .8 5.1.15 TpAttributeSet 8 5.1.16 TpInt64 .8 5.1.17 TpVersion .9 5.1.18 TpStringSet.9 5.1.19 TpStringList9 5.1.20 TpAttributeTagInfo.9 5.1.21 TpSimpleAttributeValue.10 5.1.

10、22 TpSimpleAttributeTypeInfo .10 5.1.23 TpStructuredAttributeType.10 5.1.24 TpStructuredAttributeValue .11 5.1.25 TpChar11 5.1.26 TpWChar 11 5.1.27 TpWString 11 5.1.28 TpInt16 .11 5.1.29 TpUnsignedInt16 11 5.1.30 TpUnsignedInt32 11 5.1.31 TpUnsignedInt64 11 5.1.32 TpDouble 11 5.1.33 TpFixed.11 5.1.3

11、4 TpXMLString .11 5.1.35 TpUnorderedOctetSet .12 5.2 Other Data Sorts .12 5.2.1 Sequence of Data Elements 12 5.2.2 Tagged Choice of Data Elements .12 5.2.3 Numbered Set of Data Elements.12 5.2.4 Reference 13 5.2.5 Numbered List of Data Elements13 5.3 Interface Related Data Definitions .13 5.3.1 IpIn

12、terface.13 ETSI ETSI ES 202 915-2 V1.4.1 (2006-12) 4 5.3.2 IpInterfaceRef.13 5.4 Exception Classes.13 5.4.1 Underlying Technology Exceptions .13 5.4.2 TpCommonExceptions .14 5.4.3 Constants associated with TpCommonExceptions .14 5.4.4 Exceptions available to all methods on all interfaces .14 5.5 Dat

13、e and Time Related Data Definitions15 5.5.1 TpDate 15 5.5.2 TpTime .15 5.5.3 TpDateAndTime .16 5.5.4 TpDuration16 5.5.5 TpTimeInterval .16 5.6 Address Related Data Definitions 17 5.6.1 TpAddress.17 5.6.2 TpAddressSet18 5.6.3 TpAddressPresentation .18 5.6.4 TpAddressScreening.18 5.6.5 TpAddressPlan18

14、 5.6.6 TpAddressError 19 5.6.7 TpAddressRange.19 5.6.8 TpURL20 5.6.9 TpURN .20 5.7 Price-related Data Definitions 20 5.7.1 TpPrice20 5.7.2 TpAoCInfo20 5.7.3 TpAoCOrder.21 5.7.4 TpCallAoCOrderCategory21 5.7.5 TpChargeAdviceInfo 21 5.7.6 TpCAIElements 21 5.7.7 TpChargePerTime.22 5.7.8 TpLanguage 22 5.

15、8 Data Types Common Across Call Control and Data Session Control22 5.8.1 TpDataSessionQosClass .22 Annex A (normative): OMG IDL Description of the Common Data definitions .23 Annex B (informative): W3C WSDL Description of the Common Data definitions24 Annex C (informative): Java API Description of t

16、he Common Data definitions .25 Annex D (normative): Exception Hierarchy26 Annex E (informative): Record of changes 34 E.1 Data Definitions .34 E.1.1 New 34 E.1.2 Modified.35 E.1.3 Removed.35 E.2 Exceptions 35 E.2.1 New 35 E.2.2 Modified.36 E.2.3 Removed.36 E.3 Others .36 History 37 ETSI ETSI ES 202

17、915-2 V1.4.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 000 31

18、4: “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 Policy,

19、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 ETSI Sta

20、ndard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN). The present document is part 2 of a multi-part deliverable covering Open Service Access (OSA); Application Programming Interface (API), as ident

21、ified below. 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

22、 Control SCF“; 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 Parl

23、ay 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 4.3 set of specifications. The present document is equivalent to 3GPP TS 29.198-2 V5.11.0 (Release 5). ETSI ETSI ES 202 915-2 V1.4.1 (

24、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 functionality through an open standard

25、ised 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: Data Definitions. IDL Description of

26、the data types. WSDL Description of the data types. Reference to the Java API description of the data types. 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: “Ope

27、n Service Access (OSA); Application Programming Interface (API); Part 1: Overview (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,

28、the abbreviations defined in ES 202 915-1 apply. 4 Common 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 class

29、es. IDL description of the data types (normative annex). WSDL description of the data types (informative annex). Reference to the Java API description of the data types (informative annex). ETSI ETSI ES 202 915-2 V1.4.1 (2006-12) 7 5 Common System Data Definitions These data definitions are assumed

30、to be provided by the client operating system. 5.1 Standard Data Types The APIs assume that the 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

31、Defines a Byte string, comprising length and data. The length must be at least a 32-bit integer. 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

32、 Defines a Byte string, comprising length and data. The length must be at least a 16-bit integer. 5.1.8 TpAssignmentID Defines an assignment ID with a value that is unique to an instance of an implementation of a given interface (i.e. an object), irrespective of the method invoked on it. This ID may

33、 be used, for example, to identify single or multiple event notifications enabled by an object; or by a requesting object to modify or stop functionality (e.g. event notifications, call load control) associated with a previously supplied assignment ID. The assignment ID is identical to a TpInt32 typ

34、e. 5.1.9 TpSessionID 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 a

35、ll associated 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. EXAMPLE 1: myCallObject may implement the IpCall interface. If so, myCallObject may ha

36、ndle 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. ETSI ETSI ES 202 915-2 V1.4.1 (2006-12) 8 EXAMPLE 2: myCallAndCallLegObject may implement the IpCall and IpCallLeg interfaces. If so,

37、 myCallAndCallLegObject 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

38、 value (e.g. 1, 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 TpSessionI

39、DSet Defines a 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 and value. Sequence Element Name Sequence Element

40、Type Notes AttributeName TpString The name of the attribute. AttributeValue TpAttributeValue The typed value(s) for the attribute. 5.1.13 TpAttributeValue This is a tagged choice of data elements to hold attribute values of different complexity. Tag Element Type TpAttributeTagInfo Tag Element Value

41、Choice Element Type Choice Element Name P_SIMPLE_TYPE TpSimpleAttributeValue SimpleValue P_STRUCTURED_TYPE TpStructuredAttributeValue StructuredValue P_XML_TYPE TpXMLString XMLValue 5.1.14 TpAttributeList This is a Numbered List of Data Elements of type TpAttribute. 5.1.15 TpAttributeSet This is a N

42、umbered Set of Data Elements of type TpAttribute. 5.1.16 TpInt64 Defines a signed 64-bit integer. ETSI ETSI ES 202 915-2 V1.4.1 (2006-12) 9 5.1.17 TpVersion This data type is identical to TpString. It is used to uniquely identify the implemented version of the framework or an SCF. The syntax for thi

43、s datatype is defined as: P_ Where: is one of the strings listed in the table below. Character String Value Description PARLAY Specification released by The Parlay Group. ETSI Specification released by ETSI. 3GPP Specification released by 3GPP. consists of numbers separated by underscores (e.g. 3_1)

44、. It is recommended that not more than the two most significant numbers (major and minor version) of the version are used. Examples of version strings are: Character String Value Description P_PARLAY_3_1 Parlay v3.1. P_ETSI_2_0 ETSI v2.0. P_3GPP_4_3 3GPP Release 4.3. Note that different version stri

45、ngs can be aliases of each other all pointing to the same SCF/Framework version. 5.1.18 TpStringSet Defines a Numbered Set of Data Elements of type TpString. 5.1.19 TpStringList Defines a Numbered List of Data Elements of type TpString. 5.1.20 TpAttributeTagInfo TpAttributeTagInfo is an enumerated t

46、ype used as a discriminator for the TpAttributeValue structure, and can contain the following values: Name Value Description P_SIMPLE_TYPE 0 Simple type P_STRUCTURED_TYPE 1 Structured tyP_XML_TYPE 2 XML type ETSI ETSI ES 202 915-2 V1.4.1 (2006-12) 105.1.21 TpSimpleAttributeValue This is a tagged cho

47、ice of data elements to hold attribute values of different complexity. Tag Element Type TpSimpleAttributeTypeInfo Tag Element Value Choice Element Type Choice Element Name P_BOOLEAN TpBoolean BooleanValue P_OCTET pOctet OctetValP_CHAR pChar CharValue P_WCHAR TpWC WCharValue P_STRING pString StringVa

48、lP_WSTRING pWString WStringValue P_INT16 TpInt16 Int16Value P_UNSIGNED_INT16 TpUnsignedInt16 UnsignedInt16Value P_INT32 TpInt32 Int32Value P_UNSIGNED_INT32 TpUnsignedInt32 UnsignedInt32Value P_INT64 TpInt64 Int64Value P_UNSIGNED_INT64 TpUnsignedInt64 UnsignedInt64Value P_FLOAT TpFloat FloatValue P_D

49、OUBLE TpDouble DoubleValue P_FIXED pFixed FixedValue 5.1.22 TpSimpleAttributeTypeInfo TpSimpleAttributeTypeInfo is an enumerated type used as a discriminator for the TpSimpleAttributeValue structure, and can contain the following values: Name Value Description P_BOOLEAN 0 Attribute type is type TpBoolean. P_OCTET 1 Attribute type is type TpOctet. P_CHAR 2 Attribute type is type TpChar. P_WCHAR 3 Attribute type is type TpWChar. P_STRING 4 Attribute type is type TpString. P_WSTRING 5 Attribute type is type TpWString. P_INT16