de.hybris.platform.personalizationwebservices.controllers

Class CustomerSegmentationController

java.lang.Object

de.hybris.platform.webservicescommons.controllers.AbstractController

de.hybris.platform.personalizationwebservices.controllers.PersonalizationAbstractController

de.hybris.platform.personalizationwebservices.controllers.CustomerSegmentationController

public class CustomerSegmentationController
extends PersonalizationAbstractController

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.webservicescommons.controllers.AbstractController

AbstractController.Executor

Field Summary

Fields inherited from class de.hybris.platform.personalizationwebservices.controllers.PersonalizationAbstractController

BASE_URL, VERSION

Fields inherited from class de.hybris.platform.webservicescommons.controllers.AbstractController

CATALOG_PATH

Constructor Summary

Constructors

Constructor and Description
CustomerSegmentationController(CustomerSegmentationFacade csFacade, Validator segmentationIdValidator)

Method Summary

Modifier and Type	Method and Description
<any>	create(CustomerSegmentationData customerSegmentation, UriComponentsBuilder builder) Creates relation between customer and segment
protected CustomerSegmentationListWsDTO	createListDTO(SearchPageData<CustomerSegmentationData> segmentations)
void	delete(java.lang.String segmentationId) Removes relation between customer and segment
CustomerSegmentationData	getCustomerSegmentation(java.lang.String segmentationId) Returns relation between customer and segment
CustomerSegmentationListWsDTO	getCustomerSegmentations(java.lang.String customerId, java.lang.String segmentId, java.lang.String baseSite, java.util.Map<java.lang.String,java.lang.String> requestParams) Method for searching customersegmentation objects based on given parameters
CustomerSegmentationData	update(java.lang.String segmentationId, CustomerSegmentationData data) Updates relation between customer and segment

Methods inherited from class de.hybris.platform.webservicescommons.controllers.AbstractController

executeAndConvertException, executeAndConvertException, getBindingResult, getLocationHeader, getWebPaginationUtils, setWebPaginationUtils, validate, validate, validateInputCode, validateResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomerSegmentationController

public CustomerSegmentationController(CustomerSegmentationFacade csFacade,
                                      Validator segmentationIdValidator)

Method Detail

getCustomerSegmentations

public CustomerSegmentationListWsDTO getCustomerSegmentations(java.lang.String customerId,
                                                              java.lang.String segmentId,
                                                              java.lang.String baseSite,
                                                              java.util.Map<java.lang.String,java.lang.String> requestParams)

Method for searching customersegmentation objects based on given parameters

Returns:

list of found relations or object with empty list

createListDTO

protected CustomerSegmentationListWsDTO createListDTO(SearchPageData<CustomerSegmentationData> segmentations)

create

public <any> create(CustomerSegmentationData customerSegmentation,
                    UriComponentsBuilder builder)

Creates relation between customer and segment

Parameters:

customerSegmentation - Request body parameter (DTO in xml or json format) which contains customer and segment identifiers.

Throws:

AlreadyExistsException - When relation between customer and segment already exists

WebserviceValidationException - When customer or segment identifier is invalid (empty or object not exists)

NotFoundException - When customer or segment with given identifier doesn't exist

getCustomerSegmentation

public CustomerSegmentationData getCustomerSegmentation(java.lang.String segmentationId)

Returns relation between customer and segment

Returns:

information about relation between customer and segment

Throws:

NotFoundException - When there is no relation with given identifier

WebserviceValidationException - When identifier is invalid (have not supported format)

update

public CustomerSegmentationData update(java.lang.String segmentationId,
                                       CustomerSegmentationData data)

Updates relation between customer and segment

Returns:

Updated relation

Throws:

WebserviceValidationException - When customer or segment identifier is invalid (empty or object not exists)

NotFoundException - When there is no relation with given identifier

delete

public void delete(java.lang.String segmentationId)

Removes relation between customer and segment

Throws:

NotFoundException - When there is no relation with given identifier