Class BindCommand

Classes that implement bind commands through AJAX. The class handles data communication with the server and executes binding commands in the AJAX manner.

Hierarchy (view full)

MetaObject
- BindCommand

Index

Constructors

constructor

new BindCommand(BaseBindModel, outputOpt, baseTable): BindCommand
Creates a bind command AJAX object.
Parameters
- BaseBindModel: BaseBindModel
  Bind Model object.
- outputOpt: object
  Output option setting.
- baseTable: MetaTable
  Default table object.
Returns BindCommand
Overrides MetaObject.constructor
- Defined in types/en/bind-command.d.ts:18

Properties

_guid

_guid: string

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

_type

_type: Function

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

config

config: object

This is the setting for the AJAX request. Same format as 'config' in axios.

url

url: string

Sets the URL for the AJAX request.

`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

_ajaxCall

_ajaxCall(setup): Promise<void>
Implement the AJAX adapter pattern. Used in web and Node.js environments.
Parameters
- setup: object
  'axios' setting object.
Returns Promise<void>
'Promise' object representing the result of the call.
- Defined in types/en/bind-command.d.ts:71

_ajaxSuccess

_ajaxSuccess(result, status, xhr): void
Called if the AJAX request is successfully completed.
Parameters
- result: object
  result data received from the server.
- status: object
  Request status.
- xhr: object
  'XMLHttpRequest' object.
Returns void
- Defined in types/en/bind-command.d.ts:52

_execBind

_execBind(): Promise<void>
Implement AJAX bindings. Establish data communication with the server and process requests.

Returns Promise<void>
Object 'Promise' indicating completion of asynchronous operation.
- Defined in types/en/bind-command.d.ts:43

_execError

_execError(xhr, status, error): void
Called if the AJAX request fails.
Parameters
- xhr: object
  'XMLHttpRequest' object.
- status: object
  Request status.
- error: object
  Error information.
Returns void
- Defined in types/en/bind-command.d.ts:61

_execValid

_execValid(): boolean
Perform a validation. The column to be examined is set through the 'valid.column' property.

Returns boolean
- Defined in types/en/bind-command.d.ts:35

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 MetaObject.equal
- Defined in node_modules/logic-core/types/en/meta-object.d.ts:30

execute

execute(): Promise<void>
Run the bind command. Performs the entire execution process, including validation, binding, result processing, success, and error callback.

Returns Promise<void>
Returns
Object 'Promise' representing the execution result.
- Defined in types/en/bind-command.d.ts:79

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)
```
Overrides MetaObject.getObject
- Defined in types/en/bind-command.d.ts:95

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 MetaObject.getTypes
- Defined in node_modules/logic-core/types/en/meta-object.d.ts:41

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 MetaObject.instanceOf
- Defined in node_modules/logic-core/types/en/meta-object.d.ts:49

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
Overrides MetaObject.setObject
- Defined in types/en/bind-command.d.ts:104

Class BindCommand

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BindCommand

Properties

_guid

_type

config

url

Static Readonly_NS

Default

Static Readonly_PARAM

Static Readonly_UNION

Default

Methods

_ajaxCall

Parameters

Returns Promise<void>

_ajaxSuccess

Parameters

Returns void

_execBind

Returns Promise<void>

_execError

Parameters

Returns void

_execValid

Returns boolean

equal

Parameters

Returns boolean

execute

Returns Promise<void>

Returns

getObject

Parameters

Returns object

Example

getTypes

Returns Function[]

Example

instanceOf

Parameters

Returns boolean

setObject

Parameters

Returns void

Settings

On This Page

`Static` `Readonly`_NS

`Static` `Readonly`_PARAM

`Static` `Readonly`_UNION