Interface: Model

Model

A database model.

Methods

getDescription() → {String}

Returns the model's description.
Returns:
- The model's description.
Type
String

getId() → {ID}

Returns the model's ID.
Returns:
- The ID of the model.
Type
ID

getName() → {String}

Returns the model's name
Returns:
- The name of the model.
Type
String

getType() → {String}

Returns the type of the model.
Returns:
- The type of the model. The type can be either 'document' or 'data'.
Type
String

isDocument() → {Boolean}

Convenience function that returns true if the model's type is 'document'.
Returns:
- True or false depending on if the model's type is 'document'.
Type
Boolean

isExportable() → {Boolean}

Returns true if the model is marked as exportable.
Returns:
- True if the model is marked as exportable.
Type
Boolean