Package com.broadleafcommerce.customer.web.endpoint

Class AccountAddressEndpoint

java.lang.Object

com.broadleafcommerce.customer.web.endpoint.AccountAddressEndpoint

@FrameworkRestController
@FrameworkMapping("/accounts/{accountId}/addresses")
@DataRouteByExample(AccountAddress.class)
public class AccountAddressEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
AccountAddressEndpoint(AccountService<Account> accountService, AccountAddressService<AccountAddress> accountAddressService, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
AccountAddress	addAccountAddress(String accountId, AccountAddress accountAddress, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteAccountAddress(String accountId, String accountAddressId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected AccountAddressService<AccountAddress>	getAccountAddressService()
protected AccountService<Account>	getAccountService()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
AccountAddress	readAccountAddress(String accountId, String accountAddressId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<AccountAddress>	readAccountAddresses(String accountId, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
AccountAddress	replaceAccountAddress(String accountId, String accountAddressId, AccountAddress accountAddress, 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 Detail

BASE_URI

public static final String BASE_URI

See Also:

Constant Field Values

Constructor Detail

AccountAddressEndpoint

public AccountAddressEndpoint(AccountService<Account> accountService,
                              AccountAddressService<AccountAddress> accountAddressService,
                              com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Detail

readAccountAddresses

@Policy(permissionRoots="ACCOUNT_ADDRESS",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="acct_id,parent_accts")
@FrameworkGetMapping
public org.springframework.data.domain.Page<AccountAddress> readAccountAddresses(@PathVariable("accountId")
                                                                                 String accountId,
                                                                                 @PageableDefault
                                                                                 org.springframework.data.domain.Pageable page,
                                                                                 cz.jirutka.rsql.parser.ast.Node filters,
                                                                                 @ContextOperation(READ)
                                                                                 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

addAccountAddress

@Policy(permissionRoots="ACCOUNT_ADDRESS",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="acct_id")
@FrameworkPostMapping(consumes="application/json")
public AccountAddress addAccountAddress(@PathVariable("accountId")
                                        String accountId,
                                        @RequestBody
                                        AccountAddress accountAddress,
                                        @ContextOperation(CREATE)
                                        com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readAccountAddress

@Policy(permissionRoots="ACCOUNT_ADDRESS",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="acct_id,parent_accts")
@FrameworkGetMapping("/{accountAddressId}")
public AccountAddress readAccountAddress(@PathVariable("accountId")
                                         String accountId,
                                         @PathVariable("accountAddressId")
                                         String accountAddressId,
                                         @ContextOperation(READ)
                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

replaceAccountAddress

@Policy(permissionRoots="ACCOUNT_ADDRESS",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="acct_id")
@FrameworkPutMapping(value="/{accountAddressId}",
                     consumes="application/json")
public AccountAddress replaceAccountAddress(@PathVariable("accountId")
                                            String accountId,
                                            @PathVariable("accountAddressId")
                                            String accountAddressId,
                                            @RequestBody
                                            AccountAddress accountAddress,
                                            @ContextOperation(UPDATE)
                                            com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteAccountAddress

@Policy(permissionRoots="ACCOUNT_ADDRESS",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="acct_id")
@FrameworkDeleteMapping("/{accountAddressId}")
public void deleteAccountAddress(@PathVariable("accountId")
                                 String accountId,
                                 @PathVariable("accountAddressId")
                                 String accountAddressId,
                                 @ContextOperation(DELETE)
                                 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getAccountService

protected AccountService<Account> getAccountService()

getAccountAddressService

protected AccountAddressService<AccountAddress> getAccountAddressService()

getTypeFactory

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