net.dreceiptx.client

Interface ExchangeClient

All Known Implementing Classes:

DRXClient

public interface ExchangeClient

Method Summary

Modifier and Type	Method and Description
boolean	downloadReceiptPDF(java.lang.String receiptId)
Merchant	lookupMerchant(java.lang.String Id)
DigitalReceipt	lookupReceipt(java.lang.String receiptId)
java.util.Map<java.lang.String,NewUserRegistrationResult>	registerNewUser(java.util.List<NewUser> newUsers)
NewUserRegistrationResult	registerNewUser(NewUser newUser)
User	searchUser(UserIdentifierType identifierType, java.lang.String identifier)
Users	searchUsers(UserIdentifierType identifierType, java.util.ArrayList<java.lang.String> userIdentifiers)
java.lang.String	sendDryRunReceipt(ReceiptPostRequest receiptPostRequest)
java.lang.String	sendProductionReceipt(ReceiptPostRequest receiptPostRequest)

Method Detail

searchUser

User searchUser(UserIdentifierType identifierType,
                java.lang.String identifier)
         throws ExchangeClientException,
                java.io.UnsupportedEncodingException

Parameters:

identifierType - UserIdentifierType

identifier - String

Returns:

The matching users will be returned if it is found otherwise null

Throws:

ExchangeClientException - will be thrown if problem calling the service.

java.io.UnsupportedEncodingException - will be thrown if problem calling the service.

searchUsers

Users searchUsers(UserIdentifierType identifierType,
                  java.util.ArrayList<java.lang.String> userIdentifiers)
           throws ExchangeClientException

Parameters:

identifierType - UserIdentifierType

userIdentifiers - list of user identifiers

Returns:

The matching users will be returned if it is found otherwise null

Throws:

ExchangeClientException - will be thrown if problem calling the service.

sendProductionReceipt

java.lang.String sendProductionReceipt(ReceiptPostRequest receiptPostRequest)
                                throws ExchangeClientException

Parameters:

receiptPostRequest - ReceiptPostRequest

Returns:

transactionId

Throws:

ExchangeClientException - will be thrown if problem calling the service.

sendDryRunReceipt

java.lang.String sendDryRunReceipt(ReceiptPostRequest receiptPostRequest)
                            throws ExchangeClientException

Parameters:

receiptPostRequest - ReceiptPostRequest

Returns:

transactionId

Throws:

ExchangeClientException - will be thrown if problem calling the service.

registerNewUser

NewUserRegistrationResult registerNewUser(NewUser newUser)
                                   throws ExchangeClientException

Parameters:

newUser - NewUser

Returns:

newUserRegistrationResult

Throws:

ExchangeClientException - will be thrown if problem calling the service.

registerNewUser

java.util.Map<java.lang.String,NewUserRegistrationResult> registerNewUser(java.util.List<NewUser> newUsers)
                                                                   throws ExchangeClientException

Parameters:

newUsers - list of users to be registered

Returns:

map of userid to NewUserRegistrationResult

Throws:

ExchangeClientException - will be thrown if problem calling the service.

lookupReceipt

DigitalReceipt lookupReceipt(java.lang.String receiptId)
                      throws ExchangeClientException

Parameters:

receiptId - String

Returns:

DigitalReceipt

Throws:

ExchangeClientException - will be thrown if problem calling the service.

downloadReceiptPDF

boolean downloadReceiptPDF(java.lang.String receiptId)
                    throws ExchangeClientException

Parameters:

receiptId - String

Returns:

boolean

Throws:

ExchangeClientException - will be thrown if problem calling the service.

lookupMerchant

Merchant lookupMerchant(java.lang.String Id)
                 throws ExchangeClientException

Parameters:

Id - String

Returns:

Merchant

Throws:

ExchangeClientException - will be thrown if problem calling the service.