org.posper.backoffice

Class JBackofficeRequests

java.lang.Object

org.posper.backoffice.JBackofficeRequests

public class JBackofficeRequests
extends Object

The purpose of this class is to provide REST communication with the POSper Backoffice application - work in progress Note on dates: Rails >= 2.3 returns dates as 'Json default dates' which looks like db dates while Rails 2.2.2 used yyyY/mm/ ...

Author:

hans

Constructor Summary

Constructors

Constructor and Description
JBackofficeRequests(String sURI) Create a gateway request instance
JBackofficeRequests(String sURI, String sLogin, String sPassword)

Method Summary

Modifier and Type	Method and Description
String	activateVoucher(String id, String userid) Activate a voucher
String	checkVoucher(String id) Check if the voucher exists and is valid and ready to be activated.
String	consumeVoucher(String id) Set the voucher to consumed which shall deactivate the voucher and set a used_at date
String	createCreditRecord(String ticketid, Double amount) Create a credit record in the central database.
String	createRadiusAccount(String cType, String sPeriod) work in progress
void	deleteCreditRecord(String id) Delete the record identified by id.
String	getCreditRecord(String id) Return the requested record.
String	getVoucher(String id) Get the voucher data as a JSON string
void	redeemCreditRecord(String id) Update the credit record identified by id with redeemed=true and the current date for updated_at and valid_before
void	revertRedeemCreditRecord(String id) Revert the redeem action

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JBackofficeRequests

public JBackofficeRequests(String sURI,
                           String sLogin,
                           String sPassword)

Parameters:

sURI -

sLogin -

sPassword -

JBackofficeRequests

public JBackofficeRequests(String sURI)

Create a gateway request instance

Parameters:

sURI - The URI must include the port nmber and the controller name The controller name is 'credit' for credit transactions. The gateway must reside in a location that is uniquely identified by branch, customer, and host. I.e. In the current setup, each host has its own gateway

Method Detail

deleteCreditRecord

public void deleteCreditRecord(String id)
                        throws BasicException

Delete the record identified by id.

Parameters:

id - The record id of the credit record

Throws:

BasicException

getCreditRecord

public String getCreditRecord(String id)
                       throws BasicException

Return the requested record.

Parameters:

id -

Returns:

a JSON formatted String

Throws:

BasicException

createCreditRecord

public String createCreditRecord(String ticketid,
                                 Double amount)
                          throws BasicException

Create a credit record in the central database. The central DB is accessed through POSperBackoffice using the requests in this class. The record structure is defined in http://support.posper.de/projects/museum4you/wiki/Technische_Details

Parameters:

ticketid -

amount -

Returns:

the id of the created recoord as String (although it's an integer)

Throws:

BasicException

redeemCreditRecord

public void redeemCreditRecord(String id)
                        throws BasicException

Update the credit record identified by id with redeemed=true and the current date for updated_at and valid_before

Parameters:

id -

Throws:

BasicException

revertRedeemCreditRecord

public void revertRedeemCreditRecord(String id)
                              throws BasicException

Revert the redeem action

Parameters:

id - The record id of the credit record

Throws:

BasicException

activateVoucher

public String activateVoucher(String id,
                              String userid)
                       throws BasicException

Activate a voucher

Parameters:

id -

userid -

Returns:

true if successful

Throws:

BasicException

consumeVoucher

public String consumeVoucher(String id)
                      throws BasicException

Set the voucher to consumed which shall deactivate the voucher and set a used_at date

Parameters:

id -

Returns:

true if successful

Throws:

BasicException

checkVoucher

public String checkVoucher(String id)
                    throws BasicException

Check if the voucher exists and is valid and ready to be activated.

Parameters:

id -

Returns:

a JSON structure with ack=true if successful, ack=false and error=error-code otherwise.

Throws:

BasicException

getVoucher

public String getVoucher(String id)
                  throws BasicException

Get the voucher data as a JSON string

Parameters:

id -

Returns:

the JSON string

Throws:

BasicException

createRadiusAccount

public String createRadiusAccount(String cType,
                                  String sPeriod)

work in progress

Parameters:

cType -

sPeriod -

Returns: