Class BindModel

Bind Model Ajax Class This class inherits BaseBindModel and provides additional functionality for Ajax communication.

Hierarchy (view full)

BaseBindModel
- BindModel

Constructors

constructor

new BindModel(service): BindModel
This is the creator of 'BindModel'.
Parameters
- service: IServiceAjax
  Object providing Ajax service.
Returns BindModel
Overrides BaseBindModel.constructor
- Defined in types/en/bind-model.d.ts:19

Properties

_baseTable

_baseTable: MetaTable

Defines the default entity. This entity represents a meta table.

_columnType

_columnType: MetaColumn

Sets the column type.

_guid

_guid: string

Unique identifier of the object (GUID). Uniquely identifies the object.

_mapping

_mapping: PropertyCollection

A collection of mapping properties.

_tables

_tables: MetaTableCollection

This is a meta table collection. Manage multiple meta tables.

_type

_type: Function

The generator function of the object. The function used when the object was created.

$event

$event: EventEmitter

Event object. Processes the issuance and reception of events.

$KEYWORD

$KEYWORD: string[]

This is the collection reservation word. Defines the reserved words that you use by default.

baseConfig

baseConfig: object

Set the binding default config.

cbBaseBegin

cbBaseBegin: ((command: BaseBindCommand) => void)

Default callback function called at the start of execution (used when cbBegin callback function is not present)

Type declaration

- (command): void
- Parameters
  - command: BaseBindCommand
    The current bound command object.
  Returns void

cbBaseBind

cbBaseBind: ((bind: MetaView, command: BaseBindCommand, config: object) => void)

Default callback function called before bind (used when cbBind callback function is not present)

Type declaration

- (bind, command, config): void
- Parameters
  - bind: MetaView
    object 'MetaView' to bind.
  - command: BaseBindCommand
    The current bound command object.
  - config: object
    setting object.
  Returns void

cbBaseEnd

cbBaseEnd: ((status: object, command: BaseBindCommand, response: object) => void)

Default callback function called after completion of execution (used when cbEnd callback function is not present)

Type declaration

- (status, command, response): void
- Parameters
  - status: object
    Object containing status information.
  - command: BaseBindCommand
    The current bound command object.
  - response: object
    response object.
  Returns void

cbBaseOutput

cbBaseOutput: ((outputs: MetaViewCollection, command: BaseBindCommand, response: object) => object)

Default callback function to output bind results (used when cbOutput callback function is not present)

Type declaration

- (outputs, command, response): object
- Parameters
  - outputs: MetaViewCollection
    Metabiew Collection.
  - command: BaseBindCommand
    The current bound command object.
  - response: object
    response object.
  Returns object
  Returns the processed result object.

cbBaseResult

cbBaseResult: ((data: object, command: BaseBindCommand, response: object) => object)

Callback function that handles binding results (used in the absence of the cbResult callback function)

Type declaration

- (data, command, response): object
- Parameters
  - data: object
    Bind result data object.
  - command: BaseBindCommand
    The current bound command object.
  - response: object
    response object.
  Returns object
  Returns the processed result object.

cbBaseValid

cbBaseValid: ((valid: MetaView, command: BaseBindCommand) => boolean)

Default callback function called before valid (used without cbValid callback function)

Type declaration

- (valid, command): boolean
- Parameters
  - valid: MetaView
    object 'MetaView' to be examined.
  - command: BaseBindCommand
    The current bound command object.
  Returns boolean
  A boolean value indicating the result of the examination.

cbError

cbError: ((msg: string, status: object, response: object) => void)

The callback function that is called in the event of an error.

Type declaration

- (msg, status, response): void
- Parameters
  - msg: string
    Error message.
  - status: object
    Object containing status information.
  - response: object
    response object.
  Returns void

cbFail

cbFail: ((result: object, column: MetaColumn) => void)

Callback function called upon failure by valid.

Type declaration

- (result, column): void
- Parameters
  - result: object
    object containing the results of the examination.
  - column: MetaColumn
    object 'MetaColumn' used in the examination.
  Returns void

cmd

cmd: PropertyCollection

Alias for command.

columns

columns: MetaTableColumnCollection

Collection of columns. Indicates the column of the _baseTable.

command

command: PropertyCollection

A collection of binding commands.

first

first: MetaTable

This is the first dynamically generated meta table.

fn

fn: PropertyCollection

A collection of bound model functions. (Internal function + Exposure function)

items

items: PropertyCollection

It's an item collection.

preCheck

preCheck: ((model: BaseBindModel) => boolean)

Callback function that returns boolean on init() call.

Type declaration

