Package com.inteliqua.rest.customer.client

Class PersonClient

java.lang.Object

com.inteliqua.rest.EliquaClientBase

com.inteliqua.rest.EliquaClient

com.inteliqua.rest.customer.client.PersonClient

All Implemented Interfaces:

CrudClient<PersonCriteria,PersonCreateRequest,PersonMultiDataUpdateRequest>

public class PersonClient
extends EliquaClient
implements CrudClient<PersonCriteria,PersonCreateRequest,PersonMultiDataUpdateRequest>

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

It extends EliquaClient and implements CrudClient to provides full CRUD functionality for persons.

Author:

nikritikos

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
com.qivos.util.rest.common.envelope.SearchPayload	constructSearchPayload(String payload, com.fasterxml.jackson.core.type.TypeReference typeReference)	Constructs a PersonSearchResponseSimplePayload from a raw JSON payload.
PersonResponseExtendedPayload	constructSimplePayload(String payload)	Constructs a PersonResponseSimplePayload from a raw JSON payload.
com.qivos.util.rest.common.envelope.APIResponseEnvelope<PersonResponseExtendedPayload>	create(PersonCreateRequest requestBody)	Creates a new person record in the system.
com.qivos.util.rest.common.envelope.APIResponseEnvelope	delete(String code)
String	getResourceURI()	Retrieves the base resource URI for person-related requests.
com.qivos.util.rest.common.envelope.APIResponseEnvelope<PersonSearchResponseSimplePayload>	search(SearchRequest<PersonCriteria> requestBody)	Searches for persons based on the given search criteria.
com.qivos.util.rest.common.envelope.APIResponseEnvelope<PersonSearchResponseExtendedPayload>	searchExtended(SearchRequest<PersonCriteria> requestBody)	Searches for persons based on the given search criteria and returns extended information.
com.qivos.util.rest.common.envelope.APIResponseEnvelope<PersonResponseSimplePayload>	update(PersonMultiDataUpdateRequest requestBody, String code)	Updates an existing person record in the system

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonClient

public PersonClient(String host,
                    EliquaAuthenticationProvider eliquaAuthenticationProvider)

Constructs a new PersonClient with the specified 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<PersonSearchResponseSimplePayload> search(SearchRequest<PersonCriteria> requestBody)

Searches for persons based on the given search criteria.

Specified by:

search in interface CrudClient<PersonCriteria,PersonCreateRequest,PersonMultiDataUpdateRequest>

Parameters:

requestBody - the search criteria encapsulated in a SearchRequest

Returns:

an APIResponseEnvelope containing PersonSearchResponseSimplePayload

searchExtended

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

Searches for persons based on the given search criteria and returns extended information.

Specified by:

searchExtended in interface CrudClient<PersonCriteria,PersonCreateRequest,PersonMultiDataUpdateRequest>

Parameters:

requestBody - the search criteria encapsulated in a SearchRequest

Returns:

an APIResponseEnvelope containing PersonSearchResponseExtendedPayload

create

public com.qivos.util.rest.common.envelope.APIResponseEnvelope<PersonResponseExtendedPayload> create(PersonCreateRequest requestBody)

Creates a new person record in the system.

Specified by:

create in interface CrudClient<PersonCriteria,PersonCreateRequest,PersonMultiDataUpdateRequest>

Parameters:

requestBody - the request object containing person details

Returns:

an APIResponseEnvelope containing PersonResponseSimplePayload

update

public com.qivos.util.rest.common.envelope.APIResponseEnvelope<PersonResponseSimplePayload> update(PersonMultiDataUpdateRequest requestBody,
                                                                                                   String code)

Updates an existing person record in the system

Specified by:

update in interface CrudClient<PersonCriteria,PersonCreateRequest,PersonMultiDataUpdateRequest>

Parameters:

requestBody - the request object containing updated person details

code - the unique personQCCode of the person to be updated

Returns:

an APIResponseEnvelope containing the updated PersonResponseSimplePayload

delete

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

Specified by:

delete in interface CrudClient<PersonCriteria,PersonCreateRequest,PersonMultiDataUpdateRequest>

getResourceURI

public String getResourceURI()

Retrieves the base resource URI for person-related requests.

Specified by:

getResourceURI in class EliquaClient

Returns:

the resource URI as a String

constructSearchPayload

public com.qivos.util.rest.common.envelope.SearchPayload constructSearchPayload(String payload,
                                                                                com.fasterxml.jackson.core.type.TypeReference typeReference)

Constructs a PersonSearchResponseSimplePayload from a raw JSON payload.

Parameters:

payload - the JSON payload as a string

Returns:

the constructed PersonSearchResponseSimplePayload

Throws:

RuntimeException - if there is an error during JSON parsing

constructSimplePayload

public PersonResponseExtendedPayload constructSimplePayload(String payload)

Constructs a PersonResponseSimplePayload from a raw JSON payload.

Parameters:

payload - the JSON payload as a string

Returns:

the constructed PersonResponseSimplePayload