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
Supporting components
The following classes support the use of Java™ with Notes/Domino and the Domino® Objects:
BluemixContext (Java)
Used to help in the development of XPages applications running on Bluemix. This class provides properties to retrieve information from the XPages runtime and connection information from any bound XPages NoSQL Database service.
getRootDir (DataService - Java™)
Read-only. Returns the root directory information related to the application associated with the bound service.

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:
      - AgentBase (Java™)
        Notes/Domino agents must extend AgentBase and use NotesMain() as the entry point for their functional code. Use getSession() to create a Session object. For output to browsers as well as Notes® clients (the Java™ debug console), create a PrintWriter object with getAgentOutput().
      - AppletBase and JAppletBase classes (Java™)
        Applets must extend AppletBase or JAppletBase and use notesAppletInit(), notesAppletStart(), and notesAppletStop() as the entry points for their functional code. Use openSession() or openSession(String user, String pwd) to create a Session object.
      - Base (Java™)
        The Base class defines methods that are common to all the classes. User code should not directly access the Base class.
      - BluemixContext (Java)
        Used to help in the development of XPages applications running on Bluemix. This class provides properties to retrieve information from the XPages runtime and connection information from any bound XPages NoSQL Database service.
        atHybridDbName (BluemixContext - Java™)
        For use with hybrid applications. Returns returns a Vector value that contains the address of your private Domino® server as the first element and the path to your database in the second element.
        findHybridDatabaseName (BluemixContext - Java™)
        For use with hybrid applications. Returns a String value that can be passed to the databaseName property of XPages data sources. This value will be properly formatted to point a data source to a data NSF on the private Domino server of your hybrid environment.
        getAPP_HOME_URL (BluemixContext - Java™)
        Read-only. Returns the Home URL for the application.
        getAPP_INCLUDE_XPAGES_TOOLBOX (BluemixContext - Java™)
        Read-only. Returns true if the Bluemix™ application includes the XPages Toolbox.
        getAPP_JVM_HEAPSIZE (BluemixContext - Java™)
        Read-only. Returns the heapsize of the JVM running this application.
        getAPP_PRELOAD_DB (BluemixContext - Java™)
        Read-only. Returns the preload db environment variable.
        getAPP_VERBOSE_STAGING (BluemixContext - Java™)
        Read-only. Returns the verbose staging environment variable.
        getBuildPackVersion (BluemixContext - Java™)
        Read-only. Returns the XPages buildpack version number.
        getDataService (BluemixContext - Java™)
        Returns a DataService component representing a bound XPages NoSQL Database service.
        getDataServiceByName (BluemixContext - Java™)
        Returns a named DataService component representing a bound XPages NoSQL Database service.
        IsDataServiceByNameExists (BluemixContext - Java™)
        Read-only. Returns true if this application is bound to a named XPages NoSQL Database Service.
        IsDataServiceExists (BluemixContext - Java™)
        Read-only. Returns true if this application is bound to any XPages NoSQL Database Service.
        IsHybridApplication (BluemixContext - Java™)
        For use with hybrid applications. Returns True if this application has been configured as a hybrid Bluemix® application.
        IsRunningOnBluemix (BluemixContext - Java™)
        Read-only. Returns true if this XPages application is running in the Bluemix™ environment.
        DataService (Java™)
        Used to help in the development of XPages applications running on Bluemix™. The DataService class is based on the Java™ class com.ibm.xsp.bluemix.util.context.BluemixContext.DataService. This class provides methods to retrieve information about the bound XPages NoSQL Database Service from the VCAP_SERVICES environment.
        AtDbName (DataService - Java™)
        Read-only. This method is intended to be used as a substitute for the @DbName() @ function. @DbName() and atDbName() are commonly used with the @DbLookup and @DbColumn at-functions.
        FindDatabaseName (DataService - Java™)
        Read-only. Returns the database name associated with the bound service being queried.
        GetAppPath (DataService - Java™)
        Read-only. Returns the application location path of the database associated with the bound service.
        getCredentialsValue (DataService - Java™)
        Read-only. Can be used as an alternative to return the same credential values as getAppPath(), getUserName(), and getPassword() and so on. The method looks directly at the "credentials" values found in the VCAP_SERVICES environment variable.
        getHost (DataService - Java™)
        Read-only. Returns the name of the host associated with the application using the bound service.
        getLabel (DataService - Java™)
        Read-only. Returns the label that was assigned to the application associated with the bound service.
        getPlan (DataService - Java™)
        Read-only. Returns the Bluemix™ service plan assigned to the application associated with the bound service.
        getRootDir (DataService - Java™)
        Read-only. Returns the root directory information related to the application associated with the bound service.
        getServerName (DataService - Java™)
        Read-only. Returns the hosting server name information related to the application associated with the bound service.
        getUserName (DataService - Java™)
        Read-only. Returns the user name information related to the application associated with the bound service.
        getValue (DataService - Java™)
        Read-only. Can be used as an alternative to return the same values as getName(), getLabel(), and getPlan(). The method looks directly at the values in the VCAP_SERVICES environment variable.
      - NotesAppletContext (Java™)
        An applet in a Domino® database can call the following methods of NotesAppletContext to get the context of the applet:
      - NotesError and NotesException classes (Java™)
        The NotesException class extends java.lang.Exception to include exception handling for Notes/Domino. The NotesError class defines constants for Domino® error codes.
      - NotesFactory (Java™)
        Applications call the NotesFactory createSession methods to create a Session object.
      - NotesThread (Java™)
        The NotesThread class extends java.lang.Thread to include special initialization and termination code for Notes/Domino. This extension to Thread is required to run Java™ programs that make local calls to the Notes/Domino classes. It is not necessary for remote calls. An application that makes both local and remote calls can determine dynamically when to use the static methods sinitThread and stermThread. Remote calls can be made while a local thread is running; however, do not use an object obtained through one session in a call to the other session. Applets that do not start threads and agents that extend AppletBase and AgentBase do not need to code for local versus remote calls, as this capability is provided in the base code.
      - XSLTResultTarget (Java™)
        This is a wrapper class for the XSLTResultTarget class in the com.lotus.xsl package that contains the result of a transformation when you use the new XSL Processor. An instance of this class provides a container for the XSLT Result tree. The XSLTResultTarget class extends java.lang.Object.
      - InputSource (EmbeddedObject - Java™)
        Read-only. SAX InputSource representation of the contents of an EmbeddedObject, Item, or MIMEEntity object.
      - InputStream (EmbeddedObject - Java™)
        Read-only. InputStream representation of the contents of an EmbeddedObject, Item, or MIMEEntity object.
      - Reader (EmbeddedObject - Java™)
        Read-only. Contents of an EmbeddedObject, Item, or MIMEEntity object in the form of a java.io.Reader object.
      - getURL (Java™)
        The following method:
      - parseXML (EmbeddedObject - Java™)
        Parses the contents of an attachment and creates the DOM tree of the XML.
      - recycle (Java™)
        The recycle method unconditionally destroys an object and returns its memory to the system.
      - toString (Java™)
        The following lotus.domino classes override the toString method of java.lang.Object and return values as indicated:
      - transformXML (EmbeddedObject - Java™)
        Transforms the contents of an attachment using the specified Domino® EmbeddedObject, Item, MIMEEntity, or RichTextItem style, or any InputSource style, and provides the results to the specified XSLTResultTarget object.
      - Visibility interface
        All lotus.domino classes implement the java.beans.Visibility interface and are configured to be invisible. The following methods return values as indicated:
    - 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™)
    - 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.

getRootDir (DataService - Java™)

Read-only. Returns the root directory information related to the application associated with the bound service.

Defined in

Syntax

public String getRootDir()
       throws NotesException:

Usage

This property returns the root directory information related to the application associated with the bound service.

Language cross-reference

getRootDir method in JavaScript™ DataService object.