- (model): boolean
- Parameters
  - model: BaseBindModel
    The current bound model object.
  Returns boolean
  A boolean value indicating the result of the examination.

preReady

preReady: ((model: BaseBindModel) => void)

Callback function called when preCheck callback function result is true when invoking init().

Type declaration

- (model): void
- Parameters
  - model: BaseBindModel
    The current bound model object.
  Returns void

preRegister

preRegister: ((model: BaseBindModel) => void)

The callback function that is initially called upon init() call.

Type declaration

- (model): void
- Parameters
  - model: BaseBindModel
    The current bound model object.
  Returns void

url

url: string

Set the binding default config.url.

Example

const bm = new BindModel(service);
bm.url = '/user';

`Static` `Readonly`_NS

_NS: string

Indicates the namespace.

Default

'Meta'

`Static` `Readonly`_PARAM

_PARAM: []

List of parameters used for the constructor.

`Static` `Readonly`_UNION

_UNION: []

List of implemented interfaces.

Default

[IObject, IMarshal]

Methods

_onExecute

_onExecute(cmd): void
Event listener before command execution.
Parameters
- cmd: BaseBindCommand
  command object to be executed.
Returns void
Listens
BaseBind#onExecute
Inherited from BaseBindModel._onExecute
- Defined in types/en/base-bind.d.ts:54

_onExecuted

_onExecuted(cmd, result): void
Event listener after command execution.
Parameters
- cmd: BaseBindCommand
  Command object executed.
- result: object
  The result object of the command execution.
Returns void
Listens
BaseBind#onExecuted
Inherited from BaseBindModel._onExecuted
- Defined in types/en/base-bind.d.ts:63

_readItem

_readItem(items?, baseEntity?): void
Register (load) the property to the _baseTable or the specified MetaTable.
Parameters
- Optionalitems: string | string[]
  The name of the item to read. It can be string or string array.
- OptionalbaseEntity: MetaTable
  Default table object. (Optional)
Returns void
Inherited from BaseBindModel._readItem
- Defined in types/en/base-bind-model.d.ts:166

addColumn

addColumn(column, cmds?, views?, bTable?): void
Add columns and map them to commands.
Parameters
- column: MetaColumn
  This column object is to be registered. It could be a string or 'MetaColumn' object.
- Optionalcmds: string | string[]
  (Optional) Command that specifies the location of the view. It can be a string or string array.
- Optionalviews: string | string[]
  (Optional) The name of the view entity to be added. It can be a string or an array of strings.
- OptionalbTable: string | MetaTable
  (Optional) Default table object or table name to be mapped.
Returns void
Inherited from BaseBindModel.addColumn
- Defined in types/en/base-bind-model.d.ts:215

addColumnValue

addColumnValue(name, value, cmds?, views?, bTable?): void
Add columns and values, add them to the specified table, and register the reference to the column in BaseBindcommand's valid, bind, and output MetaView.

@param{string} name - The name of the column. @param{any} value - column value.
Parameters
- name: string
- value: any
- Optionalcmds: string | string[]
  This command specifies the location of the view. It can be a string or an array of strings.
- Optionalviews: string | string[]
  The name of the view entity to be added. It can be a string or an array of strings.
- OptionalbTable: string | MetaTable
  (Optional) Default table object or table name to be mapped.
Returns void
Inherited from BaseBindModel.addColumnValue
- Defined in types/en/base-bind-model.d.ts:226

addCommand

addCommand(name, option, baseTable?): BaseBindCommand
Add a command.
Parameters
- name: string
  Command name.
- option: number
  Output option.
- OptionalbaseTable: MetaTable
  (Optional) Default table object.
Returns BaseBindCommand
Added bind command object.
Overrides BaseBindModel.addCommand
- Defined in types/en/bind-model.d.ts:59

addTable

addTable(name): MetaTable
Register the table.
Parameters
- name: string
  The name of the table to register.
Returns MetaTable
Returns a registered meta table object.
Inherited from BaseBindModel.addTable
- Defined in types/en/base-bind-model.d.ts:205

checkSelector

checkSelector(collection): boolean
Examine the selector.
Parameters
- collection: BaseColumnCollection
  Collection of columns to be inspected.
Returns boolean
A boolean value indicating the result of the examination.
- Defined in types/en/bind-model.d.ts:41

equal

equal(target): boolean
Compare the current object with the specified object.
Parameters
- target: object
  the object to be compared to.
Returns boolean
Returns whether the two objects are the same.
Inherited from BaseBindModel.equal
- Defined in node_modules/logic-core/types/en/meta-object.d.ts:30

