Package com.broadleafcommerce.creditaccount.web.endpoint

Class CustomerStoreCreditAccountEndpoint

java.lang.Object

com.broadleafcommerce.creditaccount.web.endpoint.CustomerStoreCreditAccountEndpoint

@FrameworkRestController
@FrameworkMapping("/customers/{customerId}/store-credit-accounts")
@DataRouteByKey("creditAccount")
public class CustomerStoreCreditAccountEndpoint
extends Object

Author:

Dima Myroniuk (dmyroniuk)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
CustomerStoreCreditAccountEndpoint(CreditAccountService<CreditAccount> creditAccountService, TransactionService<Transaction> transactionService)

Method Summary

Modifier and Type	Method	Description
CreditAccount	createCustomerStoreCreditAccount(String customerId, CreateCreditAccountRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
void	deactivateStoreCreditAccount(String customerId, String accountNumber, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected CreditAccountService<CreditAccount>	getCreditAccountService()
protected TransactionService<Transaction>	getTransactionService()
CreditAccount	readCustomerStoreCreditAccountByAccountNumber(String customerId, String accountNumber, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
org.springframework.data.domain.Page<CreditAccount>	readCustomerStoreCreditAccounts(String customerId, List<String> accountNumbers, org.springframework.data.domain.Pageable page, CurrencyContext currencyContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
org.springframework.data.domain.Page<CreditAccount>	readCustomerStoreCreditAccounts(String customerId, List<String> accountNumbers, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
org.springframework.data.domain.Page<Transaction>	readStoreCreditAccountTransactions(String customerId, String accountNumber, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

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

CustomerStoreCreditAccountEndpoint

public CustomerStoreCreditAccountEndpoint(CreditAccountService<CreditAccount> creditAccountService,
 TransactionService<Transaction> transactionService)

Method Details

readCustomerStoreCreditAccounts

@FrameworkGetMapping
@Policy(permissionRoots="CUSTOMER_STORE_CREDIT_ACCOUNT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="customer_id")
public org.springframework.data.domain.Page<CreditAccount> readCustomerStoreCreditAccounts(@PathVariable("customerId")
 String customerId,
 @RequestParam(required=false)
 List<String> accountNumbers,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

readCustomerStoreCreditAccounts

@FrameworkGetMapping(headers="X-Currency-Context")
@Policy(permissionRoots="CUSTOMER_STORE_CREDIT_ACCOUNT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="customer_id")
public org.springframework.data.domain.Page<CreditAccount> readCustomerStoreCreditAccounts(@PathVariable("customerId")
 String customerId,
 @RequestParam(required=false)
 List<String> accountNumbers,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 @RequestHeader("X-Currency-Context")
 CurrencyContext currencyContext,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

readCustomerStoreCreditAccountByAccountNumber

@FrameworkGetMapping("/{accountNumber}")
@Policy(permissionRoots="CUSTOMER_STORE_CREDIT_ACCOUNT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="customer_id")
public CreditAccount readCustomerStoreCreditAccountByAccountNumber(@PathVariable("customerId")
 String customerId,
 @PathVariable("accountNumber")
 String accountNumber,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

readStoreCreditAccountTransactions

@FrameworkGetMapping("/{accountNumber}/transactions")
@Policy(permissionRoots="CUSTOMER_STORE_CREDIT_ACCOUNT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="customer_id")
public org.springframework.data.domain.Page<Transaction> readStoreCreditAccountTransactions(@PathVariable("customerId")
 String customerId,
 @PathVariable("accountNumber")
 String accountNumber,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

createCustomerStoreCreditAccount

@FrameworkPostMapping
@Policy(permissionRoots="BACKEND_STORE_CREDIT_ACCOUNT")
public CreditAccount createCustomerStoreCreditAccount(@PathVariable("customerId")
 String customerId,
 @RequestBody
 CreateCreditAccountRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

deactivateStoreCreditAccount

@FrameworkDeleteMapping("/{accountNumber}")
@Policy(permissionRoots="BACKEND_STORE_CREDIT_ACCOUNT")
public void deactivateStoreCreditAccount(@PathVariable("customerId")
 String customerId,
 @PathVariable("accountNumber")
 String accountNumber,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

getCreditAccountService

protected CreditAccountService<CreditAccount> getCreditAccountService()

getTransactionService

protected TransactionService<Transaction> getTransactionService()