Interface IStiAppDictionary

Describes the interface to access base data dictionary functionality.

Hierarchy

  • IStiAppDictionary

Implemented by

Index

Methods

Methods

closeConnections

  • Closes all specified connections. Closes all connections if none of them is specified.

    Parameters

    Returns void

existsUserFunction

  • existsUserFunction(functionName: string): boolean

  • Parameters

    • functionName: string

    Returns boolean

fetchDataRelations

  • Returns an enumeration of the data relations from this dictionary.

    Returns List<IStiAppDataRelation>

    The enumeration of the data relations.

fetchDataSources

  • Returns an enumeration of the data source from this dictionary.

    Returns List<IStiAppDataSource>

    The enumeration of the data source.

fetchVariables

  • Returns an enumeration of the variables from this dictionary.

    Returns List<IStiAppVariable>

    The enumeration of the variables

getApp

  • Returns reference to the app which contains this dictionary.

    Returns IStiApp

    A reference to the app.

getColumnByName

  • Returns data column from the data dictionary by its name.

    Parameters

    • name: string

      A name of the data column.

    Returns IStiAppDataColumn

    The data column from the data dictionary. Returns null, if data column with specified name is not exists.

getDataSourceByName

  • Returns datasource from the data dictionary by its name.

    Parameters

    • name: string

      A name of the datasource.

    Returns IStiAppDataSource

    The datasource from the data dictionary. Returns null, if datasource with specified name is not exists.

getSystemVariableValue

  • getSystemVariableValue(name: string): any

  • Returns value of a specified system variable.

    Parameters

    • name: string

      A name of the system variable.

    Returns any

    The value of the specified system variable.

getVariableByName

  • Returns variable from the data dictionary by its name.

    Parameters

    • name: string

      A name of the variable.

    Returns IStiAppVariable

    The variable from the data dictionary. Returns null, if variable with specified name is not exists.

getVariableValueByName

  • getVariableValueByName(name: string): any

  • Returns a value from the variable by its name.

    Parameters

    • name: string

      A name of the variable.

    Returns any

    A value which contains in the variable.

invokeUserFunction

  • invokeUserFunction(functionName: string, args: List<any>): any

  • Parameters

    • functionName: string
    • args: List<any>

    Returns any

isReadOnlyVariable

  • isReadOnlyVariable(name: string): boolean

  • Returns true if a specified variable is a read-only variable.

    Parameters

    • name: string

      The name of the variable.

    Returns boolean

    True, if the specified variable is a read-only variable.

isSystemVariable

  • isSystemVariable(name: string): boolean

  • Returns true if a specified name is a name of a system variable.

    Parameters

    • name: string

      The name of the system variable.

    Returns boolean

    True, if the specified name is the name of system variable.

openConnections

openConnectionsAsync

Generated using TypeDoc