SIST ES 202 915-7 V1.2.1:2005

Open Service Access (OSA); Application Programming Interface (API); Part 7: Terminal Capabilities SCF (Parlay 4)

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 )

Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 7. del: Terminalske zmožnosti SCF

General Information

• 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)

Standards Content (Sample)

SLOVENSKI STANDARD
SIST ES 202 915-7 V1.2.1:2005
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
SIST ES 202 915-7 V1.2.1:2005 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

---------------------- Page: 1 ----------------------

SIST ES 202 915-7 V1.2.1:2005

---------------------- Page: 2 ----------------------

SIST ES 202 915-7 V1.2.1:2005

ETSI ES 202 915-7 V1.2.1 (2003-08)
ETSI Standard


Open Service Access (OSA);
Application Programming Interface (API);
Part 7: Terminal Capabilities SCF
(Parlay 4)



�

---------------------- Page: 3 ----------------------

SIST ES 202 915-7 V1.2.1:2005
 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

---------------------- Page: 4 ----------------------

SIST ES 202 915-7 V1.2.1:2005
 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

---------------------- Page: 5 ----------------------

SIST ES 202 915-7 V1.2.1:2005
 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

---------------------- Page: 6 ----------------------

SIST ES 202 915-7 V1.2.1:2005
 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

---------------------- Page: 7 ----------------------

SIST ES 202 915-7 V1.2.1:2005
 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

---------------------- Page: 8 ----------------------

SIST ES 202 915-7 V1.2.1:2005
 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

---------------------- Page: 9 ----------------------

SIST ES 202 915-7 V1.2.1:2005
 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

---------------------- Page: 10 ----------------------

SIST ES 202 915-7 V1.2.1:2005
 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

---------------------- Page: 11 ----------------------

SIST ES 202 915-7 V1.2.1:2005
 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 used to specify the interface classes. The general format of an interface specification is
described below.
7.1.1 Interface Class
This shows a UML interface class description of the methods supported by that interface, and the relevant parameters
and types. The Service and Framework interfaces for enterprise-based client applications are denoted by classes with
name Ip. The callback interfaces to the applications are denoted by classes with name IpApp. For the
interfaces between a Service and the Framework, the Service interfaces are typically denoted by classes with name
IpSvc, while the Framework interfaces are denoted by classes with name IpFw
7.1.2 Method descriptions
Each method (API method 'call') is described. Both synchronous and asynchronous methods are used in the API.
Asynchronous methods are identified by a 'Req' suffix for a method request, and, if applicable, are served by
asynchronous methods identified by either a 'Res' or 'Err' suffix for method results and errors, respectively. To handle
responses and reports, the application or service developer must implement the relevant IpApp or IpSvc
interfaces to provide the callback mechanism.
7.1.3 Parameter descriptions
Each method parameter and its possible values are described. Parameters described as 'in' represent those that must have
a value when the method is called. Those described as 'out' are those that contain the return result of the method when
the method returns.
7.1.4 State Model
If relevant, a state model is shown to illustrate the states of the objects that implement the described interface.
7.2 Base Interface
7.2.1 Interface Class IpInterface
All application, framework and service interfaces inherit from the following interface. This API Base Interface does not
provide any additional methods.
<>
IpInterface


ETSI

---------------------- Page: 12 ----------------------

SIST ES 202 915-7 V1.2.1:2005
 11 ETSI ES 202 915-7 V1.2.1 (2003-08)
7.3 Service Interfaces
7.3.1 Overview
The Service Interfaces provide the interfaces into the capabilities of the underlying network - such as call control, user
interaction, messaging, mobility and connectivity management.
The interfaces that are implemented by the services are denoted as 'Service Interface'. The corresponding interfaces that
must be implemented by the application (e.g. for API callbacks) are denoted as 'Application Interface'.
7.4 Generic Service Interface
7.4.1 Interface Class IpService
Inherits from: IpInterface;
All service interfaces inherit from the following interface.
<>
IpService


setCallback (appInterface : in IpInterfaceRef) : void
setCallbackWithSessionID (appInterface : in IpInterfaceRef, sessionID : in TpSessionID) : void


7.4.1.1 Method setCallback()
This method specifies the reference address of the callback interface that a service uses to invoke methods on the
application. It is not allowed to invoke this method on an interface that uses SessionIDs.
Parameters
appInterface : in IpInterfaceRef
Specifies a reference to the application interface, which is used for callbacks.
Raises
TpCommonExceptions, P_INVALID_INTERFACE_TYPE

7.4.1.2 Method setCallbackWithSessionID()
This method specifies the reference address of the application's callback interface that a service uses for interactions
associated with a specific session ID: e.g. a specific call, or call leg. It is not allowed to invoke this method on an
interface that does not use SessionIDs.
Parameters
appInterface : in IpInterfaceRef
Specifies a reference to the application interface, which is used for callbacks.
ETSI

---------------------- Page: 13 ----------------------

SIST ES 202 915-7 V1.2.1:2005
 12 ETSI ES 202 915-7 V1.2.1 (2003-08)
sessionID : in TpSessionID
Specifies the session for which the service can invoke the application's callback interface.
Raises
TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_INTERFACE_TYPE

8 Terminal Capabilities Interface Classes
The Terminal Capabilities SCF enables the application to retrieve the terminal capabilities of the specified terminal.
Additionally it is possible for the application to request notifications when the capabilities of the terminal change in
some way. The Terminal Capabilities service provides SCF interfaces IpTerminalCapabilities and
IpExtendedTerminalCapabilities. The application side interface for the reporting is called
IpAppExtendedTerminalCapabilities.
8.1 Interface Class IpTerminalCapabilities
Inherits from: IpService.
The Terminal Capabilities SCF interface IpTerminalCapabilities contains the synchronous method
getTerminalCapabilities. The application has to provide the terminaIdentity as input to this method. The result indicates
whether or not the terminal capabilities are available in the network and, in case they are, it will return the terminal
capabilities (see the data definition of TpTerminalCapabilities for more information). The network may override some
capabilities that have been indicated by the terminal itself due to network policies or other restrictions or modifications
in the supported capabilities.
This interface, or IpExtendedTerminalCapabilities shall be implemented by a Terminal Capabilities SCF as a
minimum requirement. If this interface is implemented, the getTerminalCapabilities()method shall be implemented as a
minimum requirement.
<>
IpTerminalCapabilities


getTerminalCapabilities (terminalIdentity : in TpString) : TpTerminalCapabilities


8.1.1 Method getTerminalCapabilities()
This method is used by an application to get the capabilities of a user's terminal. Direction: Application to Network.
Returns result: Specifies the latest available capabilities of the user's terminal.
This information, if available, is returned as CC/PP headers as specified in W3C (see [6] in ES 202 915-1) and adopted
in the WAP UAProf specification (see [9] in ES 202 915-1). It contains URLs; terminal attributes and values, in RDF
format; or a combination of both.
Parameters
terminalIdentity : in TpString
Identifies the terminal. It may be a logical address known by the WAP Gateway/PushProxy.
ETSI

---------------------- Page: 14 ----------------------

SIST ES 202 915-7 V1.2.1:2005
 13 ETSI ES 202 915-7 V1.2.1 (2003-08)
Returns
TpTerminalCapabilities
Raises
TpCommonExceptions, P_INVALID_TERMINAL_ID

8.2 Interface Class IpExtendedTerminalCapabilities
Inherits from: IpTerminalCapabilities.
This interface can be used as an extended version of terminal capability monitoring. The application programmer can
use this interface to request terminal capability reports that are triggered by their changes. Note that the underlying
mechanisms for this network feature are cu
...