Package com.dzidzi.api

Interface PartnerRegistrationApi

public interface PartnerRegistrationApi

PartnerRegistrationApi contains all the api operations handling PartnerRegistration in the DzidziApp. This is the customer Api.

Method Summary

Modifier and Type	Method	Description
PartnerRegistration	addReviewStatement(UUID id, String statement)	Adds a review comment before moving to PartnerRegistrationState.WAITING_FOR_APPROVAL.
PartnerRegistration	addSignOffStatement(UUID id, String statement)	Adds a review comment before moving to PartnerRegistrationState.APPROVED or PartnerRegistrationState.REJECTED.
PartnerRegistration	changeState(UUID id, PartnerRegistrationState registrationState)	Changes the state of the partner request.
DzidziPaginationDTO<PartnerRegistration>	findPartnerRegistrations(FindPartnerRegistrationRequest findPartnerRegistrationRequest)	Finds the paginated partner registrations based on the parameters.
PartnerRegistration	getPartnerRegistrationById(UUID id)	Finds a partner registration by id.
PartnerRegistration	registerCourierPartner(AddCourierRegistrationRequest addCourierRegistrationRequest)	Registers a new courier partner request.
PartnerRegistration	registerRestaurantPartner(AddRestaurantRegistrationRequest addRestaurantRegistrationRequest)	Registers a new courier partner request.

Method Details

getPartnerRegistrationById

PartnerRegistration getPartnerRegistrationById(UUID id)

Finds a partner registration by id.

Parameters:

id - the partner registration id

Returns:

the partner registration found

Throws:

com.dzidzi.exception.EntityNotFoundException - when the partner registration is not found

registerCourierPartner

PartnerRegistration registerCourierPartner(AddCourierRegistrationRequest addCourierRegistrationRequest)

Registers a new courier partner request.

Parameters:

addCourierRegistrationRequest - the AddCourierRegistrationRequest to register as a courier partner

Returns:

the newly created courier partner request

registerRestaurantPartner

PartnerRegistration registerRestaurantPartner(AddRestaurantRegistrationRequest addRestaurantRegistrationRequest)

Registers a new courier partner request.

Parameters:

addRestaurantRegistrationRequest - the AddRestaurantRegistrationRequest to register as a restaurant partner

Returns:

the newly created restaurant partner request

changeState

PartnerRegistration changeState(UUID id,
 PartnerRegistrationState registrationState)

Changes the state of the partner request.

Parameters:

id - id of the request

registrationState - the state to change the request to

Returns:

the changed partner registration

addReviewStatement

PartnerRegistration addReviewStatement(UUID id,
 String statement)

Adds a review comment before moving to PartnerRegistrationState.WAITING_FOR_APPROVAL. The statement should entail steps you took to review the request and the requirements.

Parameters:

id - id of the request

statement - the closing review statement

Returns:

the updated request

addSignOffStatement

PartnerRegistration addSignOffStatement(UUID id,
 String statement)

Adds a review comment before moving to PartnerRegistrationState.APPROVED or PartnerRegistrationState.REJECTED. The statement should contain the reasons why the state was used.

Parameters:

id - id of the request

statement - the closing sign off statement

Returns:

the updated request

findPartnerRegistrations

DzidziPaginationDTO<PartnerRegistration> findPartnerRegistrations(FindPartnerRegistrationRequest findPartnerRegistrationRequest)

Finds the paginated partner registrations based on the parameters.

Parameters:

findPartnerRegistrationRequest - the request containing the params to filter partner registrations on

Returns:

the DzidziPaginationDTO