Flexberry Documentation Flexberry Documentation

  • API Docs for Version: master

    • APIs

    Show:

    Information Class

    Defined in: addon/utils/information.js:7
    Module: ember-flexberry-data

    Class for loading metadata about models.

    Methods

    createEnum

    (
    • dictionary
    )
    Object

    Defined in addon/utils/enum-functions.js:8

    Returns friezed object without prototype with own properties of parameter.

    Parameters:

    Returns:

    Object:

    enumCaptions

    (
    • dictionary
    )
    Object

    Defined in addon/utils/enum-functions.js:42

    Returns object without null values.

    Parameters:

    Returns:

    Object:

    firstLoadOfflineObjects

    (
    • dexieDB
    • odataPath
    • functionName
    • modelName
    • count
    • top
    • skip
    • idPath
    )
    Promise

    Defined in addon/utils/first-load-offline-objects.js:8

    Load and save offline objects provided by odata function or returns objects count. Tables with objects to load must be empty.

    Parameters:

    • dexieDB Object

      Dexie DB (example: dexieService.dexie('DB name', store)).

    • odataPath String

      Odata Url (example: 'http://localhost:35904/odata').

    • functionName String

      Odata function name.

    • modelName String

      Model name for objects.

    • count Bool

      Flag indicates that function returns objects or objects count.

    • top Integer

      Amount of objects to load.

    • skip Integer

      Amount of objects to skip from result.

    • idPath String

      Path to string id in JSON ('guid' by default).

    Returns:

    Promise:

    getType

    (
    • modelName
    • attributePath
    )
    String public

    Defined in addon/utils/information.js:128

    Returns the type of the specified attribute path.

    Parameters:

    • modelName String

      The name of the model.

    • attributePath String

      The path to the attribute.

    Returns:

    String:

    The type of the specified attribute path.

    inverseEnum

    (
    • dictionary
    )
    Object

    Defined in addon/utils/enum-functions.js:26

    Returns friezed inversed object without prototype.

    Parameters:

    Returns:

    Object:

    isAttribute

    (
    • modelName
    • attributePath
    )
    Boolean public

    Defined in addon/utils/information.js:44

    Checks if the specified attribute path is an attribute.

    Parameters:

    • modelName String

      The name of the model.

    • attributePath String

      The path to the attribute.

    Returns:

    Boolean:

    True if the specified attribute path is an attribute.

    isDetail

    (
    • modelName
    • attributePath
    )
    Boolean public

    Defined in addon/utils/information.js:100

    Checks if the specified attribute path is a detail field.

    Parameters:

    • modelName String

      The name of the model.

    • attributePath String

      The path to the attribute.

    Returns:

    Boolean:

    True if the specified attribute path is a detail field.

    isExist

    (
    • modelName
    • attributePath
    )
    Boolean public

    Defined in addon/utils/information.js:25

    Checks if the specified attribute path is exist.

    Parameters:

    • modelName String

      The name of the model.

    • attributePath String

      The path to the attribute.

    Returns:

    Boolean:

    True if the specified attribute path is exist.

    isKey

    (
    • modelName
    • attributePath
    )
    Boolean public

    Defined in addon/utils/information.js:58

    Checks if the specified attribute path is a key (i.e. it is an id or belongsTo relationship).

    Parameters:

    • modelName String

      The name of the model.

    • attributePath String

      The path to the attribute.

    Returns:

    Boolean:

    True if the specified attribute path is a key.

    isMaster

    (
    • modelName
    • attributePath
    )
    Boolean public

    Defined in addon/utils/information.js:86

    Checks if the specified attribute path is a master field.

    Parameters:

    • modelName String

      The name of the model.

    • attributePath String

      The path to the attribute.

    Returns:

    Boolean:

    True if the specified attribute path is a master field.

    isOrdered

    (
    • modelName
    • attributePath
    )
    Boolean public

    Defined in addon/utils/information.js:114

    Checks if the specified attribute path is a ordered field.

    Parameters:

    • modelName String

      The name of the model.

    • attributePath String

      The path to the attribute.

    Returns:

    Boolean:

    True if the specified attribute path is a detail field.

    isRelationship

    (
    • modelName
    • attributePath
    )
    Boolean public

    Defined in addon/utils/information.js:72

    Checks if the specified attribute path is a relationship.

    Parameters:

    • modelName String

      The name of the model.

    • attributePath String

      The path to the attribute.

    Returns:

    Boolean:

    True if the specified attribute path is a relationship.

    parseAttributePath

    (
    • attributePath
    )
    Array public static

    Defined in addon/utils/information.js:224

    Parses the specified attribute paths and returns list of separate attributes.

    Parameters:

    • attributePath String

      The path to the attribute.

    Returns:

    Array:

    List of separate attributes.