Interface Role

Roles are aggregations of multiple Users with a given purpose.

Hierarchy

binding.Role
- Role

Index

Properties

_metadata

_metadata: Metadata

Contains the metadata of this managed object

`Optional` `Readonly` createdAt

createdAt?: null | Date

Date of the creation of the object

Name

createdAt

Member Of

Entity.prototype

name

name: null | string = null

The name of the role

`Optional` `Readonly` updatedAt

updatedAt?: null | Date

Last update date of the object

Name

updatedAt

Member Of

Entity.prototype

users

users: null | Set<model.User> = null

A set of users which have this role

Accessors

acl

get acl(): Acl
The object read/write permissions

Returns Acl
Inherited from binding.Role.acl
- Defined in lib/binding/Entity.ts:91

id

get id(): null | string
The unique id of this object

Sets the unique id of this object, if the id is not formatted as an valid id, it will be used as the key component of the id has the same affect as setting the key

Returns null | string
Inherited from binding.Role.id
- Defined in lib/binding/Entity.ts:44
set id(value: null | string): void
Parameters
- value: null | string
Returns void
Inherited from binding.Role.id
- Defined in lib/binding/Entity.ts:49

key

get key(): null | string
The unique key part of the id When the key of the unique id is set an error will be thrown if an id is already set.

Returns null | string
Inherited from binding.Role.key
- Defined in lib/binding/Entity.ts:67
set key(value: null | string): void
Parameters
- value: null | string
Returns void
Inherited from binding.Role.key
- Defined in lib/binding/Entity.ts:72

version

get version(): null | number
The version of this object

Returns null | number
Inherited from binding.Role.version
- Defined in lib/binding/Entity.ts:81

Methods

addUser

addUser(user: model.User): void
Add the given user to this role
Parameters
- user: model.User
  
  The user to add
Returns void
Inherited from Role.addUser
- Defined in lib/binding/Role.ts:32

attach

attach(db: EntityManager): void
Attach this object to the given db

Returns
Parameters
- db: EntityManager
  
  The db which will be used for future crud operations
Returns void
Inherited from Role.attach
- Defined in lib/binding/Entity.ts:102

attr

attr(): void
Returns void
Inherited from Role.attr
- Defined in lib/binding/Entity.ts:267

delete

delete(options?: {
depth?: number | boolean;
force?: boolean;
}, doneCallback?: any, failCallback?: any): Promise<model.Role>
Deletes an existing object

Returns
A Promise that will be fulfilled when the asynchronous operation completes.

Method
Parameters
- Optional options: {
  depth?: number | boolean;
  force?: boolean;
  }
  
  The remove options
  - Optional depth?: number | boolean
    
    The object depth which will be removed. Depth 0 removes this object only, true removes objects by reachability.
  - Optional force?: boolean
    
    Force the remove operation, the version will not be validated.
- Optional doneCallback: any
  
  Called when the operation succeed.
- Optional failCallback: any
  
  Called when the operation failed.
Returns Promise<model.Role>
Inherited from Role.delete
- Defined in lib/binding/Entity.ts:240

getReferencing

getReferencing(options?: {
classes: string[];
}): Promise<Entity[]>
Get all objects which refer to this object

Returns
A promise resolving with an array of all referencing objects

Method
Parameters
- Optional options: {
  classes: string[];
  }
  
  Some options to pass
  - classes: string[]
    
    An array of class names to filter for, null for no filter
Returns Promise<Entity[]>
Inherited from Role.getReferencing
- Defined in lib/binding/Entity.ts:302

hasUser

hasUser(user: model.User): boolean
Test if the given user has this role

Returns
true if the given user has this role, otherwise false
Parameters
- user: model.User
  
  The user to check
Returns boolean
Inherited from Role.hasUser
- Defined in lib/binding/Role.ts:23

insert

insert(options?: {
depth?: number | boolean;
refresh?: boolean;
}, doneCallback?: any, failCallback?: any): Promise<model.Role>
Inserts a new object. Inserts the object if it doesn't exists and raise an error if the object already exist.

Returns
A Promise that will be fulfilled when the asynchronous operation completes.

Method
Parameters
- Optional options: {
  depth?: number | boolean;
  refresh?: boolean;
  }
  
  The insertion options
  - Optional depth?: number | boolean
    
    The object depth which will be inserted. Depth 0 insert this object only, true inserts objects by reachability.
  - Optional refresh?: boolean
    
    Refresh the local object state from remote.
- Optional doneCallback: any
  
  Called when the operation succeed.
- Optional failCallback: any
  
  Called when the operation failed.
