Home
HCL Domino Designer User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
Java/CORBA Classes
This section documents the Java/CORBA classes.
Java™ Classes A-Z
DominoQuery (Java)
Java class to compile, tune, and run Domino Query Language (DQL) queries.

HCL Domino Designer User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in Domino Designer 14.5?
  The following features are new for developers in HCL Domino® Designer 14.5.
- What's new in Nomad Designer?
  HCL Nomad for web browsers v1.0.10 introduces the capability to design Notes databases. For more information, see HCL Nomad for web browsers User Documentation, Nomad web Designer.
- Accessibility and keyboard shortcuts
  Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- Domino® Query Language
  Domino® Query Language (DQL) is a facility running on a Domino server that provides a terse, shorthand syntax for finding documents. It supports a wide variety and complexity of search terms. It leverages existing design elements, avoiding the need to write detailed code to access them. DQL consolidates all methods in Domino for searching document contents.
- Composite Applications - Design and Management
  Composite applications are a key element in a service-oriented architecture (SOA) and contextual collaboration strategy. The ability to create and edit composite applications lets you easily integrate different types of components and technologies.
- DB2® Access views
  Domino® Designer includes two types of design elements to assist you in managing data contained in DB2® enabled Notes® databases:
- Programming Overview and User Interface
  This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
- Formula Language
  This section documents the formula language.
- LotusScript® Language
  Welcome to the LotusScript® Language section of Domino® Designer Help.
