1、 ETSI ES 204 915-2 V1.1.1 (2008-05)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 2: Common Data Definitions(Parlay 6)floppy3 ETSI ETSI ES 204 915-2 V1.1.1 (2008-05) 2 Reference DES/TISPAN-01032-2-OSA Keywords API, IDL, OSA, UML ETSI 650 Route des Lucioles F-069
2、21 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
3、.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.e
5、tsi.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 foreg
6、oing restriction extend to reproduction in all media. European Telecommunications Standards Institute 2008. The Parlay Group 2008. All rights reserved. DECTTM, PLUGTESTSTM, UMTSTM, TIPHONTM, the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered for the benefit of its Members. 3GPPTM i
7、s a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners. ETSI ETSI ES 204 915-2 V1.1.1 (2008-05) 3 Contents Intellectual Property Rights6 Foreword.6 1 Scope 7 2 References 7 3 Definitions and abbreviations.7 3.1 Definitions7 3.2 Abbreviations .7 4 Com
8、mon data definitions .7 5 Common system data definitions .8 5.1 Standard data types.8 5.1.1 TpBoolean.8 5.1.2 TpInt32 .8 5.1.3 TpFloat8 5.1.4 TpLongString8 5.1.5 TpOctet .8 5.1.6 TpOctetSet 8 5.1.7 TpString8 5.1.8 TpAssignmentID.8 5.1.9 TpSessionID .8 5.1.10 TpSessionIDSet 9 5.1.11 TpAny.9 5.1.12 Tp
9、Attribute .9 5.1.13 TpAttributeValue9 5.1.14 TpAttributeList .9 5.1.15 TpAttributeSet 9 5.1.16 TpInt64 .9 5.1.17 TpVersion .9 5.1.18 TpStringSet.10 5.1.19 TpStringList10 5.1.20 TpAttributeTagInfo.10 5.1.21 TpSimpleAttributeValue.11 5.1.22 TpSimpleAttributeTypeInfo .11 5.1.23 TpStructuredAttributeTyp
10、e.11 5.1.24 TpStructuredAttributeValue .12 5.1.25 TpChar12 5.1.26 TpWChar 12 5.1.27 TpWString 12 5.1.28 TpInt16 .12 5.1.29 TpUnsignedInt16 12 5.1.30 TpUnsignedInt32 12 5.1.31 TpUnsignedInt64 12 5.1.32 TpDouble 12 5.1.33 TpXMLString .12 5.1.34 TpUnorderedOctetSet .12 5.2 Other Data Sorts .13 5.2.1 Se
11、quence of Data Elements 13 5.2.2 Tagged Choice of Data Elements .13 5.2.3 Numbered Set of Data Elements.13 5.2.4 Reference 14 5.2.5 Numbered List of Data Elements14 5.3 Interface Related Data Definitions .14 5.3.1 IpInterface.14 5.3.2 IpInterfaceRef.14 ETSI ETSI ES 204 915-2 V1.1.1 (2008-05) 4 5.4 E
12、xception Classes.14 5.4.1 Underlying Technology Exceptions .14 5.4.2 TpCommonExceptions .14 5.4.3 Constants associated with TpCommonExceptions .15 5.4.4 Exceptions available to all methods on all interfaces .15 5.5 Date and Time Related Data Definitions16 5.5.1 TpDate 16 5.5.2 TpTime .16 5.5.3 TpDat
13、eAndTime .17 5.5.4 TpDuration17 5.5.5 TpTimeInterval .17 5.6 Address Related Data Definitions 18 5.6.1 TpAddress.18 5.6.2 TpAddressSet18 5.6.3 TpAddressPresentation .19 5.6.4 TpAddressScreening.19 5.6.5 TpAddressPlan19 5.6.6 TpAddressError 20 5.6.7 TpAddressRange.20 5.6.8 TpURL21 5.6.9 TpURN .21 5.7
14、 Price-related Data Definitions 22 5.7.1 TpPrice22 5.7.2 TpAoCInfo22 5.7.3 TpAoCOrder.22 5.7.4 TpCallAoCOrderCategory22 5.7.5 TpChargeAdviceInfo 22 5.7.6 TpCAIElements 23 5.7.7 TpChargePerTime.23 5.7.8 TpLanguage 23 5.8 Data Types Common Across Call Control and Data Session Control23 5.8.1 TpDataSes
15、sionQosClass .23 Annex A (normative): OMG IDL Description of the Common Data definitions .24 Annex B (informative): W3C WSDL Description of the Common Data definitions25 Annex C (informative): Java API Description of the Common Data definitions .26 Annex D (normative): Exception Hierarchy27 Annex E
16、(informative): Description of the Common Data definitions for 3GPP2 cdma2000 networks36 E.1 General Exceptions.36 E.2 Specific Exceptions36 E.2.1 Clause 1: Scope 36 E.2.2 Clause 2: References 36 E.2.3 Clause 3: Definitions and abbreviations.36 E.2.4 Clause 4: Common Data definitions.36 E.2.5 Clause
17、5: Common System Data definitions36 E.2.6 Annex A (normative): OMG IDL Description of the Common Data definitions.36 E.2.7 Annex B (informative): W3C WSDL Description of the Common Data definitions.37 E.2.8 Annex C (informative): Java API Description of the Common Data definitions .37 E.2.9 Annex D
18、(normative): Exception Hierarchy.37 Annex F (informative): Record of changes 38 F.1 Data Definitions .38 F.1.1 New 38 F.1.2 Modified.38 F.1.3 Removed.38 ETSI ETSI ES 204 915-2 V1.1.1 (2008-05) 5 F.2 Exceptions 38 F.2.1 New 38 F.2.2 Modified.38 F.2.3 Removed.39 F.3 Others .39 History 40 ETSI ETSI ES
19、204 915-2 V1.1.1 (2008-05) 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 00
20、0 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 Poli
21、cy, 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
22、 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 2 of a multi-part deliverable covering Open Service Access (OSA); Application Programming Interface (API), as i
23、dentified below. The API specification (ES 204 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 Ses
24、sion 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“; Part 15: “Multi-Media Messaging SCF“ Part 16: “Service Broker SC
25、F“. 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 JAIN Community (http:/ member companies. The present document forms part of the Parlay 6.0 set of specifications. The present document is equivalent
26、to 3GPP TS 29.198-2 V7.0.0 (Release 7). ETSI ETSI ES 204 915-2 V1.1.1 (2008-05) 7 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 d
27、evelopers to make use of network functionality through an open standardised 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 Da
28、ta are defined here, these being: Data Definitions. IDL Description of 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 204 915-1 contain provisions which, through reference in this text,
29、 constitute provisions of the present document. ETSI ES 204 915-1: “Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview (Parlay 6)“. 3 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in ES 204 91
30、5-1 apply. 3.2 Abbreviations For the purposes of the present document, the abbreviations given in ES 204 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 o
31、f each of the data types associated with the methods within the classes. 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 204 915-2 V1.1.1 (2008-05) 8
32、 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 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.
33、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 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 e
34、lements 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 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
35、.e. an object), irrespective of the method invoked on it. This ID may 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 su
36、pplied assignment ID. The assignment ID is identical to a TpInt32 type. 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 instance
37、s. For example, a single MultiPartyCallControlManager instance plus all 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: myCall
38、Object may implement the IpCall interface. 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. ETSI ETSI ES 204 915-2 V1.1.1 (2008-05) 9 EXAMPLE 2: myCallAndCa
39、llLegObject may implement the IpCall and IpCallLeg interfaces. If so, 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. Similar
40、ly, each call leg session will be identified by a call leg session ID 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 rema
41、ins. The session ID is identical to a TpInt32 type. 5.1.10 TpSessionIDSet 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
42、the attribute name and value. Sequence Element Name Sequence Element 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 differe
43、nt complexity. Tag Element Type TpAttributeTagInfo Tag Element Value 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
44、 Data Elements of type TpAttribute. 5.1.15 TpAttributeSet This is a Numbered Set of Data Elements of type TpAttribute. 5.1.16 TpInt64 Defines a signed 64-bit integer. 5.1.17 TpVersion This data type is identical to TpString. It is used to uniquely identify the implemented version of the framework or
45、 an SCF. The syntax for this datatype is defined as: P_ ETSI ETSI ES 204 915-2 V1.1.1 (2008-05) 10Where: 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 rele
46、ased by 3GPP. consists of numbers separated by underscores (e.g. 3_1). 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 ETS
47、I v2.0. P_3GPP_4_3 3GPP Release 4.3. Note that different version strings 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 TpSt
48、ring. 5.1.20 TpAttributeTagInfo TpAttributeTagInfo is an enumerated type 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 204 915-2
49、V1.1.1 (2008-05) 115.1.21 TpSimpleAttributeValue This is a tagged choice 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 StringValP_WSTRING pWString WStringValue P_INT16 TpInt16 Int16Value P_UNSIGNED_INT16 TpUnsignedInt16 UnsignedInt16Value P_INT32 TpInt32 Int32Value P_UNSIGNED_INT32 TpU
