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
Database (Java™)
Represents a Notes® database.
IsInMultiDbIndexing (Database - Java™)

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 12?
  The following features are new for developers in HCL Domino® Designer 12.
- 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.
      - Examples: Database class
      - ACL (Database - Java™)
        Read-only. The access control list for a database.
      - ACLActivityLog (Database - Java™)
      - Agents (Database - Java™)
        Read-only. All of the agents in a database.
      - AllDocuments (Database - Java™)
        Read-only. An unsorted collection containing all the documents in a database.
      - Categories (Database - Java™)
        Read-Write. The categories under which a database appears in the Database Library. Multiple categories are separated by a comma or semicolon.
      - Created (Database - Java™)
        Read-only. The date/time a database was created.
      - CurrentAccessLevel (Database - Java™)
        Read-only. The current user's access level to a database.
      - DesignTemplateName (Database - Java™)
        Read-only. The name of the design template from which a database inherits its design. If the database does not inherit its design from a design template, returns an empty string.
      - FileFormat (Database - Java™)
      - FileName (Database - Java™)
        Read-only. The file name of a database, excluding the path.
      - FilePath (Database - Java™)
        Read-only. The path and file name of a database.
      - FolderReferencesEnabled (Database - Java™)
        Read-write. Indicates whether this database maintains folder references for documents.
      - Forms (Database - Java™)
        Read-only. All the forms in a database.
      - FTIndexFrequency (Database - Java™)
      - HttpURL (Database - Java™)
      - IsClusterReplication (Database - Java™)
      - IsConfigurationDirectory (Database - Java™)
      - IsCurrentAccessPublicReader (Database - Java™)
      - IsCurrentAccessPublicWriter (Database - Java™)
      - IsDelayUpdates (Database - Java™)
        Read-Write. Indicates whether updates to a server are delayed (batched) for better performance.
      - IsDesignLockingEnabled (Database - Java™)
      - IsDirectoryCatalog (Database - Java™)
        Read-only. Indicates whether a database is a Directory Catalog database, also known as the Light Weight NAB, or the Enterprise Address Book.
      - IsDocumentLockingEnabled (Database - Java™)
      - IsFTIndexed (Database - Java™)
        Read-only. Indicates whether or not a database has a full-text index.
      - IsInMultiDbIndexing (Database - Java™)
        Examples: IsInMultiDbIndexing property
        This agent toggles the setting for including the current database in multi-database indexing.
      - IsInService (Database - Java™)
      - IsLink (Database - Java™)
      - IsMultiDbSearch (Database - Java™)
        Read-only. Indicates whether a database is of type "Multi DB Search."
      - IsOpen (Database - Java™)
        Read-only. Indicates whether a database is open.
      - IsPendingDelete (Database - Java™)
      - IsPrivateAddressBook (Database - Java™)
        Read-only. Indicates if a database is a Personal Address Book.
      - IsPublicAddressBook (Database - Java™)
        Read-only. Indicates if a database is a Domino® Directory.
      - LastFixup (Database - Java™)
      - LastFTIndexed (Database - Java™)
        Read-only. The date that a database's full-text index was last updated.
      - LastModified (Database - Java™)
        Read-only. The date/time that a database was last modified.
      - LimitRevisions (Database - Java™)
      - LimitUpdatedBy (Database - Java™)
      - ListInDbCatalog (Database - Java™)
      - Managers (Database - Java™)
        Read-only. People, servers, and groups that have Manager access to a database.
      - MaxSize (Database - Java™)
        Read-only. The maximum size of a database in kilobytes.
      - NotesURL (Database - Java™)
      - Parent (Database - Java™)
        Read-only. The Notes® session that contains a database.
      - PercentUsed (Database - Java™)
        Read-only. The percent of a database's total size that is occupied by real data (and not empty space).
      - ReplicaID (Database - Java™)
        Read-only. A 16-digit hexadecimal number that represents the replica ID of a Notes® database. Databases with the same replica ID are replicas of one another.
      - ReplicationInfo (Database - Java™)
      - Server (Database - Java™)
        Read-only. The name of the server where a database resides.
      - Size (Database - Java™)
        Read-only. The size of a database, in bytes.
      - SizeQuota (Database - Java™)
        Read-Write. The size quota of a database, in kilobytes.
      - SizeWarning (Database - Java™)
      - TemplateName (Database - Java™)
        Read-only. The template name of a database, if the database is a template. If the database is not a template, returns an empty string.
      - Title (Database - Java™)
        Read-Write. The title of a database.
      - Type (Database - Java™)
      - UndeleteExpireTime (Database - Java™)
      - Views (Database - Java™)
        Read-only. The views and folders in a database.
      - compact (Database - Java™)
        Compacts a local database.
      - compactWithOptions (Database - Java™)
      - createCopy (Database - Java™)
        Creates an empty copy of the current database.
      - createDocument (Database - Java™)
        Creates a document in a database and returns a Document object that represents the new document.
      - createDominoQuery (Database – Java)
        Gets an instance of the DominoQuery class for use in running DQL queries.
      - createFromTemplate (Database - Java™)
        Creates a new database from an existing database.
      - createFTIndex (Database - Java™)
      - createNoteCollection (Database - Java™)
      - createOutline (Database - Java™)
        Creates an outline in the current database.
      - createReplica (Database - Java™)
        Creates a replica of the current database at a new location.
      - createView (Database - Java™)
      - enableFolder (Database - Java™)
        Ensures that a folder exists, creating it if necessary.
      - fixup (Database - Java™)
      - FTDomainSearch (Database - Java™)
        Conducts a Domain Search, that is, a full-text search of all databases listed in a Domain Catalog and marked as included for multi-database indexing.
      - FTSearch (Database - Java™)
        Conducts a full-text search of all the documents in a database.
      - FTSearchRange (Database - Java™)
        Conducts a full-text search of all the documents in a database.
      - getAgent (Database - Java™)
        Finds an agent in a database, given the agent name.
      - getAllReadDocuments (Database - Java™)
      - getAllUnreadDocuments (Database - Java™)
      - getDocumentByID (Database - Java™)
        Finds a document in a database, given the document note ID.
      - getDocumentByUNID (Database - Java™)
        Finds a document in a database, given the document universal ID (UNID).
      - getDocumentByURL (Database - Java™)
        Instantiates a document in the database on which it is called and returns a Document object for it. This method is typically used for either the Server Web Navigator or Personal Web Navigator database, but can be called on any Database object.
      - getForm (Database - Java™)
        Finds a form in a database, given the form name.
      - getModifiedDocuments (Database - Java™)
      - getModifiedDocumentsWithOptions (Database - Java™)
        Lets you retrieve all modified documents meeting matches for specified options.
      - getNamedDocument (Database - Java)
        Returns a named document.
      - getNamedDocumentCollection (Database - Java)
        Returns a document collection of named documents.
      - getOption (Database - Java™)
      - getOutline (Database - Java™)
        Gets an outline in the current database.
      - getProfileDocCollection (Database - Java™)
      - getProfileDocument (Database - Java™)
        Retrieves or creates a profile document.
      - createQueryResultsProcessor (Database - Java)
        Gets an instance of the QueryResultsProcessor class for use processing the document collections and the output of DQL queries.
      - getURLHeaderInfo (Database - Java™)
        Gets the specific Hypertext Transfer Protocol (HTTP) header information from the Uniform Resource Locator (URL). A URL is a text string used for identifying and addressing a Web resource.
      - getView (Database - Java™)
        Finds a view or folder in a database, given the name or alias of the view or folder.
      - grantAccess (Database - Java™)
        Modifies a database access control list to provide a specified level of access to a person, group, or server.
      - markForDelete (Database - Java™)
      - open (Database - Java™)
        Opens a database.
      - openByReplicaID (Database - Java™)
      - openIfModified (Database - Java™)
      - openWithFailover (Database - Java™)
      - queryAccess (Database - Java™)
        Returns a person's, group's, or server's current access level to a database.
      - queryAccessPrivileges (Database - Java™)
      - queryAccessRoles (Database - Java™)
        Returns the roles of a person, group, or server in a database.
      - remove (Database - Java™)
        Permanently deletes a database.
      - removeAllQueryNamedResults (Database - Java)
        Deletes all named results sets saved in a database by the DominoQuery execute method.
      - removeFTIndex (Database - Java™)
      - replicate (Database - Java™)
        Replicates a local database with its replica(s) on a server.
      - revokeAccess (Database - Java™)
        Removes a person, group, or server from a database access control list. This resets the access level for that person, group, or server to the Default setting for the database.
      - search (Database - Java™)
        Given selection criteria for a document, returns all documents in a database that meet the criteria.
      - setOption (Database - Java™)
      - setUserIDForDecrypt (Database - Java™)
        After calling this method on a database, any document that is opened within the database is decrypted using the encryption keys within the userID object, as specified in the document SecretEncryptionKeys field.
      - sign (Database - Java™)
      - transactionBegin (Database - Java)
        Begins recording changes to a database on a Domino server.
      - transactionCommit (Database - Java)
        Makes changes to a database in a batch after a transactionBegin call.
      - transactionRollback (Database - Java)
        Discards database changes recorded by transactionBegin.
      - updateFTIndex (Database - Java™)
        Updates the full-text index of a 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.
    - 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.

IsInMultiDbIndexing (Database - Java™)

Read-write. Indicates whether a database can be included in multi-database indexing.

Note: This property is new with Release 6.5.

Defined in

Database

Data type

boolean

Syntax

public boolean isInMultiDbIndexing()
    throws NotesException
public void setInMultiDbIndexing(boolean indexing)
    throws NotesException

Legal values

true if the database allows inclusion in multi-database indexing
false if the database does not allow inclusion in multi-database indexing

Usage

This property corresponds to "Include in multi-database indexing" in the database design properties of the UI.

The database must be open to use this property.

Example