RoleGraph

scroll.internal.graph.RoleGraph
trait RoleGraph

API defining an generic interface for all kind of role graphs.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

def addBinding(player: AnyRef, role: AnyRef): Unit

Adds a plays relationship between core and role.

Adds a plays relationship between core and role.

Value parameters

player

the player instance to add the given role

role

the role instance to add

Attributes

def addPart(other: RoleGraph): Boolean

RoleGraph given as other would get part of this.

RoleGraph given as other would get part of this.

Value parameters

other

the RoleGraph for integration in this one.

Attributes

def allPlayers: Seq[AnyRef]

Returns a Seq of all players

Returns a Seq of all players

Attributes

Returns

a Seq of all players

def containsPlayer(player: AnyRef): Boolean

Checks if the role graph contains the given player.

Checks if the role graph contains the given player.

Value parameters

player

the player instance to check

Attributes

Returns

true if the role graph contains the given player, false otherwise

def coreFor(role: AnyRef): Seq[AnyRef]
def detach(other: RoleGraph): Unit

Removes all players and plays-relationships specified in other from this RoleGraph.

Removes all players and plays-relationships specified in other from this RoleGraph.

Value parameters

other

the RoleGraph all players and plays-relationships specified in should removed from this

Attributes

def facets(player: AnyRef): Seq[Enumeration#Value]

Returns a Seq of all facets attached to the given player (core object).

Returns a Seq of all facets attached to the given player (core object).

Value parameters

player

the player instance to get the facets for

Attributes

Returns

a Seq of all facets of core player. Returns an empty Seq if the given player is not in the role-playing graph.

def predecessors(player: AnyRef): Seq[AnyRef]

Returns a list of all predecessors of the given player, i.e. a transitive closure of its cores (deep roles).

Returns a list of all predecessors of the given player, i.e. a transitive closure of its cores (deep roles).

Value parameters

player

the player instance to calculate the cores of

Attributes

Returns

a list of all predecessors of the given player

def removeBinding(player: AnyRef, role: AnyRef): Unit

Removes a plays relationship between core and role.

Removes a plays relationship between core and role.

Value parameters

player

the player instance to remove the given role from

role

the role instance to remove

Attributes

def removePlayer(player: AnyRef): Unit

Removes the given player from the graph. This should remove its binding too!

Removes the given player from the graph. This should remove its binding too!

Value parameters

player

the player to remove

Attributes

def roles(player: AnyRef): Seq[AnyRef]

Returns a Seq of all roles attached to the given player (core object).

Returns a Seq of all roles attached to the given player (core object).

Value parameters

player

the player instance to get the roles for

Attributes

Returns

a Seq of all roles of core player. Returns an empty Seq if the given player is not in the role-playing graph.