|
||||||||||
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.payment.VolumeChargingBindingStub
public class VolumeChargingBindingStub
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 | |
---|---|
VolumeChargingBindingStub(java.net.URL endpointURL,
javax.xml.rpc.Service service)
|
Method Summary | |
---|---|
void |
chargeVolume(java.net.URI endUserIdentifier,
long volume,
java.lang.String billingText,
java.lang.String referenceCode,
Property[] parameters)
This operation results in directly charging to the account indicated by the end user identifier. |
ChargingInformation |
getAmount(java.net.URI endUserIdentifier,
long volume,
Property[] parameters)
This operation results in converting the given volume to a currency amount. |
void |
refundVolume(java.net.URI endUserIdentifier,
long volume,
java.lang.String billingText,
java.lang.String referenceCode,
Property[] parameters)
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 |
---|
public VolumeChargingBindingStub(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 void chargeVolume(java.net.URI endUserIdentifier, long volume, java.lang.String billingText, java.lang.String referenceCode, Property[] parameters) throws java.rmi.RemoteException, PolicyException, ServiceException
VolumeCharging
This operation results in directly charging to the account indicated by the end user identifier. The charge is specified as a volume. 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.
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
* SVC0270 - Charge failed.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
chargeVolume
in interface VolumeCharging
endUserIdentifier
- xsd:anyURI
The end user's account to be chargedvolume
- xsd:long
The volume to be chargedbillingText
- xsd:string
Textual information to appear on the billreferenceCode
- xsd:string
Textual information to uniquely identify the request, for example, in case of disputesparameters
- Property [0..unbounded]
Parameters to use to perform rating (“unit”, “contract”, “service”, “operation”)
java.rmi.RemoteException
PolicyException
ServiceException
public ChargingInformation getAmount(java.net.URI endUserIdentifier, long volume, Property[] parameters) throws java.rmi.RemoteException, PolicyException, ServiceException
VolumeCharging
This operation results in converting the given volume to a currency amount. The end user identifier is given to indicate the subscriber for whom this conversion calculation must be made. The message returns a currency amount if successful.
The following properties may be provided:
* unit, specifying the unit used for measuring volume (for example, bytes);
* contract, number of a contract that may govern the use;
* service, name of the service to be used (for example, SendMessageService);
* operation, name of the operation to be used (for example, sendMessage).
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
getAmount
in interface VolumeCharging
endUserIdentifier
- xsd:anyURI
The end user's account to be chargedvolume
- xsd:long
The volume to be convertedparameters
- Property [0..unbounded]
Parameters to use to perform rating ('unit', 'contract', 'service', 'operation')
The conversion process results in the return of a ChargingInformation structure, where the description, amount and currency elements must be non-null.
java.rmi.RemoteException
PolicyException
ServiceException
public void refundVolume(java.net.URI endUserIdentifier, long volume, java.lang.String billingText, java.lang.String referenceCode, Property[] parameters) throws java.rmi.RemoteException, PolicyException, ServiceException
VolumeCharging
This operation results in directly applying a refund to the account indicated by the end user identifier. The refund is specified as a volume. 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.
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
* SVC0270 - Charge failed.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
refundVolume
in interface VolumeCharging
endUserIdentifier
- xsd:anyURI
The end user's account to be refundedvolume
- xsd:long
The volume to be refundedbillingText
- xsd:string
Textual information to appear on the billreferenceCode
- xsd:string
Textual information to uniquely identify the request, for example, in case of disputesparameters
- Property [0..unbounded]
Parameters to use to perform rating (“unit”, “contract”, “service”, “operation”)
java.rmi.RemoteException
PolicyException
ServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |