Package com.broadleafcommerce.subscription.web.endpoint

Class CancellationPolicyEndpoint

java.lang.Object

com.broadleafcommerce.subscription.web.endpoint.CancellationPolicyEndpoint

@FrameworkRestController
@FrameworkMapping("/cancellation-policies")
@DataRouteByKey("billing")
public class CancellationPolicyEndpoint
extends Object

Endpoint for interacting with the Cancellation Policy

Author:

karanjariwala

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
static final String	CANCELLATION_POLICY_ROOT

Constructor Summary

Constructors

Constructor	Description
CancellationPolicyEndpoint(CancellationPolicyService<CancellationPolicy> cancellationPolicyService)

Method Summary

Modifier and Type	Method	Description
CancellationPolicy	createCancellationPolicy(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, CancellationPolicy cancellationPolicy, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteCancellationPolicy(String cancellationPolicyId, jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected CancellationPolicyService<CancellationPolicy>	getCancellationPolicyService()
org.springframework.data.domain.Page<CancellationPolicy>	readAllCancellationPolicies(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String query, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable)
CancellationPolicy	readCancellationPolicyById(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String cancellationPolicyId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
CancellationPolicy	replaceCancellationPolicy(String cancellationPolicyId, CancellationPolicy request, 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

CANCELLATION_POLICY_ROOT

public static final String CANCELLATION_POLICY_ROOT

See Also:

• Constant Field Values

Constructor Details

CancellationPolicyEndpoint

public CancellationPolicyEndpoint(CancellationPolicyService<CancellationPolicy> cancellationPolicyService)

Method Details

readAllCancellationPolicies

@FrameworkGetMapping
@Policy(permissionRoots="CANCELLATION_POLICY")
public org.springframework.data.domain.Page<CancellationPolicy> readAllCancellationPolicies(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestParam(value="q",required=false)
 String query,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable pageable)

readCancellationPolicyById

@FrameworkGetMapping("/{cancellationPolicyId}")
@Policy(permissionRoots="CANCELLATION_POLICY")
public CancellationPolicy readCancellationPolicyById(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @PathVariable("cancellationPolicyId")
 String cancellationPolicyId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

createCancellationPolicy

@FrameworkPostMapping
@Policy(permissionRoots="CANCELLATION_POLICY")
public CancellationPolicy createCancellationPolicy(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @RequestBody
 CancellationPolicy cancellationPolicy,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

replaceCancellationPolicy

@FrameworkPutMapping("/{cancellationPolicyId}")
@Policy(permissionRoots="CANCELLATION_POLICY")
public CancellationPolicy replaceCancellationPolicy(@PathVariable("cancellationPolicyId")
 String cancellationPolicyId,
 @RequestBody
 CancellationPolicy request,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteCancellationPolicy

@FrameworkDeleteMapping("/{cancellationPolicyId}")
@Policy(permissionRoots="CANCELLATION_POLICY")
public void deleteCancellationPolicy(@PathVariable("cancellationPolicyId")
 String cancellationPolicyId,
 jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getCancellationPolicyService

protected CancellationPolicyService<CancellationPolicy> getCancellationPolicyService()