com.ecebs.rtd.enabler
Interface ITransactionController

All Known Implementing Classes:
TransactionController

public interface ITransactionController

Provides methods for carrying out RTD operations.

Author:
kyleb

Method Summary
 void addStoredUse(AddStoredUseRequest product, DownloadMode mode, ITransactionControllerCallback callback)
          The DEDUCT JOURNEYS/PASSES function can be called by the APPLICATION to request the RTD SERVER deducts a number of stored passes from an ITSO TYP22 product, or a number of journeys from an ITSO TYP23 or TYP24 product.
 void addStrValue(AddSTRRequest product, DownloadMode mode, ITransactionControllerCallback callback)
          The ADD STR VALUE function can be called by the APPLICATION to request the RTD SERVER adds or credits value to the STR Product of the specified CM .
 void cancelRequest(String requestId, ITransactionControllerCallback listener)
          Cancels a previously registered request.
 void deductStoredUse(DeductStoredUseRequest product, DownloadMode mode, ITransactionControllerCallback callback)
          The ADD JOURNEYS/PASSES function can be called by the APPLICATION to request the RTD SERVER adds a number of stored passes to an ITSO TYP22 product, or a number of journeys to an ITSO TYP23 or TYP24 product.
 void deductStrValue(DeductSTRRequest product, DownloadMode mode, ITransactionControllerCallback callback)
          The DEDUCT STR VALUE function can be called by the APPLICATION to request the RTD SERVER deduct or debit value from the STR Product of the specified CM .
 void deleteProduct(DeleteProductRequest product, DownloadMode mode, ITransactionControllerCallback callback)
          The DELETE PRODUCT function is called by the APPLICATION to request the RTD SERVER deletes one or more products from the CM.
 void loadProduct(LoadProductRequest product, DownloadMode mode, ITransactionControllerCallback callback)
          The LOAD PRODUCT function is called by the application to request a Product from the RTD SERVER and load it onto the specified CM.
 void performPendingRequests(ITransactionControllerCallback callback)
          The PERFORM PENDING REQUESTS function is called by the application to download one or more previously requested product loads and/or modifications.
 void performPendingRequests(String cardId, CardType cardType, ITransactionControllerCallback callback)
          The PERFORM PENDING REQUESTS function is called by the application to download one or more previously requested product loads and/or modifications.
 void performPendingRequests(String requestId, ITransactionControllerCallback callback)
          The PERFORM PENDING REQUESTS function is called by the application to download one or more previously requested product loads and/or modifications.
 void performPendingRequests(String requestId, String cardId, CardType cardType, ITransactionControllerCallback callback)
          The PERFORM PENDING REQUESTS function is called by the application to download one or more previously requested product loads and/or modifications.
 void queryStatus(String id, QueryMode mode, ITransactionControllerCallback listener)
          Get details about the requests handled during the last download involving the CM with the specified Id
 void updatePassExpiryDate(UpdatePassExpiryDateRequest product, DownloadMode mode, ITransactionControllerCallback callback)
          The UPDATE PASS EXPIRY DATE function can be called by the APPLICATION to request the RTD SERVER updates the current pass expiry date of a ITSO TYP22 product.
 

Method Detail

addStoredUse

void addStoredUse(AddStoredUseRequest product,
                  DownloadMode mode,
                  ITransactionControllerCallback callback)
The DEDUCT JOURNEYS/PASSES function can be called by the APPLICATION to request the RTD SERVER deducts a number of stored passes from an ITSO TYP22 product, or a number of journeys from an ITSO TYP23 or TYP24 product.

Parameters:
product - An instance containing the details of the operation to be carried out
mode - Specifies what to do, i.e. just register, register and download, etc
callback - Callback used to inform the application on the progress of the operation

deductStoredUse

void deductStoredUse(DeductStoredUseRequest product,
                     DownloadMode mode,
                     ITransactionControllerCallback callback)
The ADD JOURNEYS/PASSES function can be called by the APPLICATION to request the RTD SERVER adds a number of stored passes to an ITSO TYP22 product, or a number of journeys to an ITSO TYP23 or TYP24 product.

Parameters:
product - An instance containing the details of the operation to be carried out
mode - Specifies what to do, i.e. just register, register and download, etc
callback - Callback used to inform the application on the progress of the operation

addStrValue

void addStrValue(AddSTRRequest product,
                 DownloadMode mode,
                 ITransactionControllerCallback callback)
The ADD STR VALUE function can be called by the APPLICATION to request the RTD SERVER adds or credits value to the STR Product of the specified CM . All of the communications between the RTD SERVER and CM are handled by the call to this function. The STR product to update will be specified by a Product Name, with any non-default or customer specific field values passed in the Product Data field. The Product Name is scheme specific. Conversion from the Product Name to product instantiation is performed by the RTD SERVER.

Parameters:
product - An instance containing the details of the operation to be carried out
mode - Specifies what to do, i.e. just register, register and download, etc
callback - Callback used to inform the application on the progress of the operation

deductStrValue

void deductStrValue(DeductSTRRequest product,
                    DownloadMode mode,
                    ITransactionControllerCallback callback)
