Package 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

@RestController
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	Description
SegmentController(SegmentFacade segmentFacade, org.springframework.validation.Validator segmentValidator)

Method Summary

Modifier and Type	Method	Description
protected SegmentListWsDTO	createListDTO(SearchPageData<SegmentData> segments)
org.springframework.http.ResponseEntity<SegmentData>	createSegment(SegmentData segment, org.springframework.web.util.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

@Autowired
public SegmentController(SegmentFacade segmentFacade,
                         org.springframework.validation.Validator segmentValidator)

Method Detail

getSegments

@RequestMapping(value="/v1/segments",
                method=GET)
public SegmentListWsDTO getSegments(@RequestParam
                                    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

@RequestMapping(value="/v1/segments",
                method=POST)
@ResponseStatus(CREATED)
public org.springframework.http.ResponseEntity<SegmentData> createSegment(@RequestBody
                                                                          SegmentData segment,
                                                                          org.springframework.web.util.UriComponentsBuilder builder)

Creates segment

Returns:

created segment

Throws:

AlreadyExistsException - if segment with given code already exists

WebserviceValidationException - if provided segment data is invalid

getSegment

@RequestMapping(value="/v1/segments/{segmentCode}",
                method=GET)
public SegmentData getSegment(@PathVariable
                              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

@RequestMapping(value="/v1/segments/{segmentCode}",
                method=PUT)
public SegmentData updateSegment(@PathVariable
                                 java.lang.String segmentCode,
                                 @RequestBody
                                 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

@RequestMapping(value="/v1/segments/{segmentCode}",
                method=DELETE)
@ResponseStatus(NO_CONTENT)
public void deleteSegment(@PathVariable
                          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)