com.ibm.soa.parlayx21.account_management
Interface AccountManagement

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
AccountManagement_RI
All Known Implementing Classes:
AccountManagementBindingStub, AccountManagementProxy

public interface AccountManagement
extends java.rmi.Remote

The Account Management interface provides access to account information for update and query operations.


Method Summary
 void balanceUpdate(java.net.URI endUserIdentifier, java.lang.String endUserPin, java.lang.String referenceCode, java.lang.String balanceType, java.math.BigDecimal amount, java.lang.Integer period)
          This message results in directly recharging the account indicated by the end user identifier and optional associated end user PIN.
 Balance[] getBalance(java.net.URI endUserIdentifier, java.lang.String endUserPin)
          This message results in getting account balances indicated by the end user identifier and associated end user PIN.
 java.lang.String[] getBalanceTypes(java.net.URI endUserIdentifier, java.lang.String endUserPin)
          This operation results in getting a set of valid account balance types per account.
 BalanceExpireDetails[] getCreditExpiryDate(java.net.URI endUserIdentifier, java.lang.String endUserPin)
          This message results in getting the expiration date of the credit indicated by the end user identifier and associated end user PIN.
 DatedTransaction[] getHistory(java.net.URI endUserIdentifier, java.lang.String endUserPin, java.util.Calendar date, java.lang.Integer maxEntries)
          This message results in returning the transaction history of the account indicated by the end user identifier and associated optional end user PIN.
 void voucherUpdate(java.net.URI endUserIdentifier, java.lang.String endUserPin, java.lang.String referenceCode, java.lang.String voucherIdentifier, java.lang.String voucherPin)
          This message results in directly recharging the account indicated by the end user identifier and optional associated end user PIN.
 

Method Detail

getBalance

Balance[] getBalance(java.net.URI endUserIdentifier,
                     java.lang.String endUserPin)
                     throws java.rmi.RemoteException,
                            PolicyException,
                            ServiceException

This message results in getting account balances indicated by the end user identifier and associated end user PIN. The returned amount for each balance is specified as a currency amount.

End users accounts may have a single balance for all usage, or may have multiple balances for different uses. For example, an end user may have a separate balance for voice calls, SMS messages, and GPRS usage.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.
  * SVC0250 - End user authentication failed.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.

Parameters:
endUserIdentifier - xsd:anyURI

This parameter identifies the end user's account.

endUserPin - xsd:string Contains the end user's credentials for authorizing access to the account
Returns:
resultbalance Balance [1.. unbounded]

It is a set of Balance records, where each record specifies a balance type and the associated amount.

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getCreditExpiryDate

BalanceExpireDetails[] getCreditExpiryDate(java.net.URI endUserIdentifier,
                                           java.lang.String endUserPin)
                                           throws java.rmi.RemoteException,
                                                  PolicyException,
                                                  ServiceException

This message results in getting the expiration date of the credit indicated by the end user identifier and associated end user PIN. The returned date is the date the current balance will expire. Nil is returned if the balance does not expire.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.
  * SVC0250 - End user authentication failed.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.

Parameters:
endUserIdentifier - xsd:anyURI

This parameter identifies the end user's account.

endUserPin - xsd:string

Contains the end user's credentials for authorizing access to the account.

Returns:
resultbalanceExpireDetails BalanceExpireDetails [1.. unbounded]

It is a set of records, where each record specifies a balance type and the associated date that the balance will expire.

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

balanceUpdate

void balanceUpdate(java.net.URI endUserIdentifier,
                   java.lang.String endUserPin,
                   java.lang.String referenceCode,
                   java.lang.String balanceType,
                   java.math.BigDecimal amount,
                   java.lang.Integer period)
                   throws java.rmi.RemoteException,
                          PolicyException,
                          ServiceException

This message results in directly recharging the account indicated by the end user identifier and optional associated end user PIN. The reference code is used to uniquely identify the request; it is the application's responsibility to provide a unique reference code within the scope of the application. The charge is specified as a currency amount. The balance is requested to expire in the number of days indicated by the period parameter. The operator's policies may overrule this parameter. If the optional period parameter is not present, the operator's policy on balance expiration is always in effect.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.
  * SVC0250 - End user authentication failed.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.

