Package com.inteliqua.rest.transaction.client

Class TransactionClient

java.lang.Object

com.inteliqua.rest.EliquaClientBase

com.inteliqua.rest.EliquaClient

com.inteliqua.rest.transaction.client.TransactionClient

All Implemented Interfaces:

CrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>

public class TransactionClient
extends EliquaClient
implements CrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>

Client class for managing transaction-related operations via the Eliqua API. This class handles searching, creating and processing transaction-related requests.

It extends EliquaClient and implements CrudClient to provide CRUD operations for transactions using TransactionCriteria, TransactionCreateRequest, and TransactionBasePayload.

Constructor Summary

Constructors

Constructor	Description
TransactionClient(String host, EliquaAuthenticationProvider eliquaAuthenticationProvider)	Constructs a new with the given host and authentication provider.

Method Summary

Modifier and Type	Method	Description
com.qivos.util.rest.common.envelope.APIResponseEnvelope<TransactionResponsePayload>	create(TransactionCreateRequest requestBody)	Creates a new transaction record in the system.
com.qivos.util.rest.common.envelope.APIResponseEnvelope	delete(String code)
String	getResourceURI()	Retrieves the base resource URI for transaction-related requests.
com.qivos.util.rest.common.envelope.APIResponseEnvelope<TransactionResponseSearchPayload>	search(SearchRequest<TransactionCriteria> requestBody)	Searches for transactions based on the given search criteria.
com.qivos.util.rest.common.envelope.APIResponseEnvelope	searchExtended(SearchRequest<TransactionCriteria> requestBody)
com.qivos.util.rest.common.envelope.APIResponseEnvelope	update(TransactionBasePayload requestBody, String code)

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionClient

public TransactionClient(String host,
                         EliquaAuthenticationProvider eliquaAuthenticationProvider)

Constructs a new with the given host and authentication provider.

Parameters:

host - the API host URL

eliquaAuthenticationProvider - the authentication provider for API access

Method Detail

search

public com.qivos.util.rest.common.envelope.APIResponseEnvelope<TransactionResponseSearchPayload> search(SearchRequest<TransactionCriteria> requestBody)

Searches for transactions based on the given search criteria.

Specified by:

search in interface CrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>

Parameters:

requestBody - criteria encapsulated in a SearchRequest

Returns:

an APIResponseEnvelope containing TransactionResponseSearchPayload

searchExtended

public com.qivos.util.rest.common.envelope.APIResponseEnvelope searchExtended(SearchRequest<TransactionCriteria> requestBody)

Specified by:

searchExtended in interface CrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>

create

public com.qivos.util.rest.common.envelope.APIResponseEnvelope<TransactionResponsePayload> create(TransactionCreateRequest requestBody)

Creates a new transaction record in the system.

Specified by:

create in interface CrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>

Parameters:

requestBody - the request object containing the transaction details

Returns:

an APIResponseEnvelope containing TransactionResponsePayload

update

public com.qivos.util.rest.common.envelope.APIResponseEnvelope update(TransactionBasePayload requestBody,
                                                                      String code)

Specified by:

update in interface CrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>

delete

public com.qivos.util.rest.common.envelope.APIResponseEnvelope delete(String code)

Specified by:

delete in interface CrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>

getResourceURI

public String getResourceURI()

Retrieves the base resource URI for transaction-related requests.

Specified by:

getResourceURI in class EliquaClient

Returns:

the resource URI as a String