Package com.broadleafcommerce.billing.web.endpoint

Class BillingEventPaymentEndpoint

java.lang.Object

com.broadleafcommerce.billing.web.endpoint.BillingEventPaymentEndpoint

@FrameworkRestController
@FrameworkMapping("/billing-event-payments")
@DataRouteByKey("billing")
public class BillingEventPaymentEndpoint
extends Object

Author:

Dima Myroniuk (dmyroniuk)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
BillingEventPaymentEndpoint(BillingEventPaymentService<BillingEventPayment,BillingEventPaymentWithEvent,BillingEventDTO,BillingEventPaymentWithTransaction> billingEventPaymentService)

Method Summary

Modifier and Type	Method	Description
List<BillingEventPayment>	abortAllBillingEventPaymentsByBillingEventId(String eventId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
BillingEventPayment	abortBillingEventPaymentByPaymentId(String paymentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
BillingEventPayment	createBillingEventPayment(BillingEventPaymentWithTransaction billingEventPaymentWithTransactionRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected BillingEventPaymentService<BillingEventPayment,BillingEventPaymentWithEvent,BillingEventDTO,BillingEventPaymentWithTransaction>	getBillingEventPaymentService()
BillingEventPayment	readBillingEventPaymentByPaymentId(String paymentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<BillingEventPayment>	readPaymentEventsByBillingEventId(String eventId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods inherited from class java.lang.Object

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

Field Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

Constructor Details

BillingEventPaymentEndpoint

public BillingEventPaymentEndpoint(BillingEventPaymentService<BillingEventPayment,BillingEventPaymentWithEvent,BillingEventDTO,BillingEventPaymentWithTransaction> billingEventPaymentService)

Method Details

readPaymentEventsByBillingEventId

@Policy(permissionRoots="BILLING")
@FrameworkGetMapping(params="eventId")
public List<BillingEventPayment> readPaymentEventsByBillingEventId(@RequestParam("eventId")
 String eventId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readBillingEventPaymentByPaymentId

@Policy(permissionRoots="BILLING")
@FrameworkGetMapping("/{paymentId}")
public BillingEventPayment readBillingEventPaymentByPaymentId(@PathVariable("paymentId")
 String paymentId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

createBillingEventPayment

@Policy(permissionRoots="BILLING")
@FrameworkPostMapping
public BillingEventPayment createBillingEventPayment(@RequestBody
 BillingEventPaymentWithTransaction billingEventPaymentWithTransactionRequest,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

abortAllBillingEventPaymentsByBillingEventId

@Policy(permissionRoots="BILLING")
@FrameworkPostMapping("/abort")
public List<BillingEventPayment> abortAllBillingEventPaymentsByBillingEventId(@RequestParam("eventId")
 String eventId,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

abortBillingEventPaymentByPaymentId

@Policy(permissionRoots="BILLING")
@FrameworkPostMapping("/abort/{paymentId}")
public BillingEventPayment abortBillingEventPaymentByPaymentId(@PathVariable("paymentId")
 String paymentId,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getBillingEventPaymentService

protected BillingEventPaymentService<BillingEventPayment,BillingEventPaymentWithEvent,BillingEventDTO,BillingEventPaymentWithTransaction> getBillingEventPaymentService()