Parameters:
endUserIdentifier - xsd:anyURI

This parameter identifies the end user's account.

endUserPin - xsd:string

Contains the end user's credentials for authorizing access to the account.

referenceCode - xsd:string

Textual information to uniquely identify the request, e.g. in case of disputes.

balanceType - xsd:string Identifies the type of balance. End user accounts may have one or more balances for different types of usage (e.g. Voice, SMS, gaming etc)
amount - xsd:decimal

Currency amount that should be added to the end user's account.

period - xsd:int

The balance is requested to expire in the number of days indicated by this parameter. The operator's policies may overrule this parameter. If this optional parameter is not present, the operator's policy on balance expiration is always in effect.

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

voucherUpdate

void voucherUpdate(java.net.URI endUserIdentifier,
                   java.lang.String endUserPin,
                   java.lang.String referenceCode,
                   java.lang.String voucherIdentifier,
                   java.lang.String voucherPin)
                   throws java.rmi.RemoteException,
                          PolicyException,
                          ServiceException

This message results in directly recharging the account indicated by the end user identifier and optional associated end user PIN. The reference code is used to uniquely identify the request; it is the application's responsibility to provide a unique reference code within the scope of the application. A voucher identifier indirectly specifies the charge. The optional voucher PIN code can be used to verify the voucher.

Referenced Faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.
  * SVC0250 - End user authentication failed.
  * SVC0251 - Unknown voucher.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.
  * POL0220 - Vouchers not accepted.

Parameters:
endUserIdentifier - xsd:anyURI

This parameter identifies the end user's account.

endUserPin - xsd:string

Contains the end user's credentials for authorizing access to the account.

referenceCode - xsd:string

Textual information to uniquely identify the request, e.g. in case of disputes.

voucherIdentifier - xsd:string

This parameter identifies the voucher.

voucherPin - xsd:string

Contains the voucher's credentials for authentication.

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getHistory

DatedTransaction[] getHistory(java.net.URI endUserIdentifier,
                              java.lang.String endUserPin,
                              java.util.Calendar date,
                              java.lang.Integer maxEntries)
                              throws java.rmi.RemoteException,
                                     PolicyException,
                                     ServiceException

This message results in returning the transaction history of the account indicated by the end user identifier and associated optional end user PIN. The maximum number of entries to return and the start date define the range of transactions that are of interest to the requester.

If the total number of entries in the transaction history, starting at the specified date, is larger than the specified maximum number of entries, only the most recent events are returned. Note that the operator might limit the maximum amount of entries to be returned or the period for which the entries are to be returned.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.

Parameters:
endUserIdentifier - xsd:anyURI

This parameter identifies the end user's account.

endUserPin - xsd:string

Contains the end user's credentials for authorizing access to the account.

date - xsd:dateTime

This parameter indicates the desired starting date for the entries to be returned. If this parameter is not present, it is up to the discretion of the service to decide this date.

maxEntries - xsd:int

This parameter indicates the maximum number of entries that shall be returned. If this parameter is not present, it is up to the discretion of the service to decide how many entries to return.

Returns:
resulthistory DatedTransaction [0 .. unbounded]

It is a DatedTransaction array that consists of types with a date field and a string field: i.e. the date of the occurrence and the transaction details, respectively.

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getBalanceTypes

java.lang.String[] getBalanceTypes(java.net.URI endUserIdentifier,
                                   java.lang.String endUserPin)
                                   throws java.rmi.RemoteException,
                                          PolicyException,
                                          ServiceException

This operation results in getting a set of valid account balance types per account.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.
  * SVC0250 - End user authentication failed.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.

Parameters:
endUserIdentifier - xsd:anyURI

This parameter identifies the end user's account.

endUserPin - xsd:string Contains the end user's credentials for authorizing access to the account
Returns:
resultbalanceTypes xsd:string [1.. unbounded] Identifies the types of balance. End user accounts may have one or more balances for different types of usage (e.g Voice, SMS, gaming etc)
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.