SIST ES 202 915-7 V1.2.1:2005

• Abstract:

  Maintenance update of ES 202 915-7 V1.1.1 to produce ES 202 915-7 V1.2.1 Updated document will also be known as PARLAY 4.1. Only those parts requiring modification will be updated ( most parts require maintenance fixes )

• Status: Published
• Publication Date: 31-Dec-2004
• ICS: 33.040.01 - Telecommunication systems in general
• Technical Committee: SPN - Services and Protocols for Networks
• Current Stage: 6060 - National Implementation/Publication (Adopted Project)
• Start Date: 01-Jan-2005
• Due Date: 01-Jan-2005
• Completion Date: 01-Jan-2005
• Ref Project: ETSI ES 202 915-7 V1.2.1 (2003-08) - Open Service Access (OSA); Application Programming Interface (API); Part 7: Terminal Capabilities SCF (Parlay 4)

SIST ES 202 915-7 V1.2.1:2005 is the SIST adoption of ETSI ES 202 915-7 Version 1.2.1, part 7 of the Open Service Access (OSA); Application Programming Interface (API) specification. It specifies the Terminal Capabilities Service Capability Feature (SCF) for retrieving terminal capabilities and, when supported, monitoring capability changes through application and service interfaces. The document is for application developers and network or service implementers working with OSA APIs, and it is equivalent to 3GPP TS 29.198-7 V5.3.0 (Release 5).

What does SIST ES 202 915-7 V1.2.1:2005 specify?

SIST ES 202 915-7 V1.2.1:2005 specifies the Terminal Capabilities SCF aspects of the OSA API Stage 3 specification. In practice, it defines how an application asks a network for terminal capabilities and how it can subscribe to capability-change reports.

The document is organized as a service interface specification with supporting diagrams and data definitions. It covers sequence diagrams, class diagrams, method descriptions, state models, service properties, data types, exception classes, and machine-readable interface descriptions.

Annex	What it covers
Annex A	Normative OMG IDL description of the Terminal Capabilities SCF
Annex B	Informative W3C WSDL description of the Terminal Capabilities SCF
Annex C	Informative contents of 3GPP OSA R5 Terminal Capabilities
Annex D	Informative record of changes

What are the key requirements of SIST ES 202 915-7 V1.2.1:2005?

The standard defines both direct retrieval of terminal capabilities and triggered reporting of changes. That matters because some deployments only need a one-time capability lookup, while others need ongoing monitoring when the device or its software changes.

Implementation support and callbacks

Clause 4.1 states that if an implementation supports a method, it shall support the method for at least one valid set of parameter values. For service interfaces, an unsupported method shall return P_METHOD_NOT_SUPPORTED; for application interfaces, the call shall still be possible and no exception shall be returned.

This distinction is practical for integrators: service-side code can detect unsupported operations explicitly, while application-side callback interfaces must remain callable even when a feature is not implemented.

Retrieving terminal capabilities

Clause 8.1 defines getTerminalCapabilities(terminalIdentity : in TpString) : TpTerminalCapabilities on IpTerminalCapabilities. The application supplies a terminal identity, and the network returns the latest available capabilities if they are available.

The returned information is described as CC/PP headers, using URLs, terminal attributes and values in RDF format, or both. In practice, this means the response can describe the terminal in a structured profile rather than a simple yes/no answer, and the network may override capabilities that the terminal reports itself because of policy or other restrictions.

Triggered reporting of capability changes

Clause 8.2 defines IpExtendedTerminalCapabilities for triggered reporting. The method triggeredTerminalCapabilityStartReq() starts monitoring and returns an TpAssignmentID; triggeredTerminalCapabilityStop() stops the reporting associated with that assignment.

This is the part to use when an application needs updates after hardware changes, software updates, or other capability changes. The request includes the target terminals, a capability scope, and change criteria, so the application can narrow what it wants to be told about.

Callback reports and errors

Clause 8.3 defines the application callback interface IpAppExtendedTerminalCapabilities. triggeredTerminalCapabilityReport() carries the changed capabilities, and triggeredTerminalCapabilityReportErr() reports a failure for the assignment or for some terminals in it.

In practice, the application developer must implement these callbacks to receive asynchronous updates. The report includes the assignment, the terminal set, the triggering criteria, and the current capabilities; the error report uses TpTerminalCapabilitiesError to explain why reporting failed.

Service property for triggered reporting

