Package com.broadleafcommerce.subscription.web.endpoint

Class ItemAdjustmentEndpoint

java.lang.Object

com.broadleafcommerce.subscription.web.endpoint.ItemAdjustmentEndpoint

@FrameworkRestController
@FrameworkMapping("/item-adjustments")
@DataRouteByKey("billing")
public class ItemAdjustmentEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
protected SubscriptionItemAdjustmentService<SubscriptionItemAdjustment>	subscriptionItemAdjustmentService

Constructor Summary

Constructors

Constructor	Description
ItemAdjustmentEndpoint()

Method Summary

Modifier and Type	Method	Description
SubscriptionItemAdjustment	addItemAdjustment(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean isSandboxAware, SubscriptionItemAdjustment subscriptionItemAdjustment, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
RemoveSubscriptionItemAdjustmentResponse	bulkRemoveSubscriptionItemAdjustments(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean isSandboxAware, RemoveSubscriptionItemAdjustmentRequest removeSubscriptionItemAdjustmentRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
List<SubscriptionItemAdjustment>	getSubscriptionItemAdjustments(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean isSandboxAware, boolean isApplicationAware, String subscriptionItemId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
void	removeSubscriptionItemAdjustment(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean isSandboxAware, String itemAdjustmentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
void	setTypeFactory(com.broadleafcommerce.common.extension.TypeFactory typeFactory)

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

subscriptionItemAdjustmentService

@Autowired
protected SubscriptionItemAdjustmentService<SubscriptionItemAdjustment> subscriptionItemAdjustmentService

Constructor Details

ItemAdjustmentEndpoint

public ItemAdjustmentEndpoint()

Method Details

getSubscriptionItemAdjustments

@FrameworkGetMapping
@Policy(permissionRoots="SUBSCRIPTION")
public List<SubscriptionItemAdjustment> getSubscriptionItemAdjustments(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="false")
 boolean isSandboxAware,
 @RequestHeader(value="X-APPLICATION-AWARE",required=false,defaultValue="false")
 boolean isApplicationAware,
 @RequestParam
 String subscriptionItemId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

addItemAdjustment

@FrameworkPostMapping
@Policy(permissionRoots="SUBSCRIPTION")
public SubscriptionItemAdjustment addItemAdjustment(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="true")
 boolean isSandboxAware,
 @RequestBody
 SubscriptionItemAdjustment subscriptionItemAdjustment,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

removeSubscriptionItemAdjustment

@FrameworkDeleteMapping("/{itemAdjustmentId}")
@Policy(permissionRoots="SUBSCRIPTION")
public void removeSubscriptionItemAdjustment(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="true")
 boolean isSandboxAware,
 @PathVariable("itemAdjustmentId")
 String itemAdjustmentId,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

bulkRemoveSubscriptionItemAdjustments

@FrameworkPostMapping("/bulk-remove")
@Policy(permissionRoots="SUBSCRIPTION")
public RemoveSubscriptionItemAdjustmentResponse bulkRemoveSubscriptionItemAdjustments(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="true")
 boolean isSandboxAware,
 @RequestBody
 RemoveSubscriptionItemAdjustmentRequest removeSubscriptionItemAdjustmentRequest,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

setTypeFactory

@Autowired
public void setTypeFactory(com.broadleafcommerce.common.extension.TypeFactory typeFactory)