|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.ws.webservices.engine.client.Stub
com.ibm.soa.parlayx21.account_management.AccountManagementBindingStub
public class AccountManagementBindingStub
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.ibm.ws.webservices.engine.client.Stub |
---|
com.ibm.ws.webservices.engine.client.Stub.Invoke |
Field Summary |
---|
Fields inherited from class com.ibm.ws.webservices.engine.client.Stub |
---|
cachedEndpoint, cachedhttpProxyHost, cachedhttpProxyPassword, cachedhttpProxyPort, cachedhttpProxyUser, cachedhttpRedirectEnabled, cachedhttpsProxyHost, cachedhttpsProxyPassword, cachedhttpsProxyPort, cachedhttpsProxyUser, cachedPassword, cachedPortName, cachedProperties, cachedRequestSoapHeaders, cachedRequestTransportHeaders, cachedResponseSoapHeaders, cachedResponseSoapHeaderTemplates, cachedResponseTransportHeaders, cachedResponseTransportHeadersTemplate, cachedSessionContext, cachedsslCfgName, cachedTimeout, cachedUsername, cachedWriteTimeout, connection, engine, maintainSession, maintainSessionSet, messageContexts, service |
Fields inherited from interface javax.xml.rpc.Stub |
---|
ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY |
Constructor Summary | |
---|---|
AccountManagementBindingStub(java.net.URL endpointURL,
javax.xml.rpc.Service service)
|
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. |
Methods inherited from class com.ibm.ws.webservices.engine.client.Stub |
---|
_getProperty, _getPropertyNames, _setProperty, convert, getPassword, getPortName, getTimeout, getTypeMapping, getUsername, primeMessageContext, setMaintainSession, setPassword, setPortName, setPortName, setTimeout, setUsername, setWriteTimeout, validateSoapHeadersHashMap, validateTransportPropertiesHashMap |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AccountManagementBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service) throws com.ibm.ws.webservices.engine.WebServicesFault
com.ibm.ws.webservices.engine.WebServicesFault
Method Detail |
---|
public Balance[] getBalance(java.net.URI endUserIdentifier, java.lang.String endUserPin) throws java.rmi.RemoteException, PolicyException, ServiceException
AccountManagement
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.
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.
getBalance
in interface AccountManagement
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
It is a set of Balance records, where each record specifies a balance type and the associated amount.
java.rmi.RemoteException
PolicyException
ServiceException
public BalanceExpireDetails[] getCreditExpiryDate(java.net.URI endUserIdentifier, java.lang.String endUserPin) throws java.rmi.RemoteException, PolicyException, ServiceException
AccountManagement
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.
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.
getCreditExpiryDate
in interface AccountManagement
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.
It is a set of records, where each record specifies a balance type and the associated date that the balance will expire.
java.rmi.RemoteException
PolicyException
ServiceException
public 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
AccountManagement
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.
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.
balanceUpdate
in interface AccountManagement
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.
java.rmi.RemoteException
PolicyException
ServiceException
public 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
AccountManagement
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.
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.
voucherUpdate
in interface AccountManagement
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.
java.rmi.RemoteException
PolicyException
ServiceException
public DatedTransaction[] getHistory(java.net.URI endUserIdentifier, java.lang.String endUserPin, java.util.Calendar date, java.lang.Integer maxEntries) throws java.rmi.RemoteException, PolicyException, ServiceException
AccountManagement
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.
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
getHistory
in interface AccountManagement
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.
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.
java.rmi.RemoteException
PolicyException
ServiceException
public java.lang.String[] getBalanceTypes(java.net.URI endUserIdentifier, java.lang.String endUserPin) throws java.rmi.RemoteException, PolicyException, ServiceException
AccountManagement
This operation results in getting a set of valid account balance types per account.
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.
getBalanceTypes
in interface AccountManagement
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
java.rmi.RemoteException
PolicyException
ServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |