documentation.help

Engine Objects Summary

From English Query

previous page next page
English Query

Engine Objects Summary

This summary lists all the objects in the Engine Object model and the properties and methods for each.

Provides the English answer text to a question that cannot be answered with data in the database.
  • Command Object

    Properties/Methods

    Properties/Methods Description
    CmdID PropertyContains an integer or symbolic constant representing a command, such as: a query, an answer, a user request for help, or a user request to exit command.

  • CommandResponse Object

    Properties/Methods

    Properties/Methods Description
    Restatement PropertyAn English interpretation of the end user's question or request.
    Type PropertyContains an integer or a symbolic constant representing a type of response object.

  • DomainCmd Object

    Properties/Methods

    Properties/Methods Description
    CmdID PropertyContains an integer or a symbolic constant representing a command, such as: a query, an answer, a user request for help, or a user request to exit command.
    CommandName PropertyContains a string representing a command relationship.

  • DomainInfo Object

    Properties/Methods

    Properties/Methods Description
    Closed PropertyIndicates the open and closed status of the DomainInfo object.
    FullName PropertyIndicates the path of the DomainInfo object.
    QuestionBuilder PropertyContains the Question Builder information (the QuestionBuilder object) for the DomainInfo object.
    Close MethodCloses the DomainInfo object.

  • ErrorResponse Object

    Properties/Methods

    Properties/Methods Description
    Description PropertyContains a description of the error to be displayed to the end user.
    Type PropertyContains an integer or a symbolic constant representing a type of response object.

  • HelpCmd Object

    Properties/Methods

    Properties/Methods Description
    HelpText PropertySpecifies Help text of the application for an entity.
    HelpType PropertyContains an integer representing the type of object for which Help is requested.
    ObjectID PropertyContains the ID of the object for which Help is being requested.
    ObjectType PropertyContains an integer representing the type of object for which Help is requested.

  • Listlnput Object

    Properties/Methods

    Properties/Methods Description
    Caption PropertySpecifies the recommended caption for one of three user input types: ListInput, StaticInput, and TextInput.
    Items PropertySpecifies the array of strings in the list from which the user chooses.
    ItemCount PropertySpecifies the number of items in the list from which the end user chooses.
    Selection PropertySpecifies the end user's selection from the list.

  • ObjectReference Object

    Properties/Methods

    Properties/Methods Description
    ObjectID Property (ObjectReference Object) Contains the ID of the object that is being referenced.
    ObjectType Property (ObjectReference Object) Contains an integer representing the type of object that is being referenced.

  • Parameter Object

    Properties/Methods

    Properties/Methods Description
    FieldCount PropertyContains the number of fields in the Fields property array.
    Fields PropertyContains an array of the fields in the specified query command, which yields the values of a parameter of a command relationship.
    ParameterID PropertyContains an integer identifying a parameter of a command relationship.
    ParameterType PropertyContains an integer representing a parameter for a command relationship.
    QueryCommand PropertyContains an index of the query command in the QueryCommands collection that yields the values of a parameter of a command relationship.
    Units PropertyContains a description that qualifies the parameter value, such as percent or dollars.
    Value PropertyContains a parameter value representing a parameter for a command relationship.

  • QueryCmd Object

    Properties/Methods

    Properties/Methods Description
    DBMSType Property (QueryCmd Object)Specifies the type of database used for the database query.
    DisplayRows PropertyThe number of rows the client displays to answer the end user's question.
    DisplayToUser PropertySpecifies whether to display the results of the query to the user or to execute the database query without displaying the results.
    IgnoreError PropertySpecifies whether the client ignores database errors resulting from executing the command.
    QueryText PropertyReturns the query text to execute. Use instead of the SQL property.
    SQL PropertyReturns the query text to execute.
    TableCaption PropertySpecifies the suggested English caption for the result table.
    TrueFalseAnswer PropertySpecifies whether the client shows TRUE or FALSE as an answer instead of a table.

  • Response Object

    Properties/Methods

    Properties/Methods Description
    Type PropertyContains an integer or a symbolic constant representing a type of response object.

  • Session Object

    Properties/Methods

    Properties/Methods Description
    ClarifySpellingErrors PropertyIndicates whether English Query prompts end users for clarification of spelling errors or corrects spelling errors without prompting.
    DBMSType Property (Session Object)Specifies the type of database used in this session.
    DBMSVersion PropertySpecifies the version of the database used in this session.
    DomainInfo PropertyContains the model information (the DomainInfo object) for the Session object.
    FallbackDBMSType PropertySpecifies the type of database to use if the primary database is unavailable.
    FallbackDBMSVersion PropertySpecifies the version of the database to use if the primary database is unavailable.
    RetainContext PropertyRetains user context between questions for the Session object.
    ClearContext MethodClears the conversation context.
    InitDomain MethodCreates (if necessary) the DomainInfo object and attaches it to the Session object.
    ParseRequest MethodParses an English question or request into a collection of database queries or other response types for the attached model.
    SetDBMS MethodSets the database type and version for which the query is generated.
    SetFallbackDBMS MethodSets the alternate database type and version for which a query is generated if none can be generated for the primary database.

  • StaticInput Object

    Properties/Methods

    Properties/Methods Description
    Caption PropertySpecifies the recommended caption for one of three user input types: ListInput, StaticInput, and TextInput.

  • TextInput Object

    Properties/Methods

    Properties/Methods Description
    Caption PropertySpecifies the recommended caption for one of three user input types: ListInput, StaticInput, and TextInput.
    Text PropertySpecifies the text end users provide to clarify their questions, statements, or errors.

  • UserClarifyResponse Object

    Properties/Methods

    Properties/Methods Description
    Type PropertyContains an integer or a symbolic constant representing a type of response object.
    Reply MethodContinues parsing the current English request into a Response object after the end user has responded to a request for clarification.

  • UserInput Object

    Properties/Methods

    Properties/Methods Description
    Type PropertyContains an integer or a symbolic constant representing a type of user input object: ListInput, StaticInput, or TextInput object.

    • previous page start next page