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(String segmentCode) Deletes segment with provided id
SegmentData	getSegment(String segmentCode) Retrieves segment with given code;
SearchResult<SegmentData>	getSegments(Map<String,String> params, int startPosition, int count) Retrieves segments in the system.
SegmentData	updateSegment(String segmentCode, SegmentData segment) Updates existing segment

Method Detail

getSegments

SearchResult<SegmentData> getSegments(Map<String,String> params,
                                      int startPosition,
                                      int count)

Retrieves segments in the system.

Parameters:

params - parameters for filtering

startPosition - start position for paginated results

count - how many results should be on page

Returns:

all segments in the system.

getSegment

SegmentData getSegment(String segmentCode)
                throws UnknownIdentifierException

Retrieves segment with given code;

Parameters:

segmentCode - code of segment to retrieve

Returns:

segment

Throws:

UnknownIdentifierException

createSegment

SegmentData createSegment(SegmentData segment)
                   throws AlreadyExistsException

Creates segment with given data.

Parameters:

segment - data to create

Returns:

created segment

Throws:

AlreadyExistsException

updateSegment

SegmentData updateSegment(String segmentCode,
                          SegmentData segment)
                   throws UnknownIdentifierException

Updates existing segment

Parameters:

segmentCode - to update

segment - data for update

Returns:

updated segment

Throws:

UnknownIdentifierException

deleteSegment

void deleteSegment(String segmentCode)
            throws UnknownIdentifierException

Deletes segment with provided id

Parameters:

segmentCode - to delete

Throws:

UnknownIdentifierException