- LotusScript/COM/OLE Classes
- Java/CORBA Classes
  This section documents the Java/CORBA classes.
  - Java™ Classes Coding Guidelines
  - Java™ Classes A-Z
    - Properties and methods with ECL security using Java™
      The following tables list the properties and methods affected by an execute control list (ECL). These properties cannot be accessed or set, and these methods do not execute on the workstation unless the marked ECL priveleges are granted to the signer of the formula.
    - Java™ constants
      The following sections provide contextual information for the constants used by the Java™ classes. Listed are the constant names, their integer values (in parentheses), and the properties and methods in which they are used.
    - Supporting components
      The following classes support the use of Java™ with Notes/Domino and the Domino® Objects:
    - ACL (Java™)
      Represents the access control list (ACL) of a database.
    - ACLEntry (Java™)
      Represents a single entry in an access control list. An entry may be for a person, a group, or a server.
    - AdministrationProcess (Java™)
    - Agent (Java™)
      Represents an agent.
    - AgentContext (Java™)
      Represents the agent environment of the current program, if an agent is running it.
    - ColorObject (Java™)
    - Database (Java™)
      Represents a Notes® database.
    - DateRange (Java™)
      Represents a range of dates and times.
    - DateTime (Java™)
      Represents a date and time.
    - DbDirectory (Java™)
      Represents the Domino® databases on a server or the local computer.
    - Directory (Java™)
      Represents the Notes® directories on a specific server or local computer, each of which is associated with one or more directory navigators to allow directory lookups.
    - DirectoryNavigator (Java™)
      Allows lookups of a specific associated Notes® directory on a specific server or local computer.
    - Document (Java™)
      Represents a document in a database.
    - DocumentCollection (Java™)
      Represents a collection of documents from a database, selected according to specific criteria.
    - DominoQuery (Java)
      Java class to compile, tune, and run Domino Query Language (DQL) queries.
      - createIndex method (DominoQuery - Java)
        Creates an index (Domino view) that is optimized for DQL query terms.
      - execute method (DominoQuery - Java)
        Executes a query string passed in according to set parameters and returns named results in a database where they can be accessed again more quickly. For reuse of complex queries, this saves significant processing time.
      - explain method (DominoQuery - Java)
        Executes a query string passed in according to set parameters and returns an Explain string to indicate how the query was executed.
      - getMaxScanDocs method (DominoQuery - Java)
        Returns the current value of the DominoQuery property MaxScanDocs, the maximum allowable number of documents scanned across all query terms. Default is 500,000.
      - getMaxScanEntries method (DominoQuery - Java)
        Returns the current value of the DominoQuery property maxScanEntries, the maximum allowed view entries scanned across all query terms. Default value is 200,000.
      - getTimeoutSecs method (DominoQuery - Java)
        Returns the current value of the TimeoutSecs property, the maximum seconds a DQL query is allowed to run. Default is 300 (5 minutes).
      - isNoViews method (DominoQuery - Java)
        Returns the current value of the DominoQuery property NoViews, which specifies whether to exclude view processing when satisfying queries. Default is false, perform view processing.
      - isRebuildDesignCatalog method (DominoQuery - Java)
        Returns the current value of the DominoQuery property RebuildDesignCatalog. This property controls whether the Design Catalog is unconditionally rebuilt when processing a query using explain or execute.
      - isRefreshDesignCatalog method (DominoQuery - Java)
        Returns the current value of the DominoQuery property RefreshDesignCatalog. This property controls whether the Design Catalog is refreshed with design changes when processing a query using execute or explain.
      - isRefreshFullText method (DominoQuery - Java)
        Returns the current value of the DominoQuery property RefreshFullText. This property controls whether a full text index is refreshed with all database updates prior to a query being executed or explained.
      - isRefreshViews method (DominoQuery - Java)
        Returns the current value of the DominoQuery property RefreshViews, which controls whether views are refreshed when opened during query processing. Default is false (views are not refreshed when opened).
      - isDesignDocumentsOnly method (DominoQuery - Java)
        Returns the current value of the DominoQuery property DesignDocumentsOnly. If true, only design documents will be searched instead of data documents when execute() or explain() is called. Default value is false.
      - listIndexes method (DominoQuery - Java)
        Lists the indexes that are optimized for Domino DQL query terms.
      - parse method (DominoQuery - Java)
        Parses a DQL query string for correct syntax.
      - removeIndex method (DominoQuery - Java)
        Removes an index (Domino view) that is optimized for DQL query terms. removeIndex is very powerful and can remove production views. Take care in choosing what indexes (views) to remove.
      - removeNamedResult (DominoQuery - Java)
        Deletes names results from a database generated by the execute method.
      - resetNamedVariables method (DominoQuery - Java)
        Removes all previously set named variables and values from a DominoQuery instance.
      - setMaxScanDocs method (DominoQuery - Java)
        Sets a new value for the DominoQuery property MaxScanDocs, the maximum allowable number of documents scanned across all query terms.
      - setMaxScanEntries method (DominoQuery - Java)
        Sets a new value for the DominoQuery property MaxScanEntries, the maximum allowed view entries scanned across all query terms.
      - setNamedVariable method (DominoQuery - Java)
        Assigns a value to a named substitution variable in a DQL query.
      - setNoViews method (DominoQuery - Java)
        Sets the value of the DominoQuery property NoViews, which specifies whether to exclude view processing when satisfying queries.
      - setRebuildDesignCatalog method (DominoQuery - Java)
        Sets a new value for the DominoQuery property RebuildDesignCatalog. This property controls whether the Design Catalog is unconditionally rebuilt when a query is processed using execute or explain.
      - setRefreshDesignCatalog method (DominoQuery - Java)
        Sets a new value for the DominoQuery property RefreshDesignCatalog. This property controls whether the Design Catalog is refreshed when processing a query using execute or explain.
      - setRefreshFullText method (DominoQuery - Java)
        Sets a new value for the DominoQuery property RefreshFullText. This property controls whether a full text index is refreshed with all database updates prior to a query being executed or explained.
      - setRefreshViews method (DominoQuery - Java)
        Sets a new value for the DominoQuery property RefreshViews, which controls whether views are refreshed when opened during query processing.
      - setDesignDocumentsOnly method (DominoQuery - Java)
        Sets a value for the DominoQuery property DesignDocumentsOnly. If set to true, only design documents will be searched instead of data documents when execute() or explain() is called.
      - setTimeoutSecs method (DominoQuery - Java)
        Sets a new value for the DominoQuery property TimeoutSecs, the maximum seconds a DQL query is allowed to run.
    - DxlExporter (Java™)
    - DxlImporter (Java™)
    - EmbeddedObject (Java™)
      Represents any one of the following:
    - Form (Java™)
      Represents a form in a database.
    - IDVault (Java™)
      The IDVault class is a representation of the secure storage facility for UserIDs that may be configured for Domino by policy. IDs are stored there to allow for easier management by administrators and users. IDs from more than one server may be stored within an IDVault. The IDVault class provides methods to access UserID files, UserID objects, query the presence of an ID in the vault, sycnronise copies of IDs, and reset passwords. The IDVault class can be used to access UserID objects or files. These can be used to accomplish the encryption or decryption of Documents while running on the server.
    - International (Java™)
      Represents the international settings in the operating environment, for example, the Regional Settings in the Windows™ Control Panel. When settings change in the operating environment, Notes® recognizes the new settings immediately. For remote (IIOP) operations, these settings represent the session's server.
    - Item (Java™)
      Represents a discrete value or set of values in a document.
    - Log (Java™)
      Enables you to record actions and errors that take place during a program's execution. You can record actions and errors in:
    - MIMEEntity (Java™)
      Represents an item of type MIME (Multipurpose Internet Mail Extensions).
    - MIMEHeader (Java™)
      Represents a header in a MIME (Multipurpose Internet Mail Extensions) document.
    - Name (Java™)
      Represents a user or server name.
    - Newsletter (Java™)
      Document or set of documents that contains information from, or links to, several other documents.
    - NoteCollection (Java™)
    - NotesCalendar (Java)
      Represents a Domino® calendar.
    - NotesCalendarEntry (Java)
      Represents a Domino® calendar entry.
    - NotesCalendarNotice (Java)
      Represents a Domino® calendar notice.
    - Outline (Java™)
      Represents an outline in a database.
    - OutlineEntry (Java™)
      Represents an entry in an outline.
    - NotesProperty (Java™)
      Represents a single property in the Composite Applications properties of a Domino® application. Properties are data transmitted to or from the Property Broker, which routes your application's communication with other components in a composite application. Properties are defined in a Wiring Properties design element.
    - PropertyBroker (Java™)
      Mediates communication between components of a composite application, allowing communication between multiple Java™ components, or between Notes® and Java components.
    - QueryResultsProcessor (Java™)
      Aggregates, computes, sorts, and formats collections of documents across any set of Domino databases.
    - Registration (Java™)
      Represents the creation or administration of an ID file.
    - Replication (Java™)
      Represents the replication settings of a database.
    - ReplicationEntry (Java™)
    - RichTextDoclink (Java™)
    - RichTextItem (Java™)
      Represents an item of type rich text.
    - RichTextNavigator (Java™)
    - RichTextParagraphStyle (Java™)
      Represents rich text paragraph attributes.
    - RichTextRange (Java™)
    - RichTextSection (Java™)
    - RichTextStyle (Java™)
      Represents rich-text attributes.
    - RichTextTab (Java™)
      Represents a tab in a rich text paragraph style.
    - RichTextTable (Java™)
    - Session (Java™)
    - Stream (Java™)
      Represents a stream of binary or character data.
    - UserID (Java™)
      The UserID class represents the Notes ID file or a Notes ID when it resides within the Domino IDVault. This object is primarily used to obtain the names of the private encryption keys which are available for use within the UserID object.
    - View (Java™)
      Represents a view or folder of a database and provides access to documents within it.
    - ViewColumn (Java™)
      Represents a column in a view or folder.
    - ViewEntry (Java™)
      Represents a view entry. A view entry describes a row in a view.
    - ViewEntryCollection (Java™)
      Represents a collection of view entries of type document sorted in view order.
    - ViewNavigator (Java™)
      Represents a view navigator. A view navigator provides access to all or a subset of the entries in a view.
