com.valtech.aem.saas.api.bestbets

Interface BestBetsService

public interface BestBetsService

Service that manages best bets.

Method Summary

Modifier and Type	Method and Description
int	addBestBet(@NonNull SearchCAConfigurationModel searchConfiguration, @NonNull BestBetPayloadDTO bestBetPayload) Adds a best bet entry in saas admin.
void	addBestBets(@NonNull SearchCAConfigurationModel searchConfiguration, @NonNull List<BestBetPayloadDTO> bestBetPayloadList) Adds a list of best bet entry in saas admin.
void	deleteBestBet(@NonNull SearchCAConfigurationModel searchConfiguration, int bestBetId) Deletes the best bet entry with the specified id.
List<BestBetDTO>	getBestBets(@NonNull SearchCAConfigurationModel searchConfiguration) Gets the list of all best bets entries.
void	publishBestBetsForProject(@NonNull SearchCAConfigurationModel searchConfiguration, int projectId) Published the best bets for the specified project.
void	updateBestBet(@NonNull SearchCAConfigurationModel searchConfiguration, int bestBetId, @NonNull BestBetPayloadDTO bestBetPayload) Updates the best bet entry with the specified id.

Method Detail

addBestBet

int addBestBet(@NonNull
               @NonNull SearchCAConfigurationModel searchConfiguration,
               @NonNull
               @NonNull BestBetPayloadDTO bestBetPayload)

Adds a best bet entry in saas admin.

Parameters:

searchConfiguration - sling model accessing context aware search configurations (i.e client and index).

bestBetPayload - object containing details for the best bet.

Returns:

best bet id

Throws:

IllegalArgumentException - exception thrown when blank client argument is passed

IllegalStateException - exception thrown when according action is not specified

BestBetsActionFailedException - exception thrown when the add action has failed or request execution has failed

addBestBets

void addBestBets(@NonNull
                 @NonNull SearchCAConfigurationModel searchConfiguration,
                 @NonNull
                 @NonNull List<BestBetPayloadDTO> bestBetPayloadList)

Adds a list of best bet entry in saas admin.

Parameters:

searchConfiguration - sling model accessing context aware search configurations (i.e client and index).

bestBetPayloadList - a list of objects containing best bet details.

Throws:

IllegalArgumentException - exception thrown when blank client argument is passed

IllegalStateException - exception thrown when according action is not specified

BestBetsActionFailedException - exception thrown when the add action has failed or request execution has failed

updateBestBet

void updateBestBet(@NonNull
                   @NonNull SearchCAConfigurationModel searchConfiguration,
                   int bestBetId,
                   @NonNull
                   @NonNull BestBetPayloadDTO bestBetPayload)

Updates the best bet entry with the specified id.

Parameters:

searchConfiguration - sling model accessing context aware search configurations (i.e client and index).

bestBetId - id of the best bet that is updated.

bestBetPayload - best bet details to be updated.

Throws:

IllegalArgumentException - exception thrown when blank client argument is passed

IllegalStateException - exception thrown when according action is not specified

BestBetsActionFailedException - exception thrown when the update action has failed or request execution has failed

deleteBestBet

void deleteBestBet(@NonNull
                   @NonNull SearchCAConfigurationModel searchConfiguration,
                   int bestBetId)

Deletes the best bet entry with the specified id.

Parameters:

searchConfiguration - sling model accessing context aware search configurations (i.e client and index).

bestBetId - the id of the best bet that should be deleted.

Throws:

IllegalArgumentException - exception thrown when blank client argument is passed

IllegalStateException - exception thrown when according action is not specified

BestBetsActionFailedException - exception thrown when the delete action has failed or request execution has failed.

publishBestBetsForProject

void publishBestBetsForProject(@NonNull
                               @NonNull SearchCAConfigurationModel searchConfiguration,
                               int projectId)

Published the best bets for the specified project.

Parameters:

searchConfiguration - sling model accessing context aware search configurations (i.e client and index).

projectId - id of the project whose best bets should be published

Throws:

IllegalArgumentException - exception thrown when blank client argument is passed

IllegalStateException - exception thrown when according action is not specified

BestBetsActionFailedException - exception thrown when the publishing action has failed or request execution has failed

getBestBets

List<BestBetDTO> getBestBets(@NonNull
                             @NonNull SearchCAConfigurationModel searchConfiguration)

Gets the list of all best bets entries.

Parameters:

searchConfiguration - sling model accessing context aware search configurations (i.e client and index).

Returns:

list of best bets.

Throws:

IllegalArgumentException - exception thrown when blank client argument is passed

IllegalStateException - exception thrown when according action is not specified

BestBetsActionFailedException - exception thrown when the request execution has failed.