Options
All
  • Public
  • Public/Protected
  • All
Menu

This is a mixin enabling events to handle assignments. It is mixed by CoreHasAssignmentsMixin and BaseHasAssignmentsMixin. It provides a collection of all assignments, which reference this event.

Doesn't affect scheduling.

tier

community

Hierarchy

Index

Properties

$project

The project instance, this entity belongs to.

Methods

assign

  • assign(resource: InstanceType<this["project"]["resourceModelClass"]>): Promise<any>
  • A method which assigns a resource to the current event

    Parameters

    • resource: InstanceType<this["project"]["resourceModelClass"]>

    Returns Promise<any>

getAssignmentFor

  • getAssignmentFor(resource: InstanceType<this["project"]["resourceModelClass"]>): InstanceType<this["project"]["assignmentModelClass"]> | null
  • If a given resource is assigned to this task, returns a BaseAssignmentMixin instance for it. Otherwise returns null

    Parameters

    • resource: InstanceType<this["project"]["resourceModelClass"]>

    Returns InstanceType<this["project"]["assignmentModelClass"]> | null

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"]

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"]

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"]

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"]

getProject

  • getProject(): this["project"]

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

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"]

unassign

  • unassign(resource: InstanceType<this["project"]["resourceModelClass"]>): Promise<any>
  • A method which unassigns a resource from the current event

    Parameters

    • resource: InstanceType<this["project"]["resourceModelClass"]>

    Returns Promise<any>

Generated using TypeDoc