- Connectors
  Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
- Javadoc™ for Domino® Designer related APIs
  As part of providing additional Java™ reference documentation, Domino® Designer ships with a help plugin that contains Javadoc™ for additional Domino Designer related APIs.

DominoQuery (Java)

Java class to compile, tune, and run Domino Query Language (DQL) queries.

Containment

Contained by Database

Properties

MaxScanDocs (Through GetMaxScanDocs and GetMaxScanDocs methods)

MaxScanEntries (Through GetMaxScanEntries and GetMaxScanEntries methods)

NoViews (Through IsNoViews and SetNoViews methods)

RebuildDesignCatalog (Through IsRebuildDesignCatalog and SetRebuildDesignCatalog

RefreshViews (Through IsRefreshViews and SetRefreshViews methods)

RefreshDesignCatalog (Through IsRefreshDesignCatalog and SetRefreshDesignCatalog

RefreshFullText (Through IsRefreshFullText and SetRefreshFullText)

DesignDocumentsOnly (Through isDesignDocumentsOnly and setDesignDocumentsOnly methods)

TimeoutSecs (Through GetTimeoutSec and SetTimeoutSec methods)

Methods

getMaxScanEntries

isRebuildDesignCatalog

isRefreshDesignCatalog

isRefreshFullText

isDesignDocumentsOnly

removeNamedResult

resetNamedVariables

setMaxScanEntries

setNamedVariable

setRebuildDesignCatalog

setRefreshDesignCatalog

setRefreshFullText

setRefreshViews

setDesignDocumentsOnly

Creation and access

CreateDominoQuery executed against a Database object creates a DominoQuery instance.

For details about DQL syntax and operation, see the section Domino Query Language.

Language cross-reference

NotesDominoQuery (LotusScript)