Package com.broadleafcommerce.customersegment.admin.web.api.endpoint

Class AdminCustomerSegmentExportEndpoint

java.lang.Object

com.broadleafcommerce.customersegment.admin.web.api.endpoint.AdminCustomerSegmentExportEndpoint

@ConditionalOnExport
@ConditionalOnAdmin
@FrameworkRestController
@FrameworkMapping(path="/api/export")
public class AdminCustomerSegmentExportEndpoint
extends Object

Author:

Brandon Hines (bhines), Philip Baggett (pbaggett)

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected CustomerSegmentService	customerSegmentService
protected org.springframework.core.env.Environment	environment
static final int	PAGE_SIZE_DEFAULT
static final String	PAGE_SIZE_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
AdminCustomerSegmentExportEndpoint(org.springframework.context.ApplicationContext applicationContext, CustomerSegmentService customerSegmentService, org.springframework.core.env.Environment environment)

Method Summary

Modifier and Type	Method	Description
protected CustomerSegmentBatchDTO	buildCustomerSegmentBatchDTO(List<CustomerCustomerSegmentXref> customerSegmentXrefs, Long totalNumberOfXrefs, Long firstId, Integer count)
CustomerSegmentBatchDTO	getAllBatchCustomerSegments(jakarta.servlet.http.HttpServletRequest request, Long firstId, Integer count)
Long	getAllCustomerSegmentsCount(jakarta.servlet.http.HttpServletRequest request)
CustomerSegmentBatchDTO	getBatchCustomerSegments(jakarta.servlet.http.HttpServletRequest request, Long id, Long firstId, Integer count)
Long	getCustomerSegmentsCount(jakarta.servlet.http.HttpServletRequest request, Long id)

Methods inherited from class java.lang.Object

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

Field Details

PAGE_SIZE_DEFAULT

public static final int PAGE_SIZE_DEFAULT

See Also:

• Constant Field Values

PAGE_SIZE_PROPERTY_NAME

public static final String PAGE_SIZE_PROPERTY_NAME

See Also:

• Constant Field Values

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

customerSegmentService

protected CustomerSegmentService customerSegmentService

environment

protected org.springframework.core.env.Environment environment

Constructor Details

AdminCustomerSegmentExportEndpoint

@Autowired
public AdminCustomerSegmentExportEndpoint(org.springframework.context.ApplicationContext applicationContext,
 CustomerSegmentService customerSegmentService,
 org.springframework.core.env.Environment environment)

Method Details

getAllBatchCustomerSegments

@FrameworkMapping(path="customer-segment",
                  method=GET)
public CustomerSegmentBatchDTO getAllBatchCustomerSegments(jakarta.servlet.http.HttpServletRequest request,
 @RequestParam(required=false)
 Long firstId,
 @RequestParam(required=false)
 Integer count)

getBatchCustomerSegments

@FrameworkMapping(path="customer-segment/{id}",
                  method=GET)
public CustomerSegmentBatchDTO getBatchCustomerSegments(jakarta.servlet.http.HttpServletRequest request,
 @PathVariable(name="id")
 Long id,
 @RequestParam(required=false)
 Long firstId,
 @RequestParam(required=false)
 Integer count)

buildCustomerSegmentBatchDTO

protected CustomerSegmentBatchDTO buildCustomerSegmentBatchDTO(List<CustomerCustomerSegmentXref> customerSegmentXrefs,
 Long totalNumberOfXrefs,
 Long firstId,
 Integer count)

getAllCustomerSegmentsCount

@FrameworkMapping(path="customer-segment/count",
                  method=GET)
public Long getAllCustomerSegmentsCount(jakarta.servlet.http.HttpServletRequest request)

getCustomerSegmentsCount

@FrameworkMapping(path="customer-segment/{id}/count",
                  method=GET)
public Long getCustomerSegmentsCount(jakarta.servlet.http.HttpServletRequest request,
 @PathVariable(name="id")
 Long id)