SIST ES 204 915-2 V1.1.1:2008
Open Service Access (OSA) - Application Programming Interface (API) - Part 2: Common Data Definitions (Parlay 6)
Open Service Access (OSA) - Application Programming Interface (API) - Part 2: Common Data Definitions (Parlay 6)
ETSI OSA APIs Phase 4. Based on ES 203 915 and the new requirements for OSA Phase 4, to produce ES 204 915 V1.1.1. ETSI OSA Phase 4 incorporates 3GPP OSA Release 7 and is also known as Parlay 6.0.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 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 Data 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.
Odprti dostop do storitve (OSA) - Aplikacijski programski vmesnik (API) - 2. del: Definicije splošnih podatkov (Parlay 6)
General Information
Buy Standard
Standards Content (Sample)
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)
�
---------------------- Page: 1 ----------------------
2 ETSI ES 204 915-2 V1.1.1 (2008-05)
Reference
DES/TISPAN-01032-2-OSA
Keywords
API, IDL, OSA, UML
ETSI
650 Route des Lucioles
F-06921 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 enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.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 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.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 foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 2 ----------------------
3 ETSI ES 204 915-2 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.6
Foreword.6
1 Scope.7
2 References.7
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.7
4 Common 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 TpFloat.8
5.1.4 TpLongString.8
5.1.5 TpOctet.8
5.1.6 TpOctetSet.8
5.1.7 TpString.8
5.1.8 TpAssignmentID.8
5.1.9 TpSessionID.8
5.1.10 TpSessionIDSet.9
5.1.11 TpAny.9
5.1.12 TpAttribute.9
5.1.13 TpAttributeValue.9
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 TpStringList.10
5.1.20 TpAttributeTagInfo.10
5.1.21 TpSimpleAttributeValue.11
5.1.22 TpSimpleAttributeTypeInfo.11
5.1.23 TpStructuredAttributeType.11
5.1.24 TpStructuredAttributeValue.12
5.1.25 TpChar.12
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 Sequence 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 Elements.14
5.3 Interface Related Data Definitions .14
5.3.1 IpInterface.14
5.3.2 IpInterfaceRef.14
ETSI
---------------------- Page: 3 ----------------------
4 ETSI ES 204 915-2 V1.1.1 (2008-05)
5.4 Exception 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 Definitions.16
5.5.1 TpDate.16
5.5.2 TpTime.16
5.5.3 TpDateAndTime.17
5.5.4 TpDuration.17
5.5.5 TpTimeInterval.17
5.6 Address Related Data Definitions .18
5.6.1 TpAddress.18
5.6.2 TpAddressSet.18
5.6.3 TpAddressPresentation.19
5.6.4 TpAddressScreening.19
5.6.5 TpAddressPlan.19
5.6.6 TpAddressError .20
5.6.7 TpAddressRange.20
5.6.8 TpURL.21
5.6.9 TpURN.21
5.7 Price-related Data Definitions .22
5.7.1 TpPrice.22
5.7.2 TpAoCInfo.22
5.7.3 TpAoCOrder.22
5.7.4 TpCallAoCOrderCategory.22
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 Control.23
5.8.1 TpDataSessionQosClass.23
Annex A (normative): OMG IDL Description of the Common Data definitions .24
Annex B (informative): W3C WSDL Description of the Common Data definitions.25
Annex C (informative): Java™ API Description of the Common Data definitions .26
Annex D (normative): Exception Hierarchy.27
Annex E (informative): Description of the Common Data definitions for 3GPP2 cdma2000
networks.36
E.1 General Exceptions.36
E.2 Specific Exceptions.36
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 5: Common System Data definitions.36
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 (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
---------------------- Page: 4 ----------------------
5 ETSI ES 204 915-2 V1.1.1 (2008-05)
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
---------------------- Page: 5 ----------------------
6 ETSI ES 204 915-2 V1.1.1 (2008-05)
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: "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, 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 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 identified 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 Session 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 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 JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 6.0 set of specifications.
The present document is equivalent to 3GPP TS 29.198-2 V7.0.0 (Release 7).
ETSI
---------------------- Page: 6 ----------------------
7 ETSI ES 204 915-2 V1.1.1 (2008-05)
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 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 Data 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, 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 915-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 of 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
---------------------- Page: 7 ----------------------
8 ETSI ES 204 915-2 V1.1.1 (2008-05)
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.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 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 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 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 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 instances. 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: myCallObject 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
---------------------- Page: 8 ----------------------
9 ETSI ES 204 915-2 V1.1.1 (2008-05)
EXAMPLE 2: myCallAndCallLegObject 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. Similarly, 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 remains.
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 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 different 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 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
an SCF. The syntax for this datatype is defined as:
P__
ETSI
---------------------- Page: 9 ----------------------
10 ETSI ES 204 915-2 V1.1.1 (2008-05)
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). 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 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 TpString.
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 type
P_XML_TYPE 2 XML type
ETSI
---------------------- Page: 10 ----------------------
11 ETSI ES 204 915-2 V1.1.1 (2008-05)
5.1.21 TpSimpleAttributeValue
This is a tagged choice of data elements to hold attribute values
...
Final draft ETSI ES 204 915-2 V1.1.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 2: Common Data Definitions
(Parlay 6)
�
---------------------- Page: 1 ----------------------
2 Final draft ETSI ES 204 915-2 V1.1.1 (2008-02)
Reference
DES/TISPAN-01032-2-OSA
Keywords
API, IDL, OSA, UML
ETSI
650 Route des Lucioles
F-06921 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 enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.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 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.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 foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 2 ----------------------
3 Final draft ETSI ES 204 915-2 V1.1.1 (2008-02)
Contents
Intellectual Property Rights.6
Foreword.6
1 Scope.7
2 References.7
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.7
4 Common 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 TpFloat.8
5.1.4 TpLongString.8
5.1.5 TpOctet.8
5.1.6 TpOctetSet.8
5.1.7 TpString.8
5.1.8 TpAssignmentID.8
5.1.9 TpSessionID.8
5.1.10 TpSessionIDSet.9
5.1.11 TpAny.9
5.1.12 TpAttribute.9
5.1.13 TpAttributeValue.9
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 TpStringList.10
5.1.20 TpAttributeTagInfo.10
5.1.21 TpSimpleAttributeValue.11
5.1.22 TpSimpleAttributeTypeInfo.11
5.1.23 TpStructuredAttributeType.11
5.1.24 TpStructuredAttributeValue.12
5.1.25 TpChar.12
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 Sequence 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 Elements.14
5.3 Interface Related Data Definitions .14
5.3.1 IpInterface.14
5.3.2 IpInterfaceRef.14
ETSI
---------------------- Page: 3 ----------------------
4 Final draft ETSI ES 204 915-2 V1.1.1 (2008-02)
5.4 Exception 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 Definitions.16
5.5.1 TpDate.16
5.5.2 TpTime.16
5.5.3 TpDateAndTime.17
5.5.4 TpDuration.17
5.5.5 TpTimeInterval.17
5.6 Address Related Data Definitions .18
5.6.1 TpAddress.18
5.6.2 TpAddressSet.18
5.6.3 TpAddressPresentation.19
5.6.4 TpAddressScreening.19
5.6.5 TpAddressPlan.19
5.6.6 TpAddressError .20
5.6.7 TpAddressRange.20
5.6.8 TpURL.21
5.6.9 TpURN.21
5.7 Price-related Data Definitions .22
5.7.1 TpPrice.22
5.7.2 TpAoCInfo.22
5.7.3 TpAoCOrder.22
5.7.4 TpCallAoCOrderCategory.22
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 Control.23
5.8.1 TpDataSessionQosClass.23
Annex A (normative): OMG IDL Description of the Common Data definitions .24
Annex B (informative): W3C WSDL Description of the Common Data definitions.25
Annex C (informative): Java™ API Description of the Common Data definitions .26
Annex D (normative): Exception Hierarchy.27
Annex E (informative): Description of the Common Data definitions for 3GPP2 cdma2000
networks.36
E.1 General Exceptions.36
E.2 Specific Exceptions.36
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 5: Common System Data definitions.36
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 (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
---------------------- Page: 4 ----------------------
5 Final draft ETSI ES 204 915-2 V1.1.1 (2008-02)
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
---------------------- Page: 5 ----------------------
6 Final draft ETSI ES 204 915-2 V1.1.1 (2008-02)
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: "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, 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 Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN), and is now submitted for the ETSI standards
Membership Approval Procedure.
The present document is part 2 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified 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 Session 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 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 JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 6.0 set of specifications.
The present document is equivalent to 3GPP TS 29.198-2 V7.0.0 (Release 7).
ETSI
---------------------- Page: 6 ----------------------
7 Final draft ETSI ES 204 915-2 V1.1.1 (2008-02)
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 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 Data 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, 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 915-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 of 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
---------------------- Page: 7 ----------------------
8 Final draft ETSI ES 204 915-2 V1.1.1 (2008-02)
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.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 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 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 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 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 instances. 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: myCallObject 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
---------------------- Page: 8 ----------------------
9 Final draft ETSI ES 204 915-2 V1.1.1 (2008-02)
EXAMPLE 2: myCallAndCallLegObject 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. Similarly, 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 remains.
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 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 different 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 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
an SCF. The syntax for this datatype is defined as:
P__
ETSI
---------------------- Page: 9 ----------------------
10 Final draft ETSI ES 204 915-2 V1.1.1 (2008-02)
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). 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 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 TpString.
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 type
P_XML_TYPE 2 XML type
ETS
...
SLOVENSKI STANDARD
SIST ES 204 915-2 V1.1.1:2008
01-september-2008
Odprti dostop do storitve (OSA) - Aplikacijski programski vmesnik (API) - 2. del:
Definicije splošnih podatkov (Parlay 6)
Open Service Access (OSA) - Application Programming Interface (API) - Part 2:
Common Data Definitions (Parlay 6)
Ta slovenski standard je istoveten z: ES 204 915-2 Version 1.1.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
SIST ES 204 915-2 V1.1.1:2008 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
---------------------- Page: 1 ----------------------
SIST ES 204 915-2 V1.1.1:2008
---------------------- Page: 2 ----------------------
SIST ES 204 915-2 V1.1.1:2008
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)
�
---------------------- Page: 3 ----------------------
SIST ES 204 915-2 V1.1.1:2008
2 ETSI ES 204 915-2 V1.1.1 (2008-05)
Reference
DES/TISPAN-01032-2-OSA
Keywords
API, IDL, OSA, UML
ETSI
650 Route des Lucioles
F-06921 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 enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.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 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.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 foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 4 ----------------------
SIST ES 204 915-2 V1.1.1:2008
3 ETSI ES 204 915-2 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.6
Foreword.6
1 Scope.7
2 References.7
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.7
4 Common 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 TpFloat.8
5.1.4 TpLongString.8
5.1.5 TpOctet.8
5.1.6 TpOctetSet.8
5.1.7 TpString.8
5.1.8 TpAssignmentID.8
5.1.9 TpSessionID.8
5.1.10 TpSessionIDSet.9
5.1.11 TpAny.9
5.1.12 TpAttribute.9
5.1.13 TpAttributeValue.9
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 TpStringList.10
5.1.20 TpAttributeTagInfo.10
5.1.21 TpSimpleAttributeValue.11
5.1.22 TpSimpleAttributeTypeInfo.11
5.1.23 TpStructuredAttributeType.11
5.1.24 TpStructuredAttributeValue.12
5.1.25 TpChar.12
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 Sequence 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 Elements.14
5.3 Interface Related Data Definitions .14
5.3.1 IpInterface.14
5.3.2 IpInterfaceRef.14
ETSI
---------------------- Page: 5 ----------------------
SIST ES 204 915-2 V1.1.1:2008
4 ETSI ES 204 915-2 V1.1.1 (2008-05)
5.4 Exception 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 Definitions.16
5.5.1 TpDate.16
5.5.2 TpTime.16
5.5.3 TpDateAndTime.17
5.5.4 TpDuration.17
5.5.5 TpTimeInterval.17
5.6 Address Related Data Definitions .18
5.6.1 TpAddress.18
5.6.2 TpAddressSet.18
5.6.3 TpAddressPresentation.19
5.6.4 TpAddressScreening.19
5.6.5 TpAddressPlan.19
5.6.6 TpAddressError .20
5.6.7 TpAddressRange.20
5.6.8 TpURL.21
5.6.9 TpURN.21
5.7 Price-related Data Definitions .22
5.7.1 TpPrice.22
5.7.2 TpAoCInfo.22
5.7.3 TpAoCOrder.22
5.7.4 TpCallAoCOrderCategory.22
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 Control.23
5.8.1 TpDataSessionQosClass.23
Annex A (normative): OMG IDL Description of the Common Data definitions .24
Annex B (informative): W3C WSDL Description of the Common Data definitions.25
Annex C (informative): Java™ API Description of the Common Data definitions .26
Annex D (normative): Exception Hierarchy.27
Annex E (informative): Description of the Common Data definitions for 3GPP2 cdma2000
networks.36
E.1 General Exceptions.36
E.2 Specific Exceptions.36
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 5: Common System Data definitions.36
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 (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
---------------------- Page: 6 ----------------------
SIST ES 204 915-2 V1.1.1:2008
5 ETSI ES 204 915-2 V1.1.1 (2008-05)
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
---------------------- Page: 7 ----------------------
SIST ES 204 915-2 V1.1.1:2008
6 ETSI ES 204 915-2 V1.1.1 (2008-05)
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: "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, 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 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 identified 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 Session 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 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 JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 6.0 set of specifications.
The present document is equivalent to 3GPP TS 29.198-2 V7.0.0 (Release 7).
ETSI
---------------------- Page: 8 ----------------------
SIST ES 204 915-2 V1.1.1:2008
7 ETSI ES 204 915-2 V1.1.1 (2008-05)
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 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 Data 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, 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 915-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 of 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
---------------------- Page: 9 ----------------------
SIST ES 204 915-2 V1.1.1:2008
8 ETSI ES 204 915-2 V1.1.1 (2008-05)
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.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 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 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 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 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 instances. 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: myCallObject 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
---------------------- Page: 10 ----------------------
SIST ES 204 915-2 V1.1.1:2008
9 ETSI ES 204 915-2 V1.1.1 (2008-05)
EXAMPLE 2: myCallAndCallLegObject 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. Similarly, 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 remains.
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 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 different 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 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
an SCF. The syntax for this datatype is defined as:
P__
ETSI
---------------------- Page: 11 ----------------------
SIST ES 204 915-2 V1.1.1:2008
10 ETSI ES 204 915-2 V1.1.1 (2008-05)
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.
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.