Clause 10 defines the property P_TRIGGERED_REPORTING_SUPPORTED with boolean values. TRUE means the SCF supports triggered reporting of terminal capabilities; FALSE means it does not.

This is useful for capability discovery at integration time, because an application can adapt its behavior based on whether continuous monitoring is available.

Data definitions that drive the API

Clause 11 defines the main data types used by the interface. TpTerminalCapabilities carries the capability information and a status code, TpTerminalCapabilitiesError carries defined failure causes, TpTerminalCapabilityChangeCriteria identifies what kind of change should trigger a report, and TpTerminalCapabilityScope describes the scope of the reported capabilities.

These definitions matter because they tell implementers what information must be exchanged and how to interpret the reports. The change criteria include general changes, hardware update, software update, and initial capabilities when monitoring starts.

What terms does SIST ES 202 915-7 V1.2.1:2005 define?

Open Service Access (OSA) is the architecture that lets applications use network functions through standardized APIs.

Application Programming Interface (API) is the interface family that the standard specifies for application access to network capabilities.

Service Capability Feature (SCF) is the functional part of OSA being specified here, in this case terminal capability handling.

Unified Modelling Language (UML) is the object-modelling notation used for the sequence diagrams, class diagrams, and state-related descriptions.

IpInterface is the base interface from which the application, service, and framework interfaces inherit.

TpTerminalCapabilities is the data type that carries the terminal capability result returned by the network.

TpTerminalCapabilityChangeCriteria is the data type that tells the SCF which changes should trigger a report.

P_TRIGGERED_REPORTING_SUPPORTED is the service property that tells an implementation whether triggered reporting is available.

Who uses SIST ES 202 915-7 V1.2.1:2005?

The standard is used by OSA API application developers who need to query terminal capabilities or receive change notifications. It is also used by service and network implementers who build the underlying SCF and its callback handling.

Quality and integration teams use it to check that the correct interfaces, callbacks, exceptions, and data types are implemented. Buyers and architects use it when they need to confirm that a platform supports terminal capability retrieval, triggered reporting, or both.

What changed in SIST ES 202 915-7 V1.2.1:2005 from the previous edition?

The document is a maintenance update of ES 202 915-7 V1.1.1 that produces ES 202 915-7 V1.2.1, also known as Parlay 4.1. The scope says that only the parts requiring modification were updated, with most parts receiving maintenance fixes.

Annex D records the following changes:

• IpExtendedTerminalCapabilities and IpAppExtendedTerminalCapabilities were added in the earlier Parlay 4.0 version.
• triggeredTerminalCapabilityStartReq, triggeredTerminalCapabilityStop, triggeredTerminalCapabilityReport, and triggeredTerminalCapabilityReportErr were added in the earlier Parlay 4.0 version.
• TpTerminalCapabilityChangeCriteria, TpTerminalCapabilityScopeType, and TpTerminalCapabilityScope were added in the earlier Parlay 4.0 version.
• TpTerminalCapabilitiesError was extended with P_TERMCAP_INFO_UNAVAILABLE.
• P_TRIGGERED_REPORTING_SUPPORTED was added as a service property.
• The order of elements in TpTerminalCapabilities was modified to match the IDL.

Which standards are used with SIST ES 202 915-7 V1.2.1:2005?

Clause 2 points to the earlier parts of the same OSA API series as the normative references used with this part.

• ETSI ES 202 915-1 - provides the overview, and the terms and abbreviations that apply to this part.
• ETSI ES 202 915-2 - provides the common data definitions used by data types referenced from this part.

The foreword also places this part within the wider ES 202 915 series and notes its equivalence to 3GPP TS 29.198-7 V5.3.0 (Release 5).

What does the SIST ES 202 915-7 V1.2.1:2005 document contain?

The document contains a worked example sequence diagram for retrieving terminal capabilities and starting or stopping triggered monitoring, plus a class diagram showing the relationships among IpInterface, IpService, IpTerminalCapabilities, IpExtendedTerminalCapabilities, and IpAppExtendedTerminalCapabilities. It also contains detailed interface specifications for the methods, parameters, return values, and callback behavior.

Clause 11 provides the structured data definitions that implementations exchange, including the capability result, error codes, change criteria, scope type, and scope structure. Clause 12 defines the exception class used by the API, and the annexes provide the machine-readable IDL and WSDL representations, the 3GPP R5 content mapping, and the change record.

