AbstractCrudManager
Abstract

This is an abstract class serving as the base for the CrudManager class. It implements basic mechanisms to organize batch communication with a server. Yet it does not contain methods related to data transfer nor encoding. These methods are to be provided in sub-classes by consuming the appropriate mixins.

For example, this is how the class can be used to implement an JSON encoding system:

// let's make new CrudManager using AJAX as a transport system and JSON for encoding
class MyCrudManager extends JsonEncode(AjaxTransport(AbstractCrudManager)) {

}

Data transfer and encoding methods

These are methods that must be provided by subclasses of this class:

Configs

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

stores : Store[]/String[]/CrudManagerStoreDescriptor[]/StoreConfig

Sets the list of stores controlled by the CRUD manager.

When adding a store to the CrudManager, make sure the server response format is correct for load and sync requests. Learn more in the Working with data guide.

Store can be provided as in instance, using its id or as an CrudManagerStoreDescriptor object.

Has a corresponding runtime stores property.

Properties

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

isAbstractCrudManager : Booleantrue

READONLY

static

ADVANCED

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

inlineData : Object

Get or set data of CrudManager stores. The returned data is identical to what toJSON returns:


const data = scheduler.crudManager.inlineData;

// data:
{
    events : [...],
    resources : [...],
    dependencies : [...],
    assignments : [...],
    timeRanges : [...],
    resourceTimeRanges : [...],
    ... other stores data
}


// Plug it back in later
scheduler.crudManager.inlineData = data;

The xxData properties are deprecated and will be removed in the future. Use xxinstead. For example eventsData is deprecated, use events instead. For now, both naming schemes are included in the data object

json : String

Get or set data of crudStores as a JSON string.

Get a JSON string:


const jsonString = scheduler.crudManager.json;

// returned jsonString:
'{"events":[...],"resources":[...],...}'

// object representation of the returned jsonString:
{
    resources    : [...],
    events       : [...],
    assignments  : [...],
    dependencies : [...],
    timeRanges   : [...],
    // data from other stores
}

Set a JSON string (to populate the CrudManager stores):

scheduler.crudManager.json = '{"events":[...],"resources":[...],...}'

The xxData properties are deprecated and will be removed in the future. Use xx instead. For example eventsData is deprecated, use events instead. For now, both naming schemes are included in the data object

revision : Number

READONLY

The server revision stamp. The revision stamp is a number which should be incremented after each server-side change. This property reflects the current version of the data retrieved from the server and gets updated after each load and sync call.
stores : CrudManagerStoreDescriptor[]

A list of registered stores whose server communication will be collected into a single batch. Each store is represented by a store descriptor.

Has a corresponding stores config.
isLoading : Boolean

READONLY

Returns true if the crud manager is currently loading data
isAbstractCrudManager : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

addStore( store, position, fromStore )
Adds a store to the collection.
```
// append stores to the end of collection
crudManager.addStore([
    store1,
    // store id
    'bar',
    // store descriptor
    {
        storeId : 'foo',
        store   : store3
    },
    {
        storeId         : 'bar',
        store           : store4,
        // to write all fields of modified records
        writeAllFields  : true
    }
]);
```
Note: Order in which stores are kept in the collection is very essential sometimes. Exactly in this order the loaded data will be put into each store.

When adding a store to the CrudManager, make sure the server response format is correct for load and sync requests. Learn more in the Working with data guide.
toJSON( )
: Object
Returns the data from all CrudManager crudStores in a format that can be consumed by inlineData.

Used by JSON.stringify to correctly convert this CrudManager to json.

The returned data is identical to what inlineData contains.
```
const json = scheduler.crudManager.toJSON();

// json:
{
    events : [...],
    resources : [...],
    dependencies : [...],
    assignments : [...],
    timeRanges : [...],
    resourceTimeRanges : [...],
    // ... other stores data
}
```
Output can be consumed by inlineData.
```
const json = scheduler.crudManager.toJSON();

// Plug it back in later
scheduler.crudManager.inlineData = json;
```
The xxData properties are deprecated and will be removed in the future. Use xxinstead. For example eventsData is deprecated, use events instead. For now, both naming schemes are included in the data object

Type definitions

CrudManagerStoreDescriptor
Properties
- storeId : String
  
  Unique store identifier. Store related requests/responses will be sent under this name.
- store : Store
  
  The store itself.
- phantomIdField : String
  
  Set this if the store model has a predefined field to keep phantom record identifier.
- idField : String
  
  id field name, if it's not specified then class will try to get it from store model.
- writeAllFields : Boolean
  
  Set to true to write all fields from modified records

AbstractCrudManager
Abstract

Data transfer and encoding methods

See also

Configs

Properties

Functions

Type definitions

Properties

Source path

Inheritance tree2

Mixins1

Contents

AbstractCrudManager Abstract

Data transfer and encoding methods

See also

Configs

Properties

Functions

Type definitions

Properties

Source path

Inheritance tree2

Mixins1

Contents

AbstractCrudManager
Abstract