Class UserPermission
java.lang.Object
com.broadleafcommerce.auth.resource.domain.UserPermission
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
getId()
Indicates when this record was last updated.getName()
The name for this permission.int
hashCode()
boolean
Indicates whether this permission is an account type permission.boolean
This entity is soft-deleted instead of hard-deleted, and this field is set totrue
when the entity is soft-deleted.boolean
In the large majority of cases, this should be set to true.void
setAccountPermission
(boolean accountPermission) Indicates whether this permission is an account type permission.void
setArchived
(boolean archived) This entity is soft-deleted instead of hard-deleted, and this field is set totrue
when the entity is soft-deleted.void
void
setLastUpdated
(Instant lastUpdated) Indicates when this record was last updated.void
The name for this permission.void
setUserAssignable
(boolean userAssignable) In the large majority of cases, this should be set to true.toRef()
toString()
-
Constructor Details
-
UserPermission
-
UserPermission
public UserPermission()
-
-
Method Details
-
toRef
-
getId
-
getName
The name for this permission. This is not guaranteed to be unique. -
getLastUpdated
Indicates when this record was last updated. -
isArchived
public boolean isArchived()This entity is soft-deleted instead of hard-deleted, and this field is set totrue
when the entity is soft-deleted. -
isAccountPermission
public boolean isAccountPermission()Indicates whether this permission is an account type permission. Account users are always customers, so these permissions are only assignable toaccount roles
. Account permissions are the only permissions that may be assigned to an account role. -
isUserAssignable
public boolean isUserAssignable()In the large majority of cases, this should be set to true. If true, this permission is user assignable. If false, users may not be assigned this permission. This value is useful in the scenario that certain functions may require an API to be exposed, but not be directly invoked by a user. For example, system-to-system calls may need to be invoked for a specific process, but those calls should never be directly invoked by a user.Attempts to assign a non user-assignable permission to a user will result in an error. In addition, non user-assignable permissions may not be assigned to a role.
-
setId
-
setName
The name for this permission. This is not guaranteed to be unique. -
setLastUpdated
Indicates when this record was last updated. -
setArchived
public void setArchived(boolean archived) This entity is soft-deleted instead of hard-deleted, and this field is set totrue
when the entity is soft-deleted. -
setAccountPermission
public void setAccountPermission(boolean accountPermission) Indicates whether this permission is an account type permission. Account users are always customers, so these permissions are only assignable toaccount roles
. Account permissions are the only permissions that may be assigned to an account role. -
setUserAssignable
public void setUserAssignable(boolean userAssignable) In the large majority of cases, this should be set to true. If true, this permission is user assignable. If false, users may not be assigned this permission. This value is useful in the scenario that certain functions may require an API to be exposed, but not be directly invoked by a user. For example, system-to-system calls may need to be invoked for a specific process, but those calls should never be directly invoked by a user.Attempts to assign a non user-assignable permission to a user will result in an error. In addition, non user-assignable permissions may not be assigned to a role.
-
toString
-
equals
-
canEqual
-
hashCode
public int hashCode()
-