Home
IBM Domino Designer Basic User Guide and Reference
Basic product usage information and programming language reference information.
Java/CORBA Classes
This section documents the Java/CORBA classes.
Java™ Classes A-Z
NoteCollection (Java™)
SelectHelpIndex (NoteCollection - Java™)
Read-write. Indicates whether the collection contains a help index note.

IBM Domino Designer Basic User Guide and Reference
Basic product usage information and programming language reference information.
- 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 in Domino core allowing for a terse shorthand syntax for finding documents according to a wide variety of complexity of terms. It leverages existing design elements without the need to write detailed code to access them.
- 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.
    - 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™)
      - Examples: NoteCollection class
        This agent builds a note collection consisting only of the documents in the database.
      - Count (NoteCollection - Java™)
        Read-only. The number of notes in the collection.
      - LastBuildTime (NoteCollection - Java™)
        Read-only. Date and time of the last build for this note collection.
      - Parent (NoteCollection - Java™)
        Read-only. The database that contains the note collection.
      - SelectAcl (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains an ACL note.
      - SelectActions (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for actions.
      - SelectAgents (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for agents.
      - SelectDatabaseScript (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains a database script note.
      - SelectDataConnections (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains a data connection note.
      - SelectDocuments (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains the data documents.
      - SelectFolders (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for folders.
      - SelectForms (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for forms.
      - SelectFramesets (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for frame sets.
      - SelectHelpAbout (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains an "About Database" note.
      - SelectHelpIndex (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains a help index note.
        Examples: SelectHelpIndex property (NoteCollection - Java™)
        This agent builds a note collection that consists of the help index note.
      - SelectHelpUsing (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains a "Using Database" note.
      - SelectIcon (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains an icon note.
      - SelectImageResources (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for image resources.
      - SelectionFormula (NoteCollection - Java™)
        Read-write. Formula that selects notes for inclusion in the collection.
      - SelectJavaResources (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for Java™ resources.
      - SelectMiscCodeElements (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for miscellaneous code elements.
      - SelectMiscFormatElements (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for miscellaneous format elements.
      - SelectMiscIndexElements (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for miscellaneous index elements.
      - SelectNavigators (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for navigators.
      - SelectOutlines (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for outlines.
      - SelectPages (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for pages.
      - SelectProfiles (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains profile documents.
      - SelectReplicationFormulas (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains replication formulas.
      - SelectScriptLibraries (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for script libraries.
      - SelectSharedFields (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for shared fields.
      - SelectStylesheetResources (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for style sheet resources.
      - SelectSubforms (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for subforms.
      - SelectViews (NoteCollection - Java™)
        Read-write. Indicates whether the collection contains notes for views.
      - SinceTime (NoteCollection - Java™)
        Read-write. Indicates the earliest note creation time in the collection.
      - add (NoteCollection - Java™)
        Adds one or more notes to a note collection.
      - buildCollection (NoteCollection - Java™)
        Builds (compiles) the note collection.
      - clearCollection (NoteCollection - Java™)
        Clears (invalidates) a note collection build.
      - getFirstNoteID (NoteCollection - Java™)
        Gets the first note in a collection.
      - getNextNoteID (NoteCollection - Java™)
        Given a note, finds the note immediately following it in a collection.
      - intersect (NoteCollection - Java™)
        Creates a note collection containing the notes common to the original collection and the note or notes specified in the intersection parameter.
      - remove (NoteCollection - Java™)
        Removes one or more notes from a note collection.
      - selectAllAdminNotes (NoteCollection - Java™)
        Selects or deselects the administration notes for inclusion in the collection.
      - selectAllCodeElements (NoteCollection - Java™)
        Selects or deselects the notes for code elements for inclusion in the collection.
      - selectAllDataNotes (NoteCollection - Java™)
        Selects or deselects the data notes for inclusion in the collection.
      - selectAllDesignElements (NoteCollection - Java™)
        Selects or deselects the notes for design elements for inclusion in the collection.
      - selectAllFormatElements (NoteCollection - Java™)
        Selects or deselects the notes for format elements for inclusion in the collection.
      - selectAllIndexElements (NoteCollection - Java™)
        Selects or deselects the notes for index elements for inclusion in the collection.
      - selectAllNotes (NoteCollection - Java™)
        Selects or deselects all notes for inclusion in the collection.
    - 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.
- Lotus® Connectors
  Lotus® 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.

SelectHelpIndex (NoteCollection - Java™)

Read-write. Indicates whether the collection contains a help index note.

Defined in

Data type

boolean

Syntax

public boolean getSelectHelpIndex()
   throws NotesException
public void setSelectHelpIndex(boolean flag)
   throws NotesException

Legal values

true to indicate inclusion of a help index note
false to indicate exclusion of a help index note

Usage

The following methods set this property:

createNoteCollection in Database
selectAllDesignElements
selectAllNotes

Example