com.ibm.soa.parlayx21.payment
Class AmountChargingBindingStub

java.lang.Object
  extended by com.ibm.ws.webservices.engine.client.Stub
      extended by com.ibm.soa.parlayx21.payment.AmountChargingBindingStub
All Implemented Interfaces:
AmountCharging, java.rmi.Remote, javax.xml.rpc.Stub

public class AmountChargingBindingStub
extends com.ibm.ws.webservices.engine.client.Stub
implements AmountCharging


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
AmountChargingBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)
           
 
Method Summary
 void chargeAmount(java.net.URI endUserIdentifier, ChargingInformation charge, java.lang.String referenceCode)
          This operation results in directly charging to the account indicated by the end user identifier.
 void refundAmount(java.net.URI endUserIdentifier, ChargingInformation charge, java.lang.String referenceCode)
          This operation results in directly applying a refund to the account indicated by the end user identifier.
 
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

AmountChargingBindingStub

public AmountChargingBindingStub(java.net.URL endpointURL,
                                 javax.xml.rpc.Service service)
                          throws com.ibm.ws.webservices.engine.WebServicesFault
Throws:
com.ibm.ws.webservices.engine.WebServicesFault
Method Detail

chargeAmount

public void chargeAmount(java.net.URI endUserIdentifier,
                         ChargingInformation charge,
                         java.lang.String referenceCode)
                  throws java.rmi.RemoteException,
                         PolicyException,
                         ServiceException
Description copied from interface: AmountCharging

This operation results in directly charging to the account indicated by the end user identifier. The charge is specified as a ChargingInformation data structure, consisting of information on the amount to be charged and a description to appear on the bill. 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.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.
  * SVC0007 - Invalid charging information
  * SVC0270 - Charge failed.

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

Specified by:
chargeAmount in interface AmountCharging
Parameters:
endUserIdentifier - xsd:anyURI The end user's account to be charged
charge - common:ChargingInformation

Information on the charge to be made. In the ChargingInformation structure:
  * the description element is information to appear on the bill.
  * the amount to be charged appears either directly in the amount element or encoded in the code element. If both these elements are missing or empty, a service exception (SVC0007) will be thrown.
  * the optional currency element specifies the currency to be used for the charge.

referenceCode - xsd:string Textual information to uniquely identify the request, for example, in case of disputes
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

refundAmount

public void refundAmount(java.net.URI endUserIdentifier,
                         ChargingInformation charge,
                         java.lang.String referenceCode)
                  throws java.rmi.RemoteException,
                         PolicyException,
                         ServiceException
Description copied from interface: AmountCharging

This operation results in directly applying a refund to the account indicated by the end user identifier. The refund is specified as a currency amount. The billing text field is used for textual information to appear on the bill. 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.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.
  * SVC0007 - Invalid charging information
  * SVC0270 - Charge failed.

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

Specified by:
refundAmount in interface AmountCharging
Parameters:
endUserIdentifier - xsd:anyURI The end user's account to be refunded
charge - common:ChargingInformation

Information on the refund to be made. In the ChargingInformation structure:
  * the description element is information to appear on the bill.
  * the amount to be refunded appears either directly in the amount element or encoded in the code element. If both these elements are missing or empty, a service exception (SVC0007) will be thrown.
  * the optional currency element specifies the currency to be used for the refund.

referenceCode - xsd:string Textual information to uniquely identify the request, for example, in case of disputes
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.