Package com.broadleafcommerce.billing.web.endpoint

Class RefundEventWithDetailsEndpoint

java.lang.Object

com.broadleafcommerce.billing.web.endpoint.RefundEventWithDetailsEndpoint

@FrameworkRestController
@FrameworkMapping("/refund-event-with-details")
@DataRouteByKey("billing")
public class RefundEventWithDetailsEndpoint
extends Object

Author:

Dima Myroniuk (dmyroniuk)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
RefundEventWithDetailsEndpoint(RefundEventService<RefundEvent,RefundEventWithDetails> refundEventService)

Method Summary

Modifier and Type	Method	Description
RefundEventWithDetails	abortRefundEvent(String refundEventId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
RefundEventWithDetails	createRefundEvent(@Valid RefundEventWithDetails refundEventWithDetailsRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected RefundEventService<RefundEvent,RefundEventWithDetails>	getRefundEventService()
List<RefundEventWithDetails>	readAllRefundsByEventId(String eventId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
RefundEventWithDetails	readByRefundEventId(String refundEventId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
RefundEventWithDetails	updateRefundEvent(String refundEventId, RefundEvent refundEventPatch, 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

RefundEventWithDetailsEndpoint

public RefundEventWithDetailsEndpoint(RefundEventService<RefundEvent,RefundEventWithDetails> refundEventService)

Method Details

readAllRefundsByEventId

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

readByRefundEventId

@Policy(permissionRoots="BILLING")
@FrameworkGetMapping("/{refundId}")
public RefundEventWithDetails readByRefundEventId(@PathVariable("refundId")
 String refundEventId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

createRefundEvent

@Policy(permissionRoots="BILLING")
@FrameworkPostMapping
public RefundEventWithDetails createRefundEvent(@RequestBody @Valid
 @Valid RefundEventWithDetails refundEventWithDetailsRequest,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
                                         throws InvalidRefundException

Throws:

InvalidRefundException

updateRefundEvent

@Policy(permissionRoots="BILLING")
@FrameworkPatchMapping("/{refundId}")
public RefundEventWithDetails updateRefundEvent(@PathVariable("refundId")
 String refundEventId,
 @RequestBody
 RefundEvent refundEventPatch,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

abortRefundEvent

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

getRefundEventService

protected RefundEventService<RefundEvent,RefundEventWithDetails> getRefundEventService()