pl.rspective.voucherify.client.module

Class ValidationsModule

java.lang.Object

pl.rspective.voucherify.client.module.ValidationsModule

public final class ValidationsModule
extends java.lang.Object

Validations Module to manage communication with Voucherify

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	pl.rspective.voucherify.client.module.AbsModule.Async
static class	pl.rspective.voucherify.client.module.AbsModule.Rx
class	ValidationsModule.ExtAsync Async extension.
class	ValidationsModule.ExtRxJava RxJava extension.

Constructor Summary

Constructors

Constructor and Description
ValidationsModule(VoucherifyApi api, java.util.concurrent.Executor executor)

Method Summary

Modifier and Type	Method and Description
ValidationsModule.ExtAsync	async() Returns the asynchronous extension of this module.
ValidationsModule.ExtRxJava	rx() Returns the RxJava extension of this module.
VoucherValidationResult	validateVoucher(java.lang.String code, VoucherValidationContext validityContext) Validates given voucher code against the customer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationsModule

public ValidationsModule(VoucherifyApi api,
                         java.util.concurrent.Executor executor)

Parameters:

api - describes Voucherify REST API

executor - of threads for current platform

Method Detail

validateVoucher

public VoucherValidationResult validateVoucher(java.lang.String code,
                                               VoucherValidationContext validityContext)

Validates given voucher code against the customer.

Parameters:

code - code of the voucher

validityContext - a context in terms of which the voucher is being validated (e.g. customer profile)

Returns:

voucher validity information

async

public ValidationsModule.ExtAsync async()

Returns the asynchronous extension of this module.

rx

public ValidationsModule.ExtRxJava rx()

Returns the RxJava extension of this module.