Returns Promise<model.Role>
Inherited from Role.insert
- Defined in lib/binding/Entity.ts:161

load

load(options?: {
depth?: number | boolean;
refresh?: boolean;
}, doneCallback?: any, failCallback?: any): Promise<model.Role>
Resolves the referenced object in the specified depth

Only unresolved objects will be loaded unless the refresh option is specified.

Removed objects will be marked as removed.

Returns
A Promise that will be fulfilled when the asynchronous operation completes.

Method
Parameters
- Optional options: {
  depth?: number | boolean;
  refresh?: boolean;
  }
  
  The load options
  - Optional depth?: number | boolean
    
    The object depth which will be loaded. Depth set to true loads objects by reachability.
  - Optional refresh?: boolean
    
    Refresh the local object state from remote.
- Optional doneCallback: any
  
  Called when the operation succeed.
- Optional failCallback: any
  
  Called when the operation failed.
Returns Promise<model.Role>
Inherited from Role.load
- Defined in lib/binding/Entity.ts:212

optimisticSave

optimisticSave(cb: ((entity: model.Role, abort: (() => void)) => any), doneCallback?: any, failCallback?: any): Promise<model.Role>
Saves the object and repeats the operation if the object is out of date

In each pass the callback will be called. Ths first parameter of the callback is the entity and the second one is a function to abort the process.

Returns
A Promise that will be fulfilled when the asynchronous operation completes.

Method
Parameters
- cb: ((entity: model.Role, abort: (() => void)) => any)
  
  Will be called in each pass
  - - (entity: model.Role, abort: (() => void)): any
    - Parameters
      
      entity: model.Role
      
      abort: (() => void)
      
      (): void
      
      Returns void
      
      Returns any
- Optional doneCallback: any
  
  Called when the operation succeed.
- Optional failCallback: any
  
  Called when the operation failed.
Returns Promise<model.Role>
Inherited from Role.optimisticSave
- Defined in lib/binding/Entity.ts:262

partialUpdate

partialUpdate(operations?: Json): EntityPartialUpdateBuilder<model.Role>
Starts a partial update on this entity

Returns
Parameters
- Optional operations: Json
  
  initial operations which should be executed
Returns EntityPartialUpdateBuilder<model.Role>
Inherited from Role.partialUpdate
- Defined in lib/binding/Entity.ts:289

ready

ready(): Promise<model.Role>
Waits on the previously requested operation on this object completes operations on this object is completed.

Returns
A promise which completes successfully, when the previously requested operation completes

Returns Promise<model.Role>
Inherited from Role.ready
- Defined in lib/binding/Entity.ts:113
ready<R>(doneCallback: ((entity: model.Role) => R)): Promise<R>
Waits on the previously requested operation on this object completes

Returns
A promise which completes successfully, when the previously requested operation completes
Type Parameters
- R
Parameters
- doneCallback: ((entity: model.Role) => R)
  
  The callback which will be invoked when the previously operations on this object is completed.
  - - (entity: model.Role): R
    - Parameters
      
      entity: model.Role
      
      Returns R
Returns Promise<R>
Inherited from Role.ready
- Defined in lib/binding/Entity.ts:122

removeUser

removeUser(user: model.User): void
Remove the given user from this role
Parameters
- user: model.User
  
  The user to remove
Returns void
Inherited from Role.removeUser
- Defined in lib/binding/Role.ts:49

save

save(options?: {
    depth?: number | boolean;
    force?: boolean;
    refresh?: boolean;
}, doneCallback?: any, failCallback?: any): Promise<model.Role>
Saves the object. Inserts the object if it doesn't exists and updates the object if the object exist.

Returns
A Promise that will be fulfilled when the asynchronous operation completes.
Parameters
- Optional options: {
      depth?: number | boolean;
      force?: boolean;
      refresh?: boolean;
  }
  
  The save options
  - Optional depth?: number | boolean
    
    The object depth which will be saved. Depth 0 save this object only, true saves the objects by reachability.
  - Optional force?: boolean
    
    Force the save operation, the version will not be validated.
  - Optional refresh?: boolean
    
    Refresh the local object state from remote.
- Optional doneCallback: any
  
  Called when the operation succeed.
- Optional failCallback: any
  
  Called when the operation failed.
Returns Promise<model.Role>
Inherited from Role.save
- Defined in lib/binding/Entity.ts:140

toJSON

toJSON(options?: boolean | {
depth?: number | boolean;
excludeMetadata?: boolean;
}): Json
Converts the object to an JSON-Object

Returns
JSON-Object

Method
Parameters
- Optional options: boolean | {
  depth?: number | boolean;
  excludeMetadata?: boolean;
  }
  
  to json options by default excludes the metadata
Returns Json
Inherited from Role.toJSON
- Defined in lib/binding/Entity.ts:351

toString

toString(): string
Returns this object identifier or the baqend type of this object

Returns
the object id or type whatever is available

Returns string
Inherited from Role.toString
- Defined in lib/binding/Entity.ts:337

update

update(options?: {
    depth?: number | boolean;
    force?: boolean;
    refresh?: boolean;
}, doneCallback?: any, failCallback?: any): Promise<model.Role>
Updates an existing object

Updates the object if it exists and raise an error if the object doesn't exist.

Returns
A Promise that will be fulfilled when the asynchronous operation completes.

Method
Parameters
- Optional options: {
      depth?: number | boolean;
      force?: boolean;
      refresh?: boolean;
  }
  
  The update options
  - Optional depth?: number | boolean
    
    The object depth which will be updated. Depth 0 updates this object only, true updates objects by reachability.
  - Optional force?: boolean
    
    Force the update operation, the version will not be validated, only existence will be checked.
  - Optional refresh?: boolean
    
    Refresh the local object state from remote.
- Optional doneCallback: any
  
  Called when the operation succeed.
- Optional failCallback: any
  
  Called when the operation failed.
Returns Promise<model.Role>
Inherited from Role.update
- Defined in lib/binding/Entity.ts:187

validate

validate(): ValidationResult
Validates the entity by using the validation code of the entity type

Returns
Contains the result of the Validation

Method

Returns ValidationResult
Inherited from Role.validate
- Defined in lib/binding/Entity.ts:278

Interface Role

Hierarchy

Index

Properties

Accessors

Methods

Properties

_metadata

Optional Readonly createdAt

Name

Member Of

name

Optional Readonly updatedAt

Name

Member Of

users

Accessors

acl

Returns Acl

id

Returns null | string

Parameters

value: null | string

Returns void

key

Returns null | string

Parameters

value: null | string

Returns void

version

Returns null | number

Methods

addUser

Parameters

user: model.User

Returns void

attach

Returns

Parameters

db: EntityManager

Returns void

attr

Returns void

delete

Returns

Method

Parameters

Optional options: { depth?: number | boolean; force?: boolean; }

Optional depth?: number | boolean

Optional force?: boolean

Optional doneCallback: any

Optional failCallback: any

Returns Promise<model.Role>

getReferencing

Returns

Method

Parameters

Optional options: { classes: string[]; }

classes: string[]

Returns Promise<Entity[]>

hasUser

Returns

Parameters

user: model.User

Returns boolean

insert

Returns

Method

Parameters

Optional options: { depth?: number | boolean; refresh?: boolean; }

Optional depth?: number | boolean

Optional refresh?: boolean

Optional doneCallback: any

Optional failCallback: any

Returns Promise<model.Role>

load

Returns

Method

Parameters

Optional options: { depth?: number | boolean; refresh?: boolean; }

`Optional` `Readonly` createdAt

`Optional` `Readonly` updatedAt

`Optional` options: {
depth?: number | boolean;
force?: boolean;
}

`Optional` depth?: number | boolean

`Optional` force?: boolean

`Optional` doneCallback: any

`Optional` failCallback: any

`Optional` options: {
classes: string[];
}

`Optional` options: {
depth?: number | boolean;
refresh?: boolean;
}

`Optional` depth?: number | boolean

`Optional` refresh?: boolean

`Optional` doneCallback: any

`Optional` failCallback: any

`Optional` options: {
depth?: number | boolean;
refresh?: boolean;
}

`Optional` depth?: number | boolean

`Optional` refresh?: boolean

`Optional` doneCallback: any

`Optional` failCallback: any

`Optional` doneCallback: any

`Optional` failCallback: any

`Optional` operations: Json

`Optional` options: {
depth?: number | boolean;
force?: boolean;
refresh?: boolean;
}

`Optional` depth?: number | boolean

`Optional` force?: boolean

`Optional` refresh?: boolean

`Optional` doneCallback: any

`Optional` failCallback: any

`Optional` options: boolean | {
depth?: number | boolean;
excludeMetadata?: boolean;
}

`Optional` options: {
depth?: number | boolean;
force?: boolean;
refresh?: boolean;
}

`Optional` depth?: number | boolean

`Optional` force?: boolean

`Optional` refresh?: boolean

`Optional` doneCallback: any

`Optional` failCallback: any