ETSI ES 204 915-11 V1.1.1 (2008-05)
Open Service Access (OSA); Application Programming Interface (API); Part 11: Account Management SCF (Parlay 6)
Open Service Access (OSA); Application Programming Interface (API); Part 11: Account Management SCF (Parlay 6)
DES/TISPAN-01032-11-OSA
Odprti dostop do storitve (OSA) - Aplikacijski programski vmesnik (API) - 11. del: Lastnost storitvene zmožnosti (SCF) za upravljanje obračuna (Parlay 6)
General Information
Buy Standard
Standards Content (Sample)
ETSI ES 204 915-11 V1.1.1 (2008-05)
ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 11: Account Management SCF
(Parlay 6)
�
---------------------- Page: 1 ----------------------
2 ETSI ES 204 915-11 V1.1.1 (2008-05)
Reference
DES/TISPAN-01032-11-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-11 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 Account Management SCF .8
4.1 General requirements on support of methods.8
5 Sequence Diagrams.9
5.1 Standard Voucher Handling .9
5.2 Standard Transaction History Retrieval .10
5.3 Standard Query Handling.11
5.4 Standard Notification handling.12
5.5 Network Controlled Notifications .13
6 Class Diagrams.14
7 The Service Interface Specifications.15
7.1 Interface Specification Format .15
7.1.1 Interface Class.15
7.1.2 Method descriptions.16
7.1.3 Parameter descriptions.16
7.1.4 State Model.16
7.2 Base Interface.16
7.2.1 Interface Class IpInterface .16
7.3 Service Interfaces.16
7.3.1 Overview.16
7.4 Generic Service Interface .16
7.4.1 Interface Class IpService .16
7.4.1.1 Method setCallback().17
7.4.1.2 Method setCallbackWithSessionID().17
8 Account Management Interface Classes .18
8.1 Interface Class IpAccountManager .18
8.1.1 Method createNotification().18
8.1.2 Method destroyNotification().19
8.1.3 Method queryBalanceReq().19
8.1.4 Method changeNotification().20
8.1.5 Method getNotification().20
8.1.6 Method retrieveTransactionHistoryReq().20
8.1.7 Method enableNotifications().21
8.1.8 Method disableNotifications().21
8.1.9 Method queryBalanceExpiryDateReq().21
8.1.10 Method updateBalanceReq().22
8.1.11 Method createVoucherReq().22
8.1.12 Method destroyVoucherReq().23
8.1.13 Method queryVoucherReq().23
8.1.14 Method queryUserVouchersReq().23
8.2 Interface Class IpAppAccountManager .24
8.2.1 Method reportNotification().25
8.2.2 Method queryBalanceRes().25
8.2.3 Method queryBalanceErr().25
8.2.4 Method retrieveTransactionHistoryRes().25
ETSI
---------------------- Page: 3 ----------------------
4 ETSI ES 204 915-11 V1.1.1 (2008-05)
8.2.5 Method retrieveTransactionHistoryErr().26
8.2.6 Method queryBalanceExpiryDateRes().26
8.2.7 Method queryBalanceExpiryDateErr().26
8.2.8 Method updateBalanceRes().26
8.2.9 Method updateBalanceErr().27
8.2.10 Method createVoucherRes().27
8.2.11 Method createVoucherErr().27
8.2.12 Method destroyVoucherRes().27
8.2.13 Method destroyVoucherErr().28
8.2.14 Method queryVoucherRes().28
8.2.15 Method queryVoucherErr().28
8.2.16 Method queryUserVouchersRes().28
8.2.17 Method queryUserVouchersErr().29
9 State Transition Diagrams.29
9.1 State Transition Diagrams for IpAccountManager.29
9.1.1 Active State.29
9.1.2 Notifications created State .30
10 Account Management Service Properties .30
11 Data Definitions.30
11.1 Account Management Data Definitions .30
11.1.1 IpAppAccountManager .31
11.1.2 IpAppAccountManagerRef.31
11.1.3 IpAccountManager.31
11.1.4 IpAccountManagerRef.31
11.1.5 TpBalanceQueryError.31
11.1.6 TpChargingEventName.31
11.1.7 TpBalanceInfo.32
11.1.8 TpChargingEventInfo.32
11.1.9 TpChargingEventCriteria.33
11.1.10 TpChargingEventNameSet.33
11.1.11 TpChargingEventCriteriaResult.33
11.1.12 TpChargingEventCriteriaResultSet.33
11.1.13 TpBalance.33
11.1.14 TpBalanceSet.33
11.1.15 TpTransactionHistory.33
11.1.16 TpTransactionHistorySet.34
11.1.17 TpTransactionHistoryStatus.34
11.1.18 TpBalanceExpiryDate.34
11.1.19 TpBalanceExpiryDateSet.34
11.1.20 TpVoucherError.34
11.1.21 TpVoucher .34
11.1.22 TpVoucherSet.35
12 Exception Classes.35
Annex A (normative): OMG IDL Description of Account Management SCF .36
Annex B (informative): W3C WSDL Description of Account Management SCF.37
Annex C (informative): Java™ API Description of the Account Management SCF .38
Annex D (informative): Contents of 3GPP OSA Rel-7 Account Management.39
Annex E (informative): Description of Account Management for 3GPP2 cdma2000 networks.40
E.1 General Exceptions.40
E.2 Specific Exceptions.40
E.2.1 Clause 1: Scope .40
E.2.2 Clause 2: References .40
E.2.3 Clause 3: Definitions and abbreviations.40
ETSI
---------------------- Page: 4 ----------------------
5 ETSI ES 204 915-11 V1.1.1 (2008-05)
E.2.4 Clause 4: Account Management SCF.40
E.2.5 Clause 5: Sequence Diagrams .40
E.2.6 Clause 6: Class Diagrams.40
E.2.7 Clause 7: The Service Interface Specifications .40
E.2.8 Clause 8: Account Management Interface Classes.41
E.2.9 Clause 9: State Transition Diagrams .41
E.2.10 Clause 10: Account Management Service Properties.41
E.2.11 Clause 11: Data Definitions.41
E.2.12 Clause 12: Exception Classes.41
E.2.13 Annex A (normative): OMG IDL Description of Account Management SCF.41
E.2.14 Annex B (informative): W3C WSDL Description of Account Management SCF.41
Annex F (informative): Record of changes .42
F.1 Interfaces.42
F.1.1 New.42
F.1.2 Deprecated.42
F.1.3 Removed.42
F.2 Methods.42
F.2.1 New.42
F.2.2 Deprecated.42
F.2.3 Modified.43
F.2.4 Removed.43
F.3 Data Definitions.43
F.3.1 New.43
F.3.2 Modified.43
F.3.3 Removed.43
F.4 Service Properties.43
F.4.1 New.43
F.4.2 Deprecated.44
F.4.3 Modified.44
F.4.4 Removed.44
F.5 Exceptions.44
F.5.1 New.44
F.5.2 Modified.44
F.5.3 Removed.44
F.6 Others.44
History .45
ETSI
---------------------- Page: 5 ----------------------
6 ETSI ES 204 915-11 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 11 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-11 V7.0.0 (Release 7).
ETSI
---------------------- Page: 6 ----------------------
7 ETSI ES 204 915-11 V1.1.1 (2008-05)
1 Scope
The present document is part 11 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 Account Management Service Capability Feature (SCF) aspects of the interface. All
aspects of the Account Management 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 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.
ETSI
---------------------- Page: 7 ----------------------
8 ETSI ES 204 915-11 V1.1.1 (2008-05)
4 Account Management SCF
The following clauses describe each aspect of the Account Management Service 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 shows 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 shows 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 204 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: 8 ----------------------
9 ETSI ES 204 915-11 V1.1.1 (2008-05)
5 Sequence Diagrams
5.1 Standard Voucher Handling
: :
IpAppAccountManager IpAcco
...
Final draft ETSI ES 204 915-11 V1.1.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 11: Account Management SCF
(Parlay 6)
�
---------------------- Page: 1 ----------------------
2 Final draft ETSI ES 204 915-11 V1.1.1 (2008-02)
Reference
DES/TISPAN-01032-11-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-11 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 Account Management SCF .8
4.1 General requirements on support of methods.8
5 Sequence Diagrams.9
5.1 Standard Voucher Handling .9
5.2 Standard Transaction History Retrieval .10
5.3 Standard Query Handling.11
5.4 Standard Notification handling.12
5.5 Network Controlled Notifications .13
6 Class Diagrams.14
7 The Service Interface Specifications.15
7.1 Interface Specification Format .15
7.1.1 Interface Class.15
7.1.2 Method descriptions.16
7.1.3 Parameter descriptions.16
7.1.4 State Model.16
7.2 Base Interface.16
7.2.1 Interface Class IpInterface .16
7.3 Service Interfaces.16
7.3.1 Overview.16
7.4 Generic Service Interface .16
7.4.1 Interface Class IpService .16
7.4.1.1 Method setCallback().17
7.4.1.2 Method setCallbackWithSessionID().17
8 Account Management Interface Classes .18
8.1 Interface Class IpAccountManager .18
8.1.1 Method createNotification().18
8.1.2 Method destroyNotification().19
8.1.3 Method queryBalanceReq().19
8.1.4 Method changeNotification().20
8.1.5 Method getNotification().20
8.1.6 Method retrieveTransactionHistoryReq().20
8.1.7 Method enableNotifications().21
8.1.8 Method disableNotifications().21
8.1.9 Method queryBalanceExpiryDateReq().21
8.1.10 Method updateBalanceReq().22
8.1.11 Method createVoucherReq().22
8.1.12 Method destroyVoucherReq().23
8.1.13 Method queryVoucherReq().23
8.1.14 Method queryUserVouchersReq().23
8.2 Interface Class IpAppAccountManager .24
8.2.1 Method reportNotification().25
8.2.2 Method queryBalanceRes().25
8.2.3 Method queryBalanceErr().25
8.2.4 Method retrieveTransactionHistoryRes().25
ETSI
---------------------- Page: 3 ----------------------
4 Final draft ETSI ES 204 915-11 V1.1.1 (2008-02)
8.2.5 Method retrieveTransactionHistoryErr().26
8.2.6 Method queryBalanceExpiryDateRes().26
8.2.7 Method queryBalanceExpiryDateErr().26
8.2.8 Method updateBalanceRes().26
8.2.9 Method updateBalanceErr().27
8.2.10 Method createVoucherRes().27
8.2.11 Method createVoucherErr().27
8.2.12 Method destroyVoucherRes().27
8.2.13 Method destroyVoucherErr().28
8.2.14 Method queryVoucherRes().28
8.2.15 Method queryVoucherErr().28
8.2.16 Method queryUserVouchersRes().28
8.2.17 Method queryUserVouchersErr().29
9 State Transition Diagrams.29
9.1 State Transition Diagrams for IpAccountManager.29
9.1.1 Active State.29
9.1.2 Notifications created State .30
10 Account Management Service Properties .30
11 Data Definitions.30
11.1 Account Management Data Definitions .30
11.1.1 IpAppAccountManager .31
11.1.2 IpAppAccountManagerRef.31
11.1.3 IpAccountManager.31
11.1.4 IpAccountManagerRef.31
11.1.5 TpBalanceQueryError.31
11.1.6 TpChargingEventName.31
11.1.7 TpBalanceInfo.32
11.1.8 TpChargingEventInfo.32
11.1.9 TpChargingEventCriteria.33
11.1.10 TpChargingEventNameSet.33
11.1.11 TpChargingEventCriteriaResult.33
11.1.12 TpChargingEventCriteriaResultSet.33
11.1.13 TpBalance.33
11.1.14 TpBalanceSet.33
11.1.15 TpTransactionHistory.33
11.1.16 TpTransactionHistorySet.34
11.1.17 TpTransactionHistoryStatus.34
11.1.18 TpBalanceExpiryDate.34
11.1.19 TpBalanceExpiryDateSet.34
11.1.20 TpVoucherError.34
11.1.21 TpVoucher .34
11.1.22 TpVoucherSet.35
12 Exception Classes.35
Annex A (normative): OMG IDL Description of Account Management SCF .36
Annex B (informative): W3C WSDL Description of Account Management SCF.37
Annex C (informative): Java™ API Description of the Account Management SCF .38
Annex D (informative): Contents of 3GPP OSA Rel-7 Account Management.39
Annex E (informative): Description of Account Management for 3GPP2 cdma2000 networks.40
E.1 General Exceptions.40
E.2 Specific Exceptions.40
E.2.1 Clause 1: Scope .40
E.2.2 Clause 2: References .40
E.2.3 Clause 3: Definitions and abbreviations.40
ETSI
---------------------- Page: 4 ----------------------
5 Final draft ETSI ES 204 915-11 V1.1.1 (2008-02)
E.2.4 Clause 4: Account Management SCF.40
E.2.5 Clause 5: Sequence Diagrams .40
E.2.6 Clause 6: Class Diagrams.40
E.2.7 Clause 7: The Service Interface Specifications .40
E.2.8 Clause 8: Account Management Interface Classes.41
E.2.9 Clause 9: State Transition Diagrams .41
E.2.10 Clause 10: Account Management Service Properties.41
E.2.11 Clause 11: Data Definitions.41
E.2.12 Clause 12: Exception Classes.41
E.2.13 Annex A (normative): OMG IDL Description of Account Management SCF.41
E.2.14 Annex B (informative): W3C WSDL Description of Account Management SCF.41
Annex F (informative): Record of changes .42
F.1 Interfaces.42
F.1.1 New.42
F.1.2 Deprecated.42
F.1.3 Removed.42
F.2 Methods.42
F.2.1 New.42
F.2.2 Deprecated.42
F.2.3 Modified.43
F.2.4 Removed.43
F.3 Data Definitions.43
F.3.1 New.43
F.3.2 Modified.43
F.3.3 Removed.43
F.4 Service Properties.43
F.4.1 New.43
F.4.2 Deprecated.44
F.4.3 Modified.44
F.4.4 Removed.44
F.5 Exceptions.44
F.5.1 New.44
F.5.2 Modified.44
F.5.3 Removed.44
F.6 Others.44
History .45
ETSI
---------------------- Page: 5 ----------------------
6 Final draft ETSI ES 204 915-11 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 11 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-11 V7.0.0 (Release 7).
ETSI
---------------------- Page: 6 ----------------------
7 Final draft ETSI ES 204 915-11 V1.1.1 (2008-02)
1 Scope
The present document is part 11 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 Account Management Service Capability Feature (SCF) aspects of the interface. All
aspects of the Account Management 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 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.
ETSI
---------------------- Page: 7 ----------------------
8 Final draft ETSI ES 204 915-11 V1.1.1 (2008-02)
4 Account Management SCF
The following clauses describe each aspect of the Account Management Service 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 shows 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 shows 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 204 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
-------
...
SLOVENSKI STANDARD
SIST ES 204 915-11 V1.1.1:2008
01-september-2008
2GSUWLGRVWRSGRVWRULWYH 26$ $SOLNDFLMVNLSURJUDPVNLYPHVQLN $3, GHO
/DVWQRVWVWRULWYHQH]PRåQRVWL 6&) ]DXSUDYOMDQMHREUDþXQD 3DUOD\
Open Service Access (OSA) - Application Programming Interface (API) - Part 11:
Account Management SCF (Parlay 6)
Ta slovenski standard je istoveten z: ES 204 915-11 Version 1.1.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
SIST ES 204 915-11 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-11 V1.1.1:2008
---------------------- Page: 2 ----------------------
SIST ES 204 915-11 V1.1.1:2008
ETSI ES 204 915-11 V1.1.1 (2008-05)
ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 11: Account Management SCF
(Parlay 6)
�
---------------------- Page: 3 ----------------------
SIST ES 204 915-11 V1.1.1:2008
2 ETSI ES 204 915-11 V1.1.1 (2008-05)
Reference
DES/TISPAN-01032-11-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-11 V1.1.1:2008
3 ETSI ES 204 915-11 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 Account Management SCF .8
4.1 General requirements on support of methods.8
5 Sequence Diagrams.9
5.1 Standard Voucher Handling .9
5.2 Standard Transaction History Retrieval .10
5.3 Standard Query Handling.11
5.4 Standard Notification handling.12
5.5 Network Controlled Notifications .13
6 Class Diagrams.14
7 The Service Interface Specifications.15
7.1 Interface Specification Format .15
7.1.1 Interface Class.15
7.1.2 Method descriptions.16
7.1.3 Parameter descriptions.16
7.1.4 State Model.16
7.2 Base Interface.16
7.2.1 Interface Class IpInterface .16
7.3 Service Interfaces.16
7.3.1 Overview.16
7.4 Generic Service Interface .16
7.4.1 Interface Class IpService .16
7.4.1.1 Method setCallback().17
7.4.1.2 Method setCallbackWithSessionID().17
8 Account Management Interface Classes .18
8.1 Interface Class IpAccountManager .18
8.1.1 Method createNotification().18
8.1.2 Method destroyNotification().19
8.1.3 Method queryBalanceReq().19
8.1.4 Method changeNotification().20
8.1.5 Method getNotification().20
8.1.6 Method retrieveTransactionHistoryReq().20
8.1.7 Method enableNotifications().21
8.1.8 Method disableNotifications().21
8.1.9 Method queryBalanceExpiryDateReq().21
8.1.10 Method updateBalanceReq().22
8.1.11 Method createVoucherReq().22
8.1.12 Method destroyVoucherReq().23
8.1.13 Method queryVoucherReq().23
8.1.14 Method queryUserVouchersReq().23
8.2 Interface Class IpAppAccountManager .24
8.2.1 Method reportNotification().25
8.2.2 Method queryBalanceRes().25
8.2.3 Method queryBalanceErr().25
8.2.4 Method retrieveTransactionHistoryRes().25
ETSI
---------------------- Page: 5 ----------------------
SIST ES 204 915-11 V1.1.1:2008
4 ETSI ES 204 915-11 V1.1.1 (2008-05)
8.2.5 Method retrieveTransactionHistoryErr().26
8.2.6 Method queryBalanceExpiryDateRes().26
8.2.7 Method queryBalanceExpiryDateErr().26
8.2.8 Method updateBalanceRes().26
8.2.9 Method updateBalanceErr().27
8.2.10 Method createVoucherRes().27
8.2.11 Method createVoucherErr().27
8.2.12 Method destroyVoucherRes().27
8.2.13 Method destroyVoucherErr().28
8.2.14 Method queryVoucherRes().28
8.2.15 Method queryVoucherErr().28
8.2.16 Method queryUserVouchersRes().28
8.2.17 Method queryUserVouchersErr().29
9 State Transition Diagrams.29
9.1 State Transition Diagrams for IpAccountManager.29
9.1.1 Active State.29
9.1.2 Notifications created State .30
10 Account Management Service Properties .30
11 Data Definitions.30
11.1 Account Management Data Definitions .30
11.1.1 IpAppAccountManager .31
11.1.2 IpAppAccountManagerRef.31
11.1.3 IpAccountManager.31
11.1.4 IpAccountManagerRef.31
11.1.5 TpBalanceQueryError.31
11.1.6 TpChargingEventName.31
11.1.7 TpBalanceInfo.32
11.1.8 TpChargingEventInfo.32
11.1.9 TpChargingEventCriteria.33
11.1.10 TpChargingEventNameSet.33
11.1.11 TpChargingEventCriteriaResult.33
11.1.12 TpChargingEventCriteriaResultSet.33
11.1.13 TpBalance.33
11.1.14 TpBalanceSet.33
11.1.15 TpTransactionHistory.33
11.1.16 TpTransactionHistorySet.34
11.1.17 TpTransactionHistoryStatus.34
11.1.18 TpBalanceExpiryDate.34
11.1.19 TpBalanceExpiryDateSet.34
11.1.20 TpVoucherError.34
11.1.21 TpVoucher .34
11.1.22 TpVoucherSet.35
12 Exception Classes.35
Annex A (normative): OMG IDL Description of Account Management SCF .36
Annex B (informative): W3C WSDL Description of Account Management SCF.37
Annex C (informative): Java™ API Description of the Account Management SCF .38
Annex D (informative): Contents of 3GPP OSA Rel-7 Account Management.39
Annex E (informative): Description of Account Management for 3GPP2 cdma2000 networks.40
E.1 General Exceptions.40
E.2 Specific Exceptions.40
E.2.1 Clause 1: Scope .40
E.2.2 Clause 2: References .40
E.2.3 Clause 3: Definitions and abbreviations.40
ETSI
---------------------- Page: 6 ----------------------
SIST ES 204 915-11 V1.1.1:2008
5 ETSI ES 204 915-11 V1.1.1 (2008-05)
E.2.4 Clause 4: Account Management SCF.40
E.2.5 Clause 5: Sequence Diagrams .40
E.2.6 Clause 6: Class Diagrams.40
E.2.7 Clause 7: The Service Interface Specifications .40
E.2.8 Clause 8: Account Management Interface Classes.41
E.2.9 Clause 9: State Transition Diagrams .41
E.2.10 Clause 10: Account Management Service Properties.41
E.2.11 Clause 11: Data Definitions.41
E.2.12 Clause 12: Exception Classes.41
E.2.13 Annex A (normative): OMG IDL Description of Account Management SCF.41
E.2.14 Annex B (informative): W3C WSDL Description of Account Management SCF.41
Annex F (informative): Record of changes .42
F.1 Interfaces.42
F.1.1 New.42
F.1.2 Deprecated.42
F.1.3 Removed.42
F.2 Methods.42
F.2.1 New.42
F.2.2 Deprecated.42
F.2.3 Modified.43
F.2.4 Removed.43
F.3 Data Definitions.43
F.3.1 New.43
F.3.2 Modified.43
F.3.3 Removed.43
F.4 Service Properties.43
F.4.1 New.43
F.4.2 Deprecated.44
F.4.3 Modified.44
F.4.4 Removed.44
F.5 Exceptions.44
F.5.1 New.44
F.5.2 Modified.44
F.5.3 Removed.44
F.6 Others.44
History .45
ETSI
---------------------- Page: 7 ----------------------
SIST ES 204 915-11 V1.1.1:2008
6 ETSI ES 204 915-11 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 11 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-11 V7.0.0 (Release 7).
ETSI
---------------------- Page: 8 ----------------------
SIST ES 204 915-11 V1.1.1:2008
7 ETSI ES 204 915-11 V1.1.1 (2008-05)
1 Scope
The present document is part 11 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 Account Management Service Capability Feature (SCF) aspects of the interface. All
aspects of the Account Management 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 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.
ETSI
---------------------- Page: 9 ----------------------
SIST ES 204 915-11 V1.1.1:2008
8 ETSI ES 204 915-11 V1.1.1 (2008-05)
4 Account Management SCF
The following clauses describe each aspect of the Account Management Service 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 shows 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.
•
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.