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 Coding Guidelines
Accessing Domino® sessions
Making a newsletter

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
    - Running a Java™ program
      You can call the Domino® Objects from a Java™ program by importing the lotus.domino package. The program can be coded as an application, a Domino agent, an applet, or a servlet. Local calls access run-time code on the local computer, which must have Domino installed. CORBA-based remote (IIOP) calls access run-time code from a remote Domino server; in this case, the local computer need not have Domino installed. Compilation must be on a computer with Domino Designer installed.
    - Accessing databases
    - Accessing views and folders using Java™
    - Accessing documents in Java™ classes
    - Accessing items in Java™ classes
    - Accessing rich text items in Java™ classes
    - Accessing Domino® sessions
      - Accessing session properties using Java™
        The following methods access the Session properties:
      - Using environment variables with Java™
      - Accessing agents using Java™
        Two classes provide access to agents: AgentContext and Agent.
      - Accessing international settings using Java™
      - Hashing passwords
      - Locking documents and design elements (Java™)
      - Working with time
      - Making a log
      - Making a newsletter
      - Representing a name using Java™
      - Representing a color using Java™
      - Working with streams of data with Java™
      - Building a note collection (Java™)
  - Java™ Classes A-Z
- 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.

Making a newsletter

A newsletter is a summary document containing a picture of another document or links to other documents. Use the createNewsletter method of Session to create a Newsletter object based on a document collection. Use one of the following methods to format the newsletter:

formatDocument formats the newsletter to contain a picture of one document in the document collection that is the basis for the newsletter. You must iterate through the document collection to format all the documents.
formatMsgWithDoclinks formats the newsletter to contain links to all the documents in the document collection that is the basis for the newsletter.

You can use the send method of Document to mail documents based on newsletters.

You can use the save method of Document to save documents based on newsletters.

The following methods access the Newsletter properties. The boolean properties are useful only with formatMsgWithDoclinks.

isDoScore returns true if the formatted newsletter is to contain each document's relevance score; set this property to true or false with setDoScore before calling formatMsgWithDoclinks.
isDoSubject returns true if the formatted newsletter is to contain the content of each document's subject field; set this property to true or false (default) with setDoSubject before calling formatMsgWithDoclinks.
getSubjectItemName returns the name of the field associated with isDoSubject; set this property with setSubjectItemName if you set setDoSubject to true.
getParent returns a Session object representing the current session.