Class ACLRecord

Page Contents

Inheritance Relationships

Base Type

Class Documentation

class ACLRecord : public axr::sdk::Object

The ACLRecord interface describes a single permissions entry in an AccessControlList that grants or denies a set of permissions to a single user or role.

Each permission can be one of the following actions:

  • Create - The user or role can create a new record or object.

  • Read - The user or role can read the record or object.

  • Update - The user or role can modify existing records or objects.

  • Delete - The user or role can delete existing records or objects.

  • Special - The user or role has special prilieges to edit the ACL permissions.

  • Full - The user or role has total control over the record or object and supersedes any of the above.

Public Functions

inline ACLRecord()
inline ACLRecord(const ACLRecord &value)
inline ACLRecord(ACLRecord &&value)
inline virtual ~ACLRecord()
inline virtual ACLRecord &SetProperties(const std::map<utility::string_t, Variant> &value) override

Sets the object’s underlying map of stored values.

inline virtual ACLRecord &SetProperties(std::map<utility::string_t, Variant> &&value) override

Sets the underlying map of stored values for the object.

inline virtual ACLRecord &SetProperty(const utility::char_t *name, const Variant &value) override

Sets the property of the given name to the provided value.

inline virtual ACLRecord &SetProperty(const utility::string_t &name, const Variant &value) override

Sets the property of the given name to the provided value.

utility::string_t GetUserOrRoleId() const

The unique identifier of the user or role that the record belongs to.

ACLRecord &SetUserOrRoleId(const utility::string_t &value)

The unique identifier of the user or role that the record belongs to.

Parameters

value – The value to set.

std::optional<bool> GetCreate() const

Indicates that the user or role has permission to create new records of the entity.

ACLRecord &SetCreate(std::optional<bool> value)

Indicates that the user or role has permission to create new records of the entity.

std::optional<bool> GetRead() const

Indicates that the user or role has permission to read records of the entity.

ACLRecord &SetRead(std::optional<bool> value)

Indicates that the user or role has permission to read records of the entity.

std::optional<bool> GetUpdate() const

Indicates that the user or role has permission to modify existing records of the entity.

ACLRecord &SetUpdate(std::optional<bool> value)

Indicates that the user or role has permission to modify existing records of the entity.

std::optional<bool> GetDelete() const

Indicates that the user or role has permission to delete existing records of the entity.

ACLRecord &SetDelete(std::optional<bool> value)

Indicates that the user or role has permission to delete existing records of the entity.

std::optional<bool> GetSpecial() const

Indicates that the user or role has special permission over records of the entity. The exact meaning of this may vary by service.

ACLRecord &SetSpecial(std::optional<bool> value)

Indicates that the user or role has special permission over records of the entity. The exact meaning of this may vary by service.

std::optional<bool> GetFull() const

Indicates that the user or role has total control over records of the entity. This supersedes all of the above permissions.

ACLRecord &SetFull(std::optional<bool> value)

Indicates that the user or role has total control over records of the entity. This supersedes all of the above permissions.