• API Docs for Version:

    • APIs

    Show:

    flexygo.obj.Entity Class

    Defined in: Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:8

    Library to access entity objects and collections from JS.

    Constructor

    flexygo.obj.Entity

    (
    • objectName
    • [objectWhere]
    )
    Object

    Defined in Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:8

    Parameters:

    • objectName String
      • The object name.
    • [objectWhere] String optional
      • Where condition (only if object isn't new).

    Returns:

    Object:
    • Entity object.

    Methods

    delete

    () Boolean

    Defined in Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:103

    Delete current object.

    Returns:

    Boolean:
    • Success or fail.

    getConfig

    () Object

    Defined in Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:148

    Get the system configuration related to current object.

    Returns:

    Object:
    • System configuration

    getTemplateByType

    (
    • templateType
    • [cllback]
    )
    flexygo.api.Template

    Defined in Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:254

    Get object template by type

    Parameters:

    • templateType String
      • Desired template type.
    • [cllback] Function optional
      • function to get the results, if null, get view will be syncronous and results will be returned on return param.

    Returns:

    flexygo.api.Template:
    • if no cllback param, results object

    getTemplateByType

    (
    • getTemplateById
    • [cllback]
    • [filter]
    )
    flexygo.api.Template

    Defined in Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:280

    Get object template by id

    Parameters:

    • getTemplateById String
      • Desired template id.
    • [cllback] Function optional
      • function to get the results, if null, get view will be syncronous and results will be returned on return param.
    • [filter] String optional
      • Additional where to filter the template.

    Returns:

    flexygo.api.Template:
    • if no cllback param, results object

    getView

    (
    • viewName
    • [page=0]
    • [pageSize=5000]
    • [filter]
    • [orderBy]
    • [cllback]
    )
    Object

    Defined in Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:164

    Get the system configuration related to current object.

    Parameters:

    • viewName String
      • Desired view name.
    • [page=0] Number optional
      • Page number.
    • [pageSize=5000] Number optional
      • Number of page elements.
    • [filter] String optional
      • Additional sql where.
    • [orderBy] String optional
      • Order by condition.
    • [cllback] Function optional
      • function to get the results, if null, get view will be syncronous and results will be returned on return param.

    Returns:

    Object:
    • if no cllback param, results object

    getViewColumnsNames

    (
    • viewName
    • [cllback]
    )
    Object

    Defined in Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:229

    Get view columns names.

    Parameters:

    • viewName String
      • Desired view name.
    • [cllback] Function optional
      • function to get the results, if null, get view will be syncronous and results will be returned on return param.

    Returns:

    Object:
    • results object

    getViewCount

    (
    • viewName
    • [filter]
    • [orderBy]
    • [cllback]
    )
    Number

    Defined in Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:200

    Get number of rows.

    Parameters:

    • viewName String
      • Desired view name.
    • [filter] String optional
      • Additional sql where.
    • [orderBy] String optional
      • Order by condition.
    • [cllback] Function optional
      • function to get the results, if null, get view will be syncronous and results will be returned on return param.

    Returns:

    Number:
    • if no cllback param, results object

    insert

    () Boolean

    Defined in Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:44

    Save a new item in the database.

    Returns:

    Boolean:
    • Success or fail.

    processes

    (
    • options
    )
    flexygo.api.entity.GetProcessesResponse

    Defined in Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:129

    Get the processes related to current object.

    Parameters:

    • options String
      • leave empty for all processes. reports for only reports, processes for only processes and relations only for relations

    Returns:

    flexygo.api.entity.GetProcessesResponse:
    • Related processes

    read

    () Boolean

    Defined in Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:22

    Init entity and recive the values.

    Returns:

    Boolean:
    • Success or fail.

    toValuesArray

    () String

    Defined in Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:307

    Converts Data properties in KeyValuePair array.

    Returns:

    String:
    • Data array

    update

    () Boolean

    Defined in Source\flexygo\Proyectos\FlexyGo\FlexyGo\js\flexygo\entities\Entity.js:73

    Save changes in the database.

    Returns:

    Boolean:
    • Success or fail.