Home
HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
LotusScript/COM/OLE Classes
LotusScript® Classes Coding Guidelines
The following topics cover some general guidelines for writing LotusScript® code using Domino® objects:
Accessing Domino® databases
Examining and adjusting an access control list
You examine and adjust the access control list (ACL) of a database through objects of the following classes:

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
  - LotusScript® Classes Coding Guidelines
    The following topics cover some general guidelines for writing LotusScript® code using Domino® objects:
    - Using the Domino® classes
      Domino® Designer defines LotusScript® classes that allow you to access Domino structures on two levels:
    - Using LotusScript® features in Domino®
      All LotusScript® features work in Domino® exactly as specified in generic LotusScript, with the following exceptions and clarifications:
    - Accessing Domino® databases
      - Accessing database properties
        The following table lists the NotesDatabase properties:
      - Locating a database on a server and local disk
      - Opening a database
        The New method for the NotesDatabase class opens an existing database if you specify the file name as the second argument. The New method does not create a database. The first argument specifies the server and defaults (empty string) to the local Domino® directory.
      - Creating and deleting a database
        Use one of the following methods to create a database. The New method does not create a database.
      - Accessing an outline
      - Examining and adjusting an access control list
        You examine and adjust the access control list (ACL) of a database through objects of the following classes:
        Examples: Examining and adjusting an access control list using LotusScript
      - Examining and adjusting database replication settings
      - Accessing a document in LotusScript®
      - Accessing a form
        You can access existing forms in a database as follows:
    - Accessing views and folders
    - Accessing documents in LotusScript® classes
    - Accessing items in LotusScript® classes
    - Accessing rich text items in LotusScript® classes
    - Accessing sessions
    - Accessing supporting Domino® objects
    - Handling run-time errors
    - Accessing the Domino® Objects through COM
    - Using OLE
      The Notes® client is an OLE automation controller and server.
    - Using OLE custom controls
      You can embed OLE custom controls in Domino® Designer forms and write scripts for them just as you can for a native object. When a control is active (has focus), the menu is a combination of Domino Designer (File, Applet, and Window) and control items. The control menu items may include one for itself (for example, "Spreadsheet" for a spreadsheet control) and Help--the control help is substituted for Domino Designer help.
  - LotusScript® Classes A-Z
    This documentation lists each class, property, and method in the Domino® class library. Each class is followed by an alphabetical listing of the properties for that class and an alphabetical listing of the methods for that class. To find the property or method you want, turn to the class to which the property or method belongs.
  - LotusScript® Classes Tutorial
    Welcome to LotusScript® and Domino®. "LotusScript Classes Tutorial" consists of three lessons designed to introduce you to using the LotusScript language in Domino. Each lesson includes:
- Java/CORBA Classes
  This section documents the Java/CORBA classes.
- 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.

Examining and adjusting an access control list

You examine and adjust the access control list (ACL) of a database through objects of the following classes:


Class	Contains	To
NotesDatabase	ACL property	Access a NotesACL object
	CurrentAccessLevel property	Determine the current user access level
	GrantAccess, RevokeAccess, QueryAccess, QueryAccessPrivileges, and QueryAccessRoles methods	Directly create, remove, and check ACL entries
NotesACL	GetEntry, GetFirstEntry, and GetNextEntry methods	Access ACL entries
	CreateACLEntry method	Create ACL entries
	RemoveACLEntry method	Remove ACL entries in COM only
	AdministrationServer	Determine and set name of administration server
	IsAdminNames, IsAdminReaderAuthor	Determine administration access to Names, Authors, and Readers fields
	InternetLevel property	Determine and set the maximum Internet access level for the current database
	Roles property and AddRole, DeleteRole, and RenameRole methods	Access roles
	Parent property	Determine the database that owns the ACL
	UniformAccess property	Enforce, or not enforce, a consistent ACL across all replicas of a database
	IsExtendedAccess property	Enable, or not enable, extended access
NotesACLEntry	CanCreateDocuments, CanCreateLSOrJavaAgent, CanCreatePersonalAgent, CanCreatePersonalFolder, CanCreateSharedFolder, CanDeleteDocuments, CanReplicateOrCopyDocuments, IsAdminReaderAuthor, IsAdminServer, Level, Name, and Parent properties	Examine the ACL entry
	NameObject property	Supported in COM only
	New and Remove methods	Create and remove an entry
	Roles property and IsRoleEnabled, EnableRole, and DisableRole methods	Associate ACL entries with roles
	IsPublicReader and IsPublicWriter properties	Become public readers and writers
	IsGroup, IsPerson, and IsServer properties	Determine and set the user type for an ACL entry

The Save method of NotesACL writes changes that you make to the ACL and ACL entries to permanent storage. Otherwise, the changes are lost when your program exits.