aboutsummaryrefslogtreecommitdiffstats
path: root/idl/parlay/am.idl
blob: d725935ab4cb01de6c6113c0ff7861f36d0c8d74 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
//Source file: am.idl
//Date:  12 October 2004
//Account Manager Interfaces and Data Types for ETSI ES 203 915-11 V1.1.1, DES/TISPAN-01005-11-OSA, Parlay 5.0


#ifndef __AM_DEFINED
#define __AM_DEFINED


#include "osa.idl"

module org {
	
	module csapi {
		
		module am {
			
			
			enum TpChargingEventName {

				P_AM_CHARGING,
				P_AM_RECHARGING,
				P_AM_ACCOUNT_LOW,
				P_AM_ACCOUNT_ZERO,
				P_AM_ACCOUNT_DISABLED				
			};
			
			
			enum TpBalanceQueryError {

				P_BALANCE_QUERY_OK,
				P_BALANCE_QUERY_ERROR_UNDEFINED,
				P_BALANCE_QUERY_UNKNOWN_SUBSCRIBER,
				P_BALANCE_QUERY_UNAUTHORIZED_APPLICATION,
				P_BALANCE_QUERY_SYSTEM_FAILURE				
			};
			
			
			struct TpBalanceInfo {
				TpString Currency;
				TpInt32 ValuePartA;
				TpInt32 ValuePartB;
				TpInt32 Exponent;
				TpString AdditionalInfo;
			};
			
			
			struct TpChargingEventInfo {
				TpChargingEventName ChargingEventName;
				TpBalanceInfo CurrentBalanceInfo;
				TpTime ChargingEventTime;
			};
			
			
			struct TpBalance {
				TpAddress UserID;
				TpBalanceQueryError StatusCode;
				TpBalanceInfo BalanceInfo;
			};
			
			
			typedef sequence <TpBalance> TpBalanceSet;
			
			
			struct TpTransactionHistory {
				TpAssignmentID TransactionID;
				TpDateAndTime TimeStamp;
				TpString AdditionalInfo;
			};
			
			
			typedef sequence <TpTransactionHistory> TpTransactionHistorySet;
			
			
			enum TpTransactionHistoryStatus {

				P_AM_TRANSACTION_ERROR_UNSPECIFIED,
				P_AM_TRANSACTION_INVALID_INTERVAL,
				P_AM_TRANSACTION_UNKNOWN_ACCOUNT,
				P_AM_TRANSACTION_UNAUTHORIZED_APPLICATION,
				P_AM_TRANSACTION_PROCESSING_ERROR,
				P_AM_TRANSACTION_SYSTEM_FAILURE				
			};
			
			
			typedef sequence <TpChargingEventName> TpChargingEventNameSet;
			
			
			struct TpChargingEventCriteria {
				TpChargingEventNameSet ChargingEvents;
				TpAddressSet Users;
			};
			
			
			struct TpChargingEventCriteriaResult {
				TpChargingEventCriteria ChargingEventCriteria;
				TpAssignmentID AssignmentID;
			};
			
			
			exception P_UNAUTHORIZED_APPLICATION {
				TpString ExtraInformation;
			};
			
			
			typedef sequence <TpChargingEventCriteriaResult> TpChargingEventCriteriaResultSet;
			
			
			struct TpBalanceExpiryDate {
				TpAddress UserID;
				TpBalanceQueryError StatusCode;
				TpDateAndTime ExpiryDate;
			};
			
			
			typedef sequence <TpBalanceExpiryDate> TpBalanceExpiryDateSet;
			
			
			enum TpVoucherError {

				P_VOUCHER_OK,
				P_VOUCHER_UNDEFINED,
				P_VOUCHER_UNKNOWN_SUBSCRIBER,
				P_VOUCHER_UNAUTHORIZED_APPLICATION,
				P_VOUCHER_SYSTEM_FAILURE				
			};
			
			
			struct TpVoucher {
				TpAssignmentID VoucherID;
				TpAddress UserID;
				TpBalanceInfo BalanceInfo;
			};
			
			
			typedef sequence <TpVoucher> TpVoucherSet;
			

			
			interface IpAppAccountManager : IpInterface {
				void reportNotification (
					in TpChargingEventInfo chargingEventInfo,	
					in TpAssignmentID assignmentId	
					);
					
				void queryBalanceRes (
					in TpAssignmentID queryId,	
					in TpBalanceSet balances	
					);
					
				void queryBalanceErr (
					in TpAssignmentID queryId,	
					in TpBalanceQueryError cause	
					);
					
				void retrieveTransactionHistoryRes (
					in TpAssignmentID retrievalID,	
					in TpTransactionHistorySet transactionHistory	
					);
					
				void retrieveTransactionHistoryErr (
					in TpAssignmentID retrievalID,	
					in TpTransactionHistoryStatus transactionHistoryError	
					);
					
				void queryBalanceExpiryDateRes (
					in TpAssignmentID queryId,	
					in TpBalanceExpiryDateSet dates	
					);
					
