org.cyclos.services.banking

Interface TicketService

All Superinterfaces:

Service

All Known Subinterfaces:

TicketServiceLocal

All Known Implementing Classes:

TicketServiceSecurity

public interface TicketService
extends Service

Service interface to manage tickets.
A ticket is a transaction having a receiver user and represents a pending payment to be accepted by any user (the payer) who want (and can) make the payment. It also could be created to be accepted by a specific payer.

Author:

ameyer

Method Summary

Modifier and Type	Method and Description
TicketVO	approve(@NotNull ApproveTicketDTO params) Approves a ticket, as a payer, only if status is TicketStatus.OPEN. If there is no "success URL" defined then it generates a new direct payment and the ticket goes to TicketStatus.PROCESSED.
SerializableInputStream	barcode(@NotNull TicketBarcodeParams params) Generates a two-dimensional barcode (aka QR code) only if status is TicketStatus.OPEN containing a URL of the form: .../pay/ticket_id (e.g https://www.cyclos.org/pay/1234567890123456789).
void	cancel(@NotNull TicketVO ticket) Cancels the ticket only if status is TicketStatus.OPEN and the logged user is the ticket's receiver or a manger of him.
TicketVO	create(@NotNull CreateTicketDTO params) Creates a new ticket with status TicketStatus.OPEN for the logged user (i.e setting it as the receiver).
CreateTicketData	getCreateData(UserLocatorVO payer) Returns data used to crate a new ticket, optionally with a fixed payer.
TicketData	getData(@NotNull TicketVO vo) Returns data to view the ticket's details.
EasyInvoiceData	getEasyInvoiceData(PerformPaymentDTO params) Returns data for an easy invoice after logging in.
TicketPaymentTypeData	getTicketPaymentTypeData(@NotNull TransferTypeVO transferType) Returns the data for a specific payment type used to create a new ticket
PrepareEasyInvoiceData	prepareEasyInvoice(PrepareEasyInvoiceParams params) Returns data for displaying details of an easy invoice while still as guest.
ApproveTicketPreviewVO	previewApprove(@NotNull TicketVO ticket) Previews the payment which would be performed when approving the given ticket as the payer.
TicketProcessResult	process(ProcessTicketDTO params) Processes a ticket as the receiver of the payment (i.e the ticket creator). Only if the ticket status is TicketStatus.APPROVED a new direct payment will be generated and the new ticket status will be: TicketStatus.PROCESSED.
Page<TicketEntryVO>	search(@NotNull TicketQuery query) Searches for tickets according to the given query.

Method Detail

approve

TicketVO approve(@NotNull
                 @NotNull ApproveTicketDTO params)
          throws TransferException,
                 FrameworkException

Approves a ticket, as a payer, only if status is TicketStatus.OPEN.
If there is no "success URL" defined then it generates a new direct payment and the ticket goes to TicketStatus.PROCESSED. Otherwise, no payment is generated and the ticket goes to TicketStatus.APPROVED status. The payment will be generated only after being processed by the receiver.

Throws:

TransferException

FrameworkException

barcode

SerializableInputStream barcode(@NotNull
                                @NotNull TicketBarcodeParams params)
                         throws FrameworkException

Generates a two-dimensional barcode (aka QR code) only if status is TicketStatus.OPEN containing a URL of the form: .../pay/ticket_id (e.g https://www.cyclos.org/pay/1234567890123456789).

Throws:

FrameworkException

cancel

void cancel(@NotNull
            @NotNull TicketVO ticket)
     throws FrameworkException

Cancels the ticket only if status is TicketStatus.OPEN and the logged user is the ticket's receiver or a manger of him.

Throws:

FrameworkException

create

TicketVO create(@NotNull
                @NotNull CreateTicketDTO params)
         throws FrameworkException

Creates a new ticket with status TicketStatus.OPEN for the logged user (i.e setting it as the receiver).

Throws:

FrameworkException

getCreateData

CreateTicketData getCreateData(UserLocatorVO payer)
                        throws FrameworkException

Returns data used to crate a new ticket, optionally with a fixed payer.

Throws:

FrameworkException

getData

TicketData getData(@NotNull
                   @NotNull TicketVO vo)
            throws FrameworkException

Returns data to view the ticket's details.

Throws:

FrameworkException

getEasyInvoiceData

EasyInvoiceData getEasyInvoiceData(PerformPaymentDTO params)
                            throws FrameworkException

Returns data for an easy invoice after logging in. Minimally, a to user is required. The amount either is not specified or a currency must be resolved, in the same way as prepareEasyInvoice(PrepareEasyInvoiceParams) The resulting data will contain the resolved read-only custom field values. The resulting PerformPaymentTypeData will contain the custom fields for the missing values.

Throws:

FrameworkException

getTicketPaymentTypeData

TicketPaymentTypeData getTicketPaymentTypeData(@NotNull
                                               @NotNull TransferTypeVO transferType)
                                        throws FrameworkException

Returns the data for a specific payment type used to create a new ticket

Throws:

FrameworkException

prepareEasyInvoice

PrepareEasyInvoiceData prepareEasyInvoice(PrepareEasyInvoiceParams params)
                                   throws FrameworkException,
                                          RemoteAddressBlockedException

Returns data for displaying details of an easy invoice while still as guest. Minimally, a to user is required. If an amount is specified, it is required that a single currency is resolved. This can be either because:

• A payment type was specified
• A currency was specified
• The destination user has a single currency

The resulting user will be returned only if the guest can search / view profile of that group. Without this permission, a null user will be returned. However, if the user is not found, a regular EntityNotFoundException will be thrown.

Throws:

FrameworkException

RemoteAddressBlockedException

previewApprove

ApproveTicketPreviewVO previewApprove(@NotNull
                                      @NotNull TicketVO ticket)
                               throws FrameworkException

Previews the payment which would be performed when approving the given ticket as the payer. The ticket status must be TicketStatus.APPROVED or TicketStatus.OPEN without a success url.

Throws:

FrameworkException

process

TicketProcessResult process(ProcessTicketDTO params)
                     throws TransferException,
                            FrameworkException

Processes a ticket as the receiver of the payment (i.e the ticket creator).
Only if the ticket status is TicketStatus.APPROVED a new direct payment will be generated and the new ticket status will be: TicketStatus.PROCESSED. There could be a case where this method is invoked for an already processed ticket (e.g. the ticket has both a success url and an success webhook), for it, only in case the given process code is the correct one this method runs without errors and returns the same result as the previous invocation (no payment is generated) but with the TicketProcessResult.ACTUALLY_PROCESSED flag in false.

Throws:

TransferException

FrameworkException

search

Page<TicketEntryVO> search(@NotNull
                           @NotNull TicketQuery query)
                    throws FrameworkException

Searches for tickets according to the given query. Returns tickets of the owner user (i.e ticket's receiver).

Throws:

FrameworkException