Interface B2BPermissionFacade
- All Known Subinterfaces:
B2BCommercePermissionFacade
- All Known Implementing Classes:
DefaultB2BCommercePermissionFacade,DefaultB2BPermissionFacade
public interface B2BPermissionFacade
A facade for permission management within b2b commerce
- Since:
- 6.0
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddPermission(B2BPermissionData b2BPermissionData) Creates a new B2B permission based on the data passed in theB2BPermissionDataparameter.addPermissionToCustomer(String customerUid, String permissionCode) Adds a permission to a customer.addPermissionToUserGroup(String userGroupUid, String permissionCode) Adds a permission to aB2BUserGroupModel.voidenableDisablePermission(String permissionCode, boolean enable) Enable/disable a permission.getB2BPermissionTypeDataForPermission(B2BPermissionTypeEnum permissionTypeEnum) Converts the givenB2BPermissionTypeEnuminto aB2BPermissionTypeDataobject and returns it.Returns a collection of available B2B permission types.getPagedPermissions(PageableData pageableData) Returns pagedB2BPermissionDatafor the givenPageableData.getPagedPermissionsForCustomer(PageableData pageableData, String customerUid) Gets the list of permissions of the customers.getPagedPermissionsForUserGroup(PageableData pageableData, String userGroupUid) Returns a paginated list of permissions associated to aB2BUserGroupModel.getPermissionDetails(String permissionCode) ReturnsB2BPermissionDatafor a given unique id.removePermissionFromCustomer(String customerUid, String permissionCode) Removes a permission from a customer.removePermissionFromUserGroup(String userGroupUid, String permissionCode) Removes a permission from aB2BUserGroupModel.voidupdatePermissionDetails(B2BPermissionData b2BPermissionData) Updates an existing B2B permission.
-
Method Details
-
getPagedPermissions
Returns pagedB2BPermissionDatafor the givenPageableData.- Parameters:
pageableData-PageableDataobject defining the paging properties- Returns:
SearchPageDatacontaining the pagedB2BPermissionData.
-
getPermissionDetails
ReturnsB2BPermissionDatafor a given unique id.- Parameters:
permissionCode- the code of the permission code- Returns:
B2BPermissionDatafor the given uid.
-
getB2BPermissionTypes
Collection<B2BPermissionTypeData> getB2BPermissionTypes()Returns a collection of available B2B permission types.- Returns:
CollectionofB2BPermissionTypeData
-
updatePermissionDetails
Updates an existing B2B permission.- Parameters:
b2BPermissionData-B2BPermissionDataholding the update information.
-
enableDisablePermission
Enable/disable a permission. active set to true denotes enabling permission and vice versa.- Parameters:
permissionCode- the code of the permissionenable- true to enable the permission, false to disable it
-
getB2BPermissionTypeDataForPermission
B2BPermissionTypeData getB2BPermissionTypeDataForPermission(B2BPermissionTypeEnum permissionTypeEnum) Converts the givenB2BPermissionTypeEnuminto aB2BPermissionTypeDataobject and returns it.- Parameters:
permissionTypeEnum- theB2BPermissionTypeEnumto convert.- Returns:
B2BPermissionTypeDataresult of the conversion.
-
addPermission
Creates a new B2B permission based on the data passed in theB2BPermissionDataparameter.- Parameters:
b2BPermissionData-B2BPermissionDataobject holding the data for the permission to be created.- Throws:
DuplicateUidException
-
getPagedPermissionsForCustomer
SearchPageData<B2BPermissionData> getPagedPermissionsForCustomer(PageableData pageableData, String customerUid) Gets the list of permissions of the customers.- Parameters:
pageableData-PageableDataobject defining the paging propertiescustomerUid- the uid of the customer- Returns:
- the
SearchPageData
-
addPermissionToCustomer
Adds a permission to a customer.- Parameters:
customerUid- the uid of the customerpermissionCode- the code of the permission- Returns:
- the
B2BSelectionData
-
removePermissionFromCustomer
Removes a permission from a customer.- Parameters:
customerUid- the uid of the customerpermissionCode- the code of the permission- Returns:
- Returns the
B2BSelectionData
-
getPagedPermissionsForUserGroup
SearchPageData<B2BPermissionData> getPagedPermissionsForUserGroup(PageableData pageableData, String userGroupUid) Returns a paginated list of permissions associated to aB2BUserGroupModel.- Parameters:
pageableData-PageableDataobject defining the paging propertiesuserGroupUid- the uid of the user group- Returns:
- a paginated list of permissions
-
addPermissionToUserGroup
Adds a permission to aB2BUserGroupModel.- Parameters:
userGroupUid- the uid of the user grouppermissionCode- the code of the permission- Returns:
- a data object with information about the selected permission
-
removePermissionFromUserGroup
Removes a permission from aB2BUserGroupModel.- Parameters:
userGroupUid- the uid of the user grouppermissionCode- the code of the permission- Returns:
- a data object with information about the deselected permission
-