59 lines
1.6 KiB
TypeScript
59 lines
1.6 KiB
TypeScript
import { OpenSlidesComponent } from 'app/openslides.component';
|
|
import { Deserializable } from './deserializable.model';
|
|
import { CollectionStringModelMapperService } from '../../core/services/collectionStringModelMapper.service';
|
|
|
|
export interface ModelConstructor {
|
|
new (...args: any[]): BaseModel;
|
|
}
|
|
|
|
/**
|
|
* Abstract parent class to set rules and functions for all models.
|
|
*/
|
|
export abstract class BaseModel extends OpenSlidesComponent implements Deserializable {
|
|
/**
|
|
* Register the collection string to the type.
|
|
* @param collectionString
|
|
* @param type
|
|
*/
|
|
public static registerCollectionElement(collectionString: string, type: any) {
|
|
CollectionStringModelMapperService.registerCollectionElement(collectionString, type);
|
|
}
|
|
|
|
/**
|
|
* force children of BaseModel to have a collectionString.
|
|
*
|
|
* Has a getter but no setter.
|
|
*/
|
|
protected abstract _collectionString: string;
|
|
|
|
/**
|
|
* force children of BaseModel to have an id
|
|
*/
|
|
public abstract id: number;
|
|
|
|
/**
|
|
* constructor that calls super from parent class
|
|
*/
|
|
protected constructor() {
|
|
super();
|
|
}
|
|
|
|
/**
|
|
* returns the collectionString.
|
|
*
|
|
* The server and the dataStore use it to identify the collection.
|
|
*/
|
|
public get collectionString(): string {
|
|
return this._collectionString;
|
|
}
|
|
|
|
/**
|
|
* Most simple and most commonly used deserialize function.
|
|
* Inherited to children, can be overwritten for special use cases
|
|
* @param input JSON data for deserialization.
|
|
*/
|
|
public deserialize(input: any): void {
|
|
Object.assign(this, input);
|
|
}
|
|
}
|