getObject

getObject(vOpt?, owned?): object
Obtain the current object as a guide type object. (Circular references are replaced by $ref values.)
Parameters
- OptionalvOpt: number
  is the import option. Default is 0.
  - opt=0: Reference structure (_guid: Yes, $ref: Yes)
  - opt=1: Redundant structure (_guid: Yes, $ref: Yes)
  - opt=2: Non-tidal structure (_guid: No, $ref: No)
- Optionalowned: object | object[]
Returns object
Returns serialized objects.
Example
```
a.getObject(2) == b.getObject(2)
```
Inherited from BaseBindModel.getObject
- Defined in types/en/base-bind-model.d.ts:182

getSelector

getSelector(collection?): object[]
Obtain a list of destination selectors.
Parameters
- Optionalcollection: PropertyCollection
  This is the collection of properties to examine. The default is items.
Returns object[]
Object array representing the selector list.
- Defined in types/en/bind-model.d.ts:49

getTypes

getTypes(): Function[]
Returns the creators of the current object and all the creators of the prototype chain to the array.

Returns Function[]
Returns the array of generator functions.
Example
```
const types = obj.getTypes();
console.log(types); // [Function: MetaObject]
```
Inherited from BaseBindModel.getTypes
- Defined in node_modules/logic-core/types/en/meta-object.d.ts:41

init

init(): void
Performs the initialization operation. Internally, call 'preRegister()' -> 'preCheck()' -> 'preReady()'.

Returns void
Inherited from BaseBindModel.init
- Defined in types/en/base-bind-model.d.ts:197

instanceOf

instanceOf(target): boolean
Verify that the current object is an instance of the specified type (including _UNION)
Parameters
- target: string | object
  The type of object to be checked (object or string).
Returns boolean
Returns whether it is an instance of the specified type.
Inherited from BaseBindModel.instanceOf
- Defined in node_modules/logic-core/types/en/meta-object.d.ts:49

setMapping

setMapping(mapping, baseTable?): void
Map columns.
Parameters
- mapping: object | PropertyCollection
  an object or collection to map to MetaColumn
- OptionalbaseTable: string | MetaTable
  (Optional) Default table object or table name to map.
Returns void
Inherited from BaseBindModel.setMapping
- Defined in types/en/base-bind-model.d.ts:234

setObject

setObject(oGuid, origin?): void
Sets the Guid type object to the current object. (The object will be reset.)
Parameters
- oGuid: object
  Object of the guid type to serialize.
- Optionalorigin: object
  The source object setting the current object. (Optional)
Returns void
Inherited from BaseBindModel.setObject
- Defined in types/en/base-bind-model.d.ts:191

setService

setService(service, isRead?): void
Set up the service.
Parameters
- service: IServiceAjax
  service object.
- OptionalisRead: boolean
  A boolean value that indicates whether prop within the service should be loaded as item.
Returns void
Overrides BaseBindModel.setService
- Defined in types/en/bind-model.d.ts:67

Events

onExecute

onExecute: ((cmd: BaseBindCommand) => void)

An event that is called before the command is executed.

Type declaration

- (cmd): void
- Parameters
  - cmd: BaseBindCommand
    command object to be executed.
  Returns void

onExecuted

onExecuted: ((cmd: BaseBindCommand, result: object) => void)

An event that is called after the command is executed.

Type declaration

- (cmd, result): void
- Parameters
  - cmd: BaseBindCommand
    Command object executed.
  - result: object
    The result object of the command execution.
  Returns void

Class BindModel

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Parameters

Returns BindModel

Properties

_baseTable

_columnType

_guid

_mapping

_tables

_type

$event

$KEYWORD

baseConfig

cbBaseBegin

Type declaration

Parameters

Returns void

cbBaseBind

Type declaration

Parameters

Returns void

cbBaseEnd

Type declaration

Parameters

Returns void

cbBaseOutput

Type declaration

Parameters

Returns object

cbBaseResult

Type declaration

Parameters

Returns object

cbBaseValid

Type declaration

Parameters

Returns boolean

cbError

Type declaration

Parameters

Returns void

cbFail

Type declaration

Parameters

Returns void

cmd

columns

command

first

fn

items

preCheck

Type declaration

Parameters

Returns boolean

preReady

Type declaration

Parameters

Returns void

preRegister

Type declaration

Parameters

Returns void

url

Example

Static Readonly_NS

Default

Static Readonly_PARAM

Static Readonly_UNION

Default

Methods

_onExecute

`Static` `Readonly`_NS

`Static` `Readonly`_PARAM

`Static` `Readonly`_UNION