Package com.broadleafcommerce.customer.web.endpoint

Class AccountMemberEndpoint

java.lang.Object

com.broadleafcommerce.customer.web.endpoint.AccountMemberEndpoint

@FrameworkRestController
@FrameworkMapping("/accounts/{accountId}/members")
@DataRouteByExample(Account.class)
public class AccountMemberEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
AccountMemberEndpoint(AccountMemberService<AccountMember> accountMemberService)

Method Summary

Modifier and Type	Method	Description
protected AccountMemberService<AccountMember>	getAccountMemberService()
AccountMember	readAccountMember(String accountId, String accountMemberId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<AccountMember>	readAccountMembers(String accountId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
AccountMember	registerAccountMember(String accountId, RegisterAccountMemberRequest registerRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	removeAccountMember(String accountId, String accountMemberId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
AccountMember	updateAccountMember(String accountId, String accountMemberId, UpdateAccountMemberRequest updateRequest, 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

AccountMemberEndpoint

public AccountMemberEndpoint(AccountMemberService<AccountMember> accountMemberService)

Method Details

readAccountMembers

@Policy(permissionRoots="ACCOUNT_MEMBER")
@FrameworkGetMapping
public org.springframework.data.domain.Page<AccountMember> readAccountMembers(@PathVariable("accountId")
 String accountId,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault
 org.springframework.data.domain.Pageable page,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

registerAccountMember

@Policy(permissionRoots="ACCOUNT_MEMBER")
@FrameworkPostMapping(consumes="application/json")
public AccountMember registerAccountMember(@PathVariable("accountId")
 String accountId,
 @RequestBody
 RegisterAccountMemberRequest registerRequest,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readAccountMember

@Policy(permissionRoots="ACCOUNT_MEMBER")
@FrameworkGetMapping("/{accountMemberId}")
public AccountMember readAccountMember(@PathVariable("accountId")
 String accountId,
 @PathVariable("accountMemberId")
 String accountMemberId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

updateAccountMember

@Policy(permissionRoots="ACCOUNT_MEMBER")
@FrameworkMapping(value="/{accountMemberId}",
                  consumes="application/json",
                  method={PATCH,PUT})
public AccountMember updateAccountMember(@PathVariable("accountId")
 String accountId,
 @PathVariable("accountMemberId")
 String accountMemberId,
 @RequestBody
 UpdateAccountMemberRequest updateRequest,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

removeAccountMember

@Policy(permissionRoots="ACCOUNT_MEMBER")
@FrameworkDeleteMapping("/{accountMemberId}")
public void removeAccountMember(@PathVariable("accountId")
 String accountId,
 @PathVariable("accountMemberId")
 String accountMemberId,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getAccountMemberService

protected AccountMemberService<AccountMember> getAccountMemberService()