de.hybris.platform.personalizationwebservices.controllers

Class SegmentController

java.lang.Object

de.hybris.platform.webservicescommons.controllers.AbstractController

de.hybris.platform.personalizationwebservices.controllers.PersonalizationAbstractController

de.hybris.platform.personalizationwebservices.controllers.SegmentController

public class SegmentController
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
SegmentController(SegmentFacade segmentFacade, Validator segmentValidator)

Method Summary

Modifier and Type	Method and Description
protected SegmentListWsDTO	createListDTO(SearchPageData<SegmentData> segments)
<any>	createSegment(SegmentData segment, UriComponentsBuilder builder) Creates segment
void	deleteSegment(java.lang.String segmentCode) Removes segment with given code
SegmentData	getSegment(java.lang.String segmentCode) Returns segment with given code
SegmentListWsDTO	getSegments(java.util.Map<java.lang.String,java.lang.String> requestParams) Returns all segments from the system
SegmentData	updateSegment(java.lang.String segmentCode, SegmentData segment) Updates segment with given code
protected void	validateSegment(SegmentData 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

SegmentController

public SegmentController(SegmentFacade segmentFacade,
                         Validator segmentValidator)

Method Detail

getSegments

public SegmentListWsDTO getSegments(java.util.Map<java.lang.String,java.lang.String> requestParams)

Returns all segments from the system

Returns:

List with all segments in the system

createListDTO

protected SegmentListWsDTO createListDTO(SearchPageData<SegmentData> segments)

createSegment

public <any> createSegment(SegmentData segment,
                           UriComponentsBuilder builder)

Creates segment

Returns:

created segment

Throws:

AlreadyExistsException - if segment with given code already exists

WebserviceValidationException - if provided segment data is invalid

getSegment

public SegmentData getSegment(java.lang.String segmentCode)

Returns segment with given code

Returns:

segmetn with given code

Throws:

NotFoundException - if segment with given code does not exists

updateSegment

public SegmentData updateSegment(java.lang.String segmentCode,
                                 SegmentData segment)

Updates segment with given code

Returns:

updated segment

Throws:

WebserviceValidationException - if provided data is invalid

NotFoundException - if segment with given code does not exists

deleteSegment

public void deleteSegment(java.lang.String segmentCode)

Removes segment with given code

Throws:

NotFoundException - if segment with given code does not exists

validateSegment

protected void validateSegment(SegmentData segment)