de.hybris.platform.personalizationfacades.segment

Interface SegmentFacade

All Known Implementing Classes:

DefaultSegmentFacade

public interface SegmentFacade

Facade for operations on segments.

Method Summary

Modifier and Type	Method and Description
SegmentData	createSegment(SegmentData segment) Creates segment with given data.
void	deleteSegment(java.lang.String segmentCode) Deletes segment with provided id
SegmentData	getSegment(java.lang.String segmentCode) Retrieves segment with given code;
SearchPageData<SegmentData>	getSegments(java.util.Map<java.lang.String,java.lang.String> filters, SearchPageData<?> pagination) Retrieves segments
SegmentData	updateSegment(java.lang.String segmentCode, SegmentData segment) Updates existing segment

Method Detail

getSegments

SearchPageData<SegmentData> getSegments(java.util.Map<java.lang.String,java.lang.String> filters,
                                        SearchPageData<?> pagination)

Retrieves segments

Parameters:

filters - parameters for filtering

pagination - holder of pagination data and sort options

Returns:

SearchPageData with result list, used pagination and sort options

getSegment

SegmentData getSegment(java.lang.String segmentCode)

Retrieves segment with given code;

Parameters:

segmentCode - code of segment to retrieve

Returns:

segment of given code

Throws:

UnknownIdentifierException - if provided identifier is invalid

createSegment

SegmentData createSegment(SegmentData segment)

Creates segment with given data.

Parameters:

segment - data to create

Returns:

created segment

Throws:

AlreadyExistsException - if given segment already exists

updateSegment

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

Updates existing segment

Parameters:

segmentCode - to update

segment - data for update

Returns:

updated segment

Throws:

UnknownIdentifierException - if any of provided identifiers is invalid

deleteSegment

void deleteSegment(java.lang.String segmentCode)

Deletes segment with provided id

Parameters:

segmentCode - to delete

Throws:

UnknownIdentifierException - if provided identifier is invalid