Engine Objects Summary
SQL Server 2000
This summary lists all the objects in the Engine Object model and the properties and methods for each.
- AnswerCmd Object Properties/Methods
Properties/Methods Description Answer Property 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 Property Contains 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
- DomainCmd Object Properties/Methods
- DomainInfo Object Properties/Methods
Properties/Methods Description Closed Property Indicates the open and closed status of the DomainInfo object. FullName Property Indicates the path of the DomainInfo object. QuestionBuilder Property Contains the Question Builder information (the QuestionBuilder object) for the DomainInfo object. Close Method Closes the DomainInfo object.
- ErrorResponse Object Properties/Methods
- HelpCmd Object Properties/Methods
Properties/Methods Description HelpText Property Specifies Help text of the application for an entity. HelpType Property Contains an integer representing the type of object for which Help is requested. ObjectID Property Contains the ID of the object for which Help is being requested. ObjectType Property Contains an integer representing the type of object for which Help is requested.
- Listlnput Object Properties/Methods
Properties/Methods Description Caption Property Specifies the recommended caption for one of three user input types: ListInput, StaticInput, and TextInput. Items Property Specifies the array of strings in the list from which the user chooses. ItemCount Property Specifies the number of items in the list from which the end user chooses. Selection Property Specifies the end user's selection from the list.
- ObjectReference Object Properties/Methods
- Parameter Object Properties/Methods
Properties/Methods Description FieldCount Property Contains the number of fields in the Fields property array. Fields Property Contains an array of the fields in the specified query command, which yields the values of a parameter of a command relationship. ParameterID Property Contains an integer identifying a parameter of a command relationship. ParameterType Property Contains an integer representing a parameter for a command relationship. QueryCommand Property Contains an index of the query command in the QueryCommands collection that yields the values of a parameter of a command relationship. Units Property Contains a description that qualifies the parameter value, such as percent or dollars. Value Property Contains 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 Property The number of rows the client displays to answer the end user's question. DisplayToUser Property Specifies whether to display the results of the query to the user or to execute the database query without displaying the results. IgnoreError Property Specifies whether the client ignores database errors resulting from executing the command. QueryText Property Returns the query text to execute. Use instead of the SQL property. SQL Property Returns the query text to execute. TableCaption Property Specifies the suggested English caption for the result table. TrueFalseAnswer Property Specifies whether the client shows TRUE or FALSE as an answer instead of a table.
- Response Object Properties/Methods
Properties/Methods Description Type Property Contains an integer or a symbolic constant representing a type of response object.
- Session Object Properties/Methods
Properties/Methods Description ClarifySpellingErrors Property Indicates 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 Property Specifies the version of the database used in this session. DomainInfo Property Contains the model information (the DomainInfo object) for the Session object. FallbackDBMSType Property Specifies the type of database to use if the primary database is unavailable. FallbackDBMSVersion Property Specifies the version of the database to use if the primary database is unavailable. RetainContext Property Retains user context between questions for the Session object. ClearContext Method Clears the conversation context. InitDomain Method Creates (if necessary) the DomainInfo object and attaches it to the Session object. ParseRequest Method Parses an English question or request into a collection of database queries or other response types for the attached model. SetDBMS Method Sets the database type and version for which the query is generated. SetFallbackDBMS Method Sets 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 Property Specifies the recommended caption for one of three user input types: ListInput, StaticInput, and TextInput.
- TextInput Object Properties/Methods
- UserClarifyResponse Object Properties/Methods
- UserInput Object Properties/Methods
Properties/Methods Description Type Property Contains an integer or a symbolic constant representing a type of user input object: ListInput, StaticInput, or TextInput object.