Class: DataType

bo.dataTypes. DataType

Serves as the base class for data type definitions.

new DataType()

Creates a new data type definition. The data type instances should be frozen.

Members

<readonly> name :string

The name of the data type. The default value is the name of the constructor.

Type:
  • string

Methods

<virtual> hasValue(value) → {boolean}

Abstract method to check if the data type of the value conforms to the data type definition and it is not null.

Parameters:
Name Type Description
value *

The value to check.

Throws:
Not implemented error: The DataType.hasValue method is not implemented.
Returns:

True if the value is the defined data type and not null, otherwise false.

Type
boolean

<virtual> isValid(value) → {*}

Abstract method to check if the value conforms to the data type definition. Returns the value when it has the required data type. If not, but it can be converted into the required data type, then returns the converted value. Otherwise returns undefined to mark the value as invalid.

Parameters:
Name Type Argument Description
value * <optional>

The value to check.

Throws:
Not implemented error: The DataType.check method is not implemented.
Returns:

The value in the defined data type or null when the value is valid, otherwise undefined.

Type
*
If you find bugs or have feature requests, please let us know.

JavaScript business objects ♦ Copyright © 2014-2016 Logikum, Ltd.
Documentation generated by JSDoc 3.2.2 on 2015. December 31. using the DocStrap template.