Home
HCL Domino Designer Basic 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
DocumentCollection (Java™)
Represents a collection of documents from a database, selected according to specific criteria.
Query (DocumentCollection - Java™)
Read-only. The text of the query that produced a document collection if the collection results from a full-text or other search.

HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in HCL Domino Designer 11 for developers?
  The following features are new for developers in HCL Domino® Designer 11.
- 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.
      - Examples: DocumentCollection class
        This agent gets all the documents in a database.
      - Count (DocumentCollection - Java™)
        Read-only. The number of documents in a collection.
      - IsSorted (DocumentCollection - Java™)
        Read-only. Indicates whether the documents in a collection are sorted. A collection is sorted only when it results from a full-text search.
      - Parent (DocumentCollection - Java™)
        Read-only. The database that contains a document collection.
      - Query (DocumentCollection - Java™)
        Read-only. The text of the query that produced a document collection if the collection results from a full-text or other search.
        Examples: Query property (DocumentCollection - Java™)
        This agent demonstrates a formula that gets the query for a document collection.
      - UntilTime (DocumentCollection - Java™)
      - addDocument (DocumentCollection - Java™)
        Adds a document to a collection.
      - clone (DocumentCollection - Java™)
        Returns a collection object which is a copy of the original collection.
      - contains method
        Indicates whether or not a DocumentCollection contains all of the given Documents or all of the Documents associated with the given ViewEntries.
      - deleteDocument (DocumentCollection - Java™)
        Deletes a document from a collection.
      - FTSearch (DocumentCollection - Java™)
        Conducts a full-text search of all the documents in a document collection, and reduces the collection to a sorted collection of those documents that match.
      - getDocument (DocumentCollection - Java™)
        Gets a specified document in a collection.
      - getFirstDocument (DocumentCollection - Java™)
        Gets the first document in a collection.
      - getLastDocument (DocumentCollection - Java™)
        Gets the last document in a collection.
      - getNextDocument (DocumentCollection - Java™)
        Gets the document immediately following the current document or a specified document in a collection.
      - getNthDocument (DocumentCollection - Java™)
        Given a position number, returns the document at that position in a collection.
      - getPrevDocument (DocumentCollection - Java™)
        Gets the document immediately preceding the current document or a specified document in a collection.
      - intersect (DocumentCollection - Java™)
        Removes from a document collection any documents not also contained in a second collection.
      - markAllRead (DocumentCollection - Java™)
        Marks all the documents in a collection read.
      - markAllUnread (DocumentCollection - Java™)
        Marks all the documents in a collection unread.
      - merge (DocumentCollection - Java™)
        Adds to a document collection any documents not already in the collection that are contained in a second collection.
      - putAllInFolder (DocumentCollection - Java™)
        Adds all the documents in the collection to the specified folder. If the folder does not exist in the document's database, it is created.
      - removeAll (DocumentCollection - Java™)
        Permanently removes the documents in a collection from a database.
      - removeAllFromFolder (DocumentCollection - Java™)
        Removes all documents in the collection from the specified folder.
      - subtract (DocumentCollection - Java™)
        Removes from a document collection any documents contained in a second collection.
      - stampAll (DocumentCollection - Java™)
        Replaces the value of a specified item in all documents in a collection.
      - stampAllMulti (DocumentCollection - Java™)
        Replaces the values of specified items in all documents in a document collection.
      - updateAll (DocumentCollection - Java™)
        Marks all documents in a collection as processed by an agent.
    - DominoQuery (Java)
      Java class to compile, tune, and run Domino Query Language (DQL) queries.
    - 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.
    - 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.

Query (DocumentCollection - Java™)

Read-only. The text of the query that produced a document collection if the collection results from a full-text or other search.

Defined in

DocumentCollection

Data type

String

Syntax

public String getQuery()
    throws NotesException

Usage

For collections produced without a search, this property returns an empty string.

Example