AssignmentStoreMixin
Mixin

This is a mixin, containing functionality related to managing assignments.

It is consumed by the regular AssignmentStore class and Scheduler Pros counterpart.

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class

loadPriority : Number

private

CrudManager must load stores in the correct order. Lowest first.
syncPriority : Number

private

CrudManager must sync stores in the correct order. Lowest first.

Properties

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

isAssignmentStoreMixin : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of AssignmentStoreMixin class, or subclass thereof.

isAssignmentStoreMixin : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of AssignmentStoreMixin class, or subclass thereof.
data : AssignmentModelConfig
Applies a new dataset to the AssignmentStore. Use it to plug externally fetched data into the store.

NOTE: References (assignments, resources) on the assignments are determined async by a calculation engine. Thus they cannot be directly accessed after assigning the new dataset.

For example:
```
assignmentStore.data = [{ eventId, resourceId }];
// assignmentStore.first.event is not yet available
```
To guarantee references are available, wait for calculations for finish:
```
assignmentStore.data = [{ eventId, resourceId  }];
await assignmentStore.project.commitAsync();
// assignmentStore.first.event is available
```
Alternatively use loadDataAsync() instead:
```
await assignmentStore.loadDataAsync([{ eventId, resourceId }]);
// assignmentStore.first.event is available
```

Functions

Functions are methods available for calling on the class

getOccurrence( originalAssignment, occurrence )
: Object

internal

Returns a "fake" assignment used to identify a certain occurrence of a recurring event. If passed the original event, it returns originalAssignment.
assignEventToResource( event, resources, assignmentSetupFn, removeExistingAssignmentsfalse )
: AssignmentModel[]

Creates and adds assignment record(s) for a given event and resource(s).
unassignEventFromResource( event, resources )
: AssignmentModel/AssignmentModel[]

Removes assignment record for a given event and resource.
getAssignmentForEventAndResource( event, resource )
: AssignmentModel

Returns an assignment record for a given event and resource
getAssignmentsForResource( resource )
: AssignmentModel[]

Returns all assignments for a given resource.
getEventsForResource( resource )
: TimeSpan[]

Returns all events assigned to a resource
getResourcesForEvent( event )
: ResourceModel[]

Returns all resources assigned to an event.
isEventAssignedToResource( event, resource )
: Boolean

Checks whether an event is assigned to a resource.
mapAssignmentsForEvent( event, fn, filterFn )
: EventModel[]/Array

Maps over event assignments.
mapAssignmentsForResource( resource, fn, filterFn )
: ResourceModel[]/Array

Maps over resource assignments.
removeAssignmentsForEvent( event )

Removes all assignments for given event
removeAssignmentsForResource( resource )

Removes all assignments for given resource

add( records, silent )

: AssignmentModel[]

Add assignments to the store.

NOTE: References (event, resource) on the assignments are determined async by a calculation engine. Thus they cannot be directly accessed after using this function.

For example:

const [assignment] = assignmentStore.add({ eventId, resourceId });
// assignment.event is not yet available

To guarantee references are set up, wait for calculations for finish:

const [assignment] = assignmentStore.add({ eventId, resourceId });
await assignmentStore.project.commitAsync();
// assignment.event is available (assuming EventStore is loaded and so on)

Alternatively use addAsync() instead:

const [assignment] = await assignmentStore.addAsync({ eventId, resourceId });
// assignment.event is available (assuming EventStore is loaded and so on)

addAsync( records, silent )
: AssignmentModel[]

ASYNC
Add assignments to the store and triggers calculations directly after. Await this function to have up to date references on the added assignments.
```
const [assignment] = await assignmentStore.addAsync({ eventId, resourceId });
// assignment.event is available (assuming EventStore is loaded and so on)
```
loadDataAsync( data )
: Promise

ASYNC
Applies a new dataset to the AssignmentStore and triggers calculations directly after. Use it to plug externally fetched data into the store.
```
await assignmentStore.loadDataAsync([{ eventId, resourceId }]);
// assignmentStore.first.event is available
```

Source path

Scheduler/data/mixin/AssignmentStoreMixin.js

Inheritance tree1

AssignmentStoreMixin

AssignmentStoreMixin Mixin