v7.3.0

AssignmentModel

This model represents a single assignment of a resource to an event in the scheduler, usually added to a AssignmentStore.

It is a subclass of the Model class. Please refer to the documentation for that class to become familiar with the base interface of this class.

Fields and references

An Assignment has the following fields:

  • id - The id of the assignment
  • resourceId - The id of the resource assigned (optionally replaced with resource for load)
  • eventId - The id of the event to which the resource is assigned (optionally replaced with event for load)

The data source for these fields can be customized by subclassing this class:

class MyAssignment extends AssignmentModel {
  static get fields() {
      return [
         { name : 'resourceId', dataSource : 'linkedResource' }
      ];
  }
}

After load and project normalization, these references are accessible (assuming their respective stores are loaded):

  • event - The linked event record
  • resource - The linked resource record

Async resolving of references

As described above, an assignment links an event to a resource. It holds references to an event record and a resource record. These references are populated async, using the calculation engine of the project that the assignment via its store is a part of. Because of this asyncness, references cannot be used immediately after modifications:

assignment.resourceId = 2;
// assignment.resource is not yet available

To make sure references are updated, wait for calculations to finish:

assignment.resourceId = 2;
await assignment.project.commitAsync();
// assignment.resource is available

As an alternative, you can also use setAsync() to trigger calculations directly after the change:

await assignment.setAsync({ resourceId : 2});
// assignment.resource is available

See also

No results

Fields

Fields belong to a Model class and define the Model data structure
  • event : String/Number/EventModel

    Id for event to assign. Can be used as an alternative to eventId, but please note that after load it will be populated with the actual event and not its id. This field is not persistable.

  • resource : String/Number/ResourceModel

    Id for resource to assign to. Can be used as an alternative to resourceId, but please note that after load it will be populated with the actual resource and not its id. This field is not persistable.

Properties

Properties are getters/setters or publicly accessible variables on this class

Source path

Scheduler/model/AssignmentModel.js

Contents