The DEDUCT STR VALUE function can be called by the APPLICATION to request the RTD SERVER deduct or debit value from the STR Product of the specified CM . All of the communications between the RTD SERVER and CM are handled by the call to this function. The STR product to update will be specified by a Product Name, with any non-default or customer specific field values passed in the Product Data field. The Product Name is scheme specific. Conversion from the Product Name to product instantiation is performed by the RTD SERVER.

Parameters:
product - An instance containing the details of the operation to be carried out
mode - Specifies what to do, i.e. just register, register and download, etc
callback - Callback used to inform the application on the progress of the operation

deleteProduct

void deleteProduct(DeleteProductRequest product,
                   DownloadMode mode,
                   ITransactionControllerCallback callback)
The DELETE PRODUCT function is called by the APPLICATION to request the RTD SERVER deletes one or more products from the CM.

Parameters:
product - An instance containing the details of the operation to be carried out
mode - Specifies what to do, i.e. just register, register and download, etc
callback - Callback used to inform the application on the progress of the operation

loadProduct

void loadProduct(LoadProductRequest product,
                 DownloadMode mode,
                 ITransactionControllerCallback callback)
The LOAD PRODUCT function is called by the application to request a Product from the RTD SERVER and load it onto the specified CM. All of the communications between the RTD SERVER and CM are handled by the call to this function. The product to load will be specified by a Product Name, with any non-default or customer specific field values passed in the Product Data parameter. The Product Name is scheme specific, and may be something like "Single Journey" or "Season Ticket". Conversion from the Product Name to product instantiation is performed by the RTD SERVER. Examples of the specific customer field values could be Expiry Date, Product Cost or Journey Start and End Locations.

Parameters:
product - An instance containing the details of the operation to be carried out
mode - Specifies what to do, i.e. just register, register and download, etc
callback - Callback used to inform the application on the progress of the operation

updatePassExpiryDate

void updatePassExpiryDate(UpdatePassExpiryDateRequest product,
                          DownloadMode mode,
                          ITransactionControllerCallback callback)
The UPDATE PASS EXPIRY DATE function can be called by the APPLICATION to request the RTD SERVER updates the current pass expiry date of a ITSO TYP22 product. This function will update the ExpiryDateCurrent field (not the EXP field) in the ITSO TYP22 product.

Parameters:
product - An instance containing the details of the operation to be carried out
mode - Specifies what to do, i.e. just register, register and download, etc
callback - Callback used to inform the application on the progress of the operation

performPendingRequests

void performPendingRequests(ITransactionControllerCallback callback)
The PERFORM PENDING REQUESTS function is called by the application to download one or more previously requested product loads and/or modifications. The card holder may have previously ordered the product from a retailing website and is using this terminal to collect the product. In the case the terminal can only request all products pending for the CM to be loaded and/or modified.

Parameters:
callback - Callback used to inform the application on the progress of the operation

performPendingRequests

void performPendingRequests(String requestId,
                            ITransactionControllerCallback callback)
The PERFORM PENDING REQUESTS function is called by the application to download one or more previously requested product loads and/or modifications. The card holder may have previously ordered the product from a retailing website and is using this terminal to collect the product. In the case the terminal can only request all products pending for the CM to be loaded and/or modified.

Parameters:
requestId - ID of a specific request that should be completed
callback - Callback used to inform the application on the progress of the operation

performPendingRequests

void performPendingRequests(String cardId,
                            CardType cardType,
                            ITransactionControllerCallback callback)
The PERFORM PENDING REQUESTS function is called by the application to download one or more previously requested product loads and/or modifications. The card holder may have previously ordered the product from a retailing website and is using this terminal to collect the product. In the case the terminal can only request all products pending for the CM to be loaded and/or modified.

Parameters:
cardId - ID of a specific card to perform pending requests for
cardType - Type of card to perform pending requests for
callback - Callback used to inform the application on the progress of the operation

performPendingRequests

void performPendingRequests(String requestId,
                            String cardId,
                            CardType cardType,
                            ITransactionControllerCallback callback)
The PERFORM PENDING REQUESTS function is called by the application to download one or more previously requested product loads and/or modifications. The card holder may have previously ordered the product from a retailing website and is using this terminal to collect the product. In the case the terminal can only request all products pending for the CM to be loaded and/or modified.

Parameters:
requestId - ID of a specific request that should be completed
cardId - ID of a specific card to perform pending requests for
cardType - Type of card to perform pending requests for
callback - Callback used to inform the application on the progress of the operation

cancelRequest

void cancelRequest(String requestId,
                   ITransactionControllerCallback listener)
Cancels a previously registered request.

Parameters:
requestId - ID of the request to be cancelled
listener - Used to pass back the outcome of the operation asynchronously

queryStatus

void queryStatus(String id,
                 QueryMode mode,
                 ITransactionControllerCallback listener)
Get details about the requests handled during the last download involving the CM with the specified Id

Parameters:
id - ID that is of interest
listener - Used to pass back the outcome of the operation asynchronously


Copyright © 2013 Ecebs Ltd. All Rights Reserved.