				void queryBalanceExpiryDateErr (
					in TpAssignmentID queryId,	
					in TpBalanceQueryError cause	
					);
					
				void updateBalanceRes (
					in TpAssignmentID requestId,	
					in TpBalance balance	
					);
					
				void updateBalanceErr (
					in TpAssignmentID requestId,	
					in TpBalanceQueryError cause	
					);
					
				void createVoucherRes (
					in TpAssignmentID requestId,	
					in TpAssignmentID voucherId	
					);
					
				void createVoucherErr (
					in TpAssignmentID requestId,	
					in TpVoucherError cause	
					);
					
				void destroyVoucherRes (
					in TpAssignmentID requestId,	
					in TpAssignmentID voucherId	
					);
					
				void destroyVoucherErr (
					in TpAssignmentID requestId,	
					in TpAssignmentID voucherId,	
					in TpVoucherError cause	
					);
					
				void queryVoucherRes (
					in TpAssignmentID queryId,	
					in TpVoucher voucher	
					);
					
				void queryVoucherErr (
					in TpAssignmentID queryId,	
					in TpAssignmentID voucherId,	
					in TpVoucherError cause	
					);
					
				void queryUserVouchersRes (
					in TpAssignmentID queryId,	
					in TpVoucherSet vouchers	
					);
					
				void queryUserVouchersErr (
					in TpAssignmentID queryId,	
					in TpVoucherError cause	
					);
					
			};
			
			
			interface IpAccountManager : IpService {
				TpAssignmentID createNotification (
					in IpAppAccountManager appAccountManager,	
					in TpChargingEventCriteria chargingEventCriteria	
					)					
					raises (TpCommonExceptions,P_INVALID_ADDRESS,P_INVALID_CRITERIA,P_INVALID_EVENT_TYPE,P_UNKNOWN_SUBSCRIBER);
					
				void destroyNotification (
					in TpAssignmentID assignmentId	
					)					
					raises (TpCommonExceptions,P_INVALID_ASSIGNMENT_ID);
					
				TpAssignmentID queryBalanceReq (
					in TpAddressSet users	
					)					
					raises (TpCommonExceptions,P_UNKNOWN_SUBSCRIBER,P_UNAUTHORIZED_APPLICATION);
					
				void changeNotification (
					in TpAssignmentID assignmentID,	
					in TpChargingEventCriteria eventCriteria	
					)					
					raises (TpCommonExceptions,P_INVALID_ASSIGNMENT_ID,P_INVALID_CRITERIA,P_INVALID_EVENT_TYPE,P_UNKNOWN_SUBSCRIBER,P_INVALID_ADDRESS);
					
				TpChargingEventCriteriaResultSet getNotification ()					
					raises (TpCommonExceptions);
					
				TpAssignmentID retrieveTransactionHistoryReq (
					in TpAddress user,	
					in TpTimeInterval transactionInterval	
					)					
					raises (TpCommonExceptions,P_UNKNOWN_SUBSCRIBER,P_UNAUTHORIZED_APPLICATION,P_INVALID_TIME_AND_DATE_FORMAT);
					
				TpAssignmentID enableNotifications (
					in IpAppAccountManager appAccountManager	
					)					
					raises (TpCommonExceptions);
					
				void disableNotifications ()					
					raises (TpCommonExceptions);
					
				TpAssignmentID queryBalanceExpiryDateReq (
					in TpAddressSet users	
					)					
					raises (TpCommonExceptions,P_UNKNOWN_SUBSCRIBER,P_UNAUTHORIZED_APPLICATION);
					
				TpAssignmentID updateBalanceReq (
					in TpAddress user,	
					in TpBoolean debit,	
					in TpBalanceInfo amount,	
					in TpInt32 period	
					)					
					raises (TpCommonExceptions, P_UNKNOWN_SUBSCRIBER, P_UNAUTHORIZED_APPLICATION);
					
				TpAssignmentID createVoucherReq (
					in TpAddress user,	
					in TpBalanceInfo amount	
					)					
					raises (TpCommonExceptions, P_UNKNOWN_SUBSCRIBER, P_UNAUTHORIZED_APPLICATION);
					
				TpAssignmentID destroyVoucherReq (
					in TpAssignmentID voucherId	
					)					
					raises (TpCommonExceptions, P_UNAUTHORIZED_APPLICATION, P_INVALID_ASSIGNMENT_ID);
					
				TpAssignmentID queryVoucherReq (
					in TpAssignmentID voucherId	
					)					
					raises (TpCommonExceptions, P_UNAUTHORIZED_APPLICATION, P_INVALID_ASSIGNMENT_ID);
					
				TpAssignmentID queryUserVouchersReq (
					in TpAddress user	
					)					
					raises (TpCommonExceptions, P_UNKNOWN_SUBSCRIBER, P_UNAUTHORIZED_APPLICATION, P_INVALID_ASSIGNMENT_ID);
					
			};
			
		};
		
	};
	
};

#endif