SLOVENSKI STANDARD
01-januar-2005
Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 7.
del: Terminalske zmožnosti SCF
Open Service Access (OSA); Application Programming Interface (API); Part 7: Terminal
Capabilities SCF (Parlay 4)
Ta slovenski standard je istoveten z: ES 202 915-7 Version 1.2.1
ICS:
33.040.01 Telekomunikacijski sistemi Telecommunication systems
na splošno in general
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 7: Terminal Capabilities SCF
(Parlay 4)
�
2 ETSI ES 202 915-7 V1.2.1 (2003-08)

Reference
RES/SPAN-120096-7
Keywords
API, IDL, OSA, UML
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

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, send your comment to:
[e-mail]
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 2003.
© The Parlay Group 2003.
All rights reserved.
TM TM TM
DECT , PLUGTESTS and UMTS are Trade Marks of ETSI registered for the benefit of its Members.
TM
TIPHON and the TIPHON logo are Trade Marks currently being registered by ETSI 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
3 ETSI ES 202 915-7 V1.2.1 (2003-08)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
3 Definitions and abbreviations.6
3.1 Definitions.6
3.2 Abbreviations.6
4 Terminal Capabilities SCF .7
4.1 General requirements on support of methods.7
5 Sequence Diagrams.8
5.1 Terminal capabilities example.8
6 Class Diagrams.9
7 The Service Interface Specifications.10
7.1 Interface Specification Format .10
7.1.1 Interface Class.10
7.1.2 Method descriptions.10
7.1.3 Parameter descriptions.10
7.1.4 State Model.10
7.2 Base Interface.10
7.2.1 Interface Class IpInterface .10
7.3 Service Interfaces.11
7.3.1 Overview.11
7.4 Generic Service Interface .11
7.4.1 Interface Class IpService .11
7.4.1.1 Method setCallback().11
7.4.1.2 Method setCallbackWithSessionID().11
8 Terminal Capabilities Interface Classes .12
8.1 Interface Class IpTerminalCapabilities .12
8.1.1 Method getTerminalCapabilities().12
8.2 Interface Class IpExtendedTerminalCapabilities .13
8.2.1 Method <> triggeredTerminalCapabilityStartReq() .13
8.2.2 Method <> triggeredTerminalCapabilityStop().14
8.3 Interface Class IpAppExtendedTerminalCapabilities .14
8.3.1 Method <> triggeredTerminalCapabilityReport() .15
8.3.2 Method <> triggeredTerminalCapabilityReportErr() .15
9 State Transition Diagrams.16
10 Service Properties.16
11 Terminal Capabilities Data Definitions.16
11.1 terminalIdentity.16
11.2 TpTerminalCapabilities.16
11.3 TpTerminalCapabilitiesError.17
11.4 TpTerminalCapabilityChangeCriteria.17
11.5 TpTerminalCapabilityScopeType.17
11.6 TpTerminalCapabilityScope.17
12 Exception Classes.18
Annex A (normative): OMG IDL Description of Terminal Capabilities SCF .19
Annex B (informative): W3C WSDL Description of Terminal Capabilities SCF.20
ETSI
4 ETSI ES 202 915-7 V1.2.1 (2003-08)
Annex C (informative): Contents of 3GPP OSA R5 Terminal Capabilities .21
Annex D (informative): Record of changes .22
D.1 Interfaces.22
D.1.1 New.22
D.1.2 Deprecated.22
D.1.3 Removed.22
D.2 Methods.23
D.2.1 New.23
D.2.2 Deprecated.23
D.2.3 Modified.23
D.2.4 Removed.23
D.3 Data Definitions.23
D.3.1 New.23
D.3.2 Modified.24
D.3.3 Removed.24
D.4 Service Properties.24
D.4.1 New.24
D.4.2 Deprecated.24
D.4.3 Modified.24
D.4.4 Removed.25
D.5 Exceptions.25
D.5.1 New.25
D.5.2 Modified.25
D.5.3 Removed.25
D.6 Others.25
History .26

ETSI
5 ETSI ES 202 915-7 V1.2.1 (2003-08)
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 Services and Protocols for Advanced
Networks (SPAN).
The present document is part 7 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified 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 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 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 4.1 set of specifications.
The present document is equivalent to 3GPP TS 29.198-7 V5.3.0 (Release 5).
ETSI
6 ETSI ES 202 915-7 V1.2.1 (2003-08)
1 Scope
The present document is part 7 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 Terminal Capabilities Service Capability Feature (SCF) aspects of the interface. All
aspects of the Terminal Capabilities SCF are defined here, these being:
• Sequence Diagrams
• Class Diagrams
• Interface specification plus detailed method descriptions
• State Transition diagrams
• Data Definitions
• IDL Description of the interfaces
• WSDL Description of the interfaces
The process by which this task is accomplished is through the use of object modelling techniques described by the
Unified Modelling Language (UML).
2 References
The references listed in clause 2 of ES 202 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 202 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 4)".
ETSI ES 202 915-2: "Open Service Access (OSA); Application Programming Interface (API); Part 2: Common Data
Definitions (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, the abbreviations defined in ES 202 915-1 apply.
ETSI
7 ETSI ES 202 915-7 V1.2.1 (2003-08)
4 Terminal Capabilities SCF
The following clauses describe each aspect of the Terminal Capabilities Capability Feature (SCF).
The order is as follows:
• The Sequence diagrams give the reader a practical idea of how each of the SCF is implemented.
• The Class relationships clause show how each of the interfaces applicable to the SCF, relate to one another.
• The Interface specification clause describes in detail each of the interfaces shown within the Class diagram
part.
• The State Transition Diagrams (STD) show the transition between states in the SCF. The states and transitions
are well-defined; either methods specified in the Interface specification or events occurring in the underlying
networks cause state transitions.
• The Data Definitions clause show a detailed expansion of each of the data types associated with the methods
within the classes. Note that some data types are used in other methods and classes and are therefore defined
within the Common Data types part ES 202 915-2.
4.1 General requirements on support of methods
An implementation of this API which supports or implements a method described in the present document, shall
support or implement the functionality described for that method, for at least one valid set of values for the parameters
of that method.
Where a method is not supported by an implementation of a Service interface, the exception
P_METHOD_NOT_SUPPORTED shall be returned to any call of that method.
Where a method is not supported by an implementation of an Application interface, a call to that method shall be
possible, and no exception shall be returned.
ETSI
8 ETSI ES 202 915-7 V1.2.1 (2003-08)
5 Sequence Diagrams
5.1 Terminal capabilities example
The following example sequence diagram illustrates how the terminal capabilities can be retrieved and their changes
monitored.
Application : : :
IpAppExtendedTerminalCapabilities IpTerminalCapabilities IpExtendedTerminalCapabilities
1: getTerminalCapability( )
2: new( )
3: triggeredTerminalCapabilityStartReq(  )
4: triggeredTerminalCapabilityReport(  )
5: forward notification
6: triggeredTerminalCapabilityReport(  )
7: forward notification
8: triggeredTerminalCapabilityReportErr(  )
9: forward error
10: triggeredTerminalCapabilityReport(  )
11: forward notification
12: triggeredTerminalCapabilityStop( )

1: The application retrieves the terminal capability of a terminal.
2: The application creates an object to implement IpAppExtendedTerminalCapabilities.
3: The terminal capabilities changes are started to be monitored.
4: The terminal capabilities have changed and they are reported as requested.
5: The report is forwarded internally to the application.
6: The terminal capabilities have changed and they are reported as requested.
7: The report is forwarded internally to the application.
8: An error has happened in the monitoring and it is reported.
ETSI
9 ETSI ES 202 915-7 V1.2.1 (2003-08)
9: The error report is forwarded internally to the application.
10: The terminal capabilities have changed and they are reported as requested.
11: The report is forwarded internally to the application.
12: The terminal capability monitoring is stopped.
6 Class Diagrams
Terminal Capabilities Class Diagram:
<>
IpInterface
(from c sapi)
<>
IpAppExtendedTerminalCapabilities
(f rom t ermcap)
<> triggeredTerminalCapabilityReport()
<> triggeredTerminalCapabilityReportErr()
<>
<>
IpExtendedTerminalCapabilities
(f rom t ermcap)
<> triggeredTerminalCapabilityStartReq()
<> triggeredTerminalCapabilityStop()
<>
IpTerminalCapabilities
(f rom t ermcap)
getTerminalCapabilities()
<>
IpService
(from c sapi)
setCallback()
setCallbackWithSessionID()
Figure 1: Terminal Capabilities Class Diagram
ETSI
10 ETSI ES 202 915-7 V1.2.1 (2003-08)
7 The Service Interface Specifications
7.1 Interface Specification Format
This clause defines the interfaces, methods and parameters that form a part of the API specification. The Unified
Modelling Language (UML) is us
...