Options
All
  • Public
  • Public/Protected
  • All
Menu

This a base mixin for every Model that belongs to a ChronoGraph powered project.

The model with this mixin, supposes that it will be "joining" a store that is already part of a project, so that such model can take a reference to the project from it.

It provides 2 template methods joinProject and leaveProject, which can be overridden in other mixins (they should always call super implementation, because it adds/remove the model to/from the ChronoGraph instance)

tier

enterprise

tier-for-gantt

core

Hierarchy

Index

Properties

$project

The project instance, this entity belongs to.

graph

graph: Replica

A reference to the graph, this entity belongs to. Initially empty, and is populated when the entity instance is added to the replica (Replica.addEntity)

project

The project instance, this entity belongs to.

Accessors

$

  • get $(): {}
  • An object, which properties corresponds to the ChronoGraph Identifiers, created for every field.

    For example:

    class Author extends Entity.mix(Base) {
        @field()
        firstName       : string
        @field()
        lastName        : string
    }
    
    const author = Author.new()
    
    // identifier for the field `firstName`
    author.$.firstName
    
    const firstName = replica.read(author.$.firstName)

    Returns {}

$$

  • A graph identifier, that represents the whole entity.

    Returns EntityIdentifier

$entity

  • An EntityMeta instance, representing the "meta" information about the entity class. It is shared among all instances of the class.

    Returns EntityMeta

Static $entity

  • An EntityMeta instance, representing the "meta" information about the entity class. It is shared among all instances of the class.

    Returns EntityMeta

Methods

commit

  • This is a convenience method, that just delegates to the ChronoGraph.commit method of this entity's graph.

    If there's no graph (entity has not been added to any replica) a CommitZero constant will be returned.

    Parameters

    Returns CommitResult

commitAsync

  • This is a convenience method, that just delegates to the ChronoGraph.commitAsync method of this entity's graph.

    If there's no graph (entity has not been added to any replica) a resolved promise with CommitZero constant will be returned.

    Parameters

    Returns Promise<CommitResult>

enterGraph

  • enterGraph(replica: Replica): void
  • This method is called when entity is added to some replica.

    Parameters

    Returns void

getAssignmentById

  • getAssignmentById(id: ModelId): this["project"]["assignmentStore"]["modelInstanceT"]
  • Convenience method to get the instance of assignment by its id.

    Parameters

    • id: ModelId

    Returns this["project"]["assignmentStore"]["modelInstanceT"]

getAssignmentStore

  • getAssignmentStore(): this["project"]["assignmentStore"]
  • Convenience method to get the instance of the assignment store in the project instance, this entity belongs to.

    Returns this["project"]["assignmentStore"]

getCalendarById

  • getCalendarById(id: ModelId): this["project"]["calendarManagerStore"]["modelInstanceT"]
  • Convenience method to get the instance of calendar by its id.

    Parameters

    • id: ModelId

    Returns this["project"]["calendarManagerStore"]["modelInstanceT"]

getCalendarManagerStore

  • getCalendarManagerStore(): this["project"]["calendarManagerStore"]
  • Convenience method to get the instance of the calendar manager store in the project instance, this entity belongs to.

    Returns this["project"]["calendarManagerStore"]

getDependencyById

  • getDependencyById(id: ModelId): this["project"]["dependencyStore"]["modelInstanceT"]
  • Convenience method to get the instance of dependency by its id.

    Parameters

    • id: ModelId

    Returns this["project"]["dependencyStore"]["modelInstanceT"]

getDependencyStore

  • getDependencyStore(): this["project"]["dependencyStore"]
  • Convenience method to get the instance of the dependency store in the project instance, this entity belongs to.

    Returns this["project"]["dependencyStore"]

getEventById

  • getEventById(id: ModelId): this["project"]["eventStore"]["modelInstanceT"]
  • Convenience method to get the instance of event by its id.

    Parameters

    • id: ModelId

    Returns this["project"]["eventStore"]["modelInstanceT"]

getEventStore

  • getEventStore(): this["project"]["eventStore"]
  • Convenience method to get the instance of the event store in the project instance, this entity belongs to.

    Returns this["project"]["eventStore"]

getGraph

getProject

  • getProject(): this["project"]

getResourceById

  • getResourceById(id: ModelId): this["project"]["resourceStore"]["modelInstanceT"]
  • Convenience method to get the instance of resource by its id.

    Parameters

    • id: ModelId

    Returns this["project"]["resourceStore"]["modelInstanceT"]

getResourceStore

  • getResourceStore(): this["project"]["resourceStore"]
  • Convenience method to get the instance of the resource store in the project instance, this entity belongs to.

    Returns this["project"]["resourceStore"]

joinProject

  • joinProject(): void
  • Template method, which is called when model is joining the project (through joining some store that has already joined the project)

    Returns void

leaveGraph

  • This method is called when entity is removed from the replica it's been added to.

    Parameters

    Returns void

leaveProject

  • leaveProject(isReplacing?: boolean): void
  • Template method, which is called when model is leaving the project (through leaving some store usually)

    Parameters

    • Default value isReplacing: boolean = false

    Returns void

setProject

  • setProject(project: this["project"]): this["project"]
  • The method to set the project instance, this entity belongs to.

    Parameters

    • project: this["project"]

    Returns this["project"]

userProvidedValue

Generated using TypeDoc