Home
HCL Domino Designer 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
Session (Java™)
ApplicationShouldQuit (Session - Java®)
Provides the backend interface for OSProcessShouldQuit. Returns a value of True if this process should quit.

HCL Domino Designer User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in Domino Designer 14?
  The following features are new for developers in HCL Domino® Designer 14.
- What's new in Nomad Designer?
  HCL Nomad for web browsers v1.0.10 introduces the capability to design Notes databases. For more information, see HCL Nomad for web browsers User Documentation, Nomad web Designer.
- 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.
    - 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™)
      - Examples: Session class
        This application creates a new Session object and accesses its properties.
      - AddressBooks (Session - Java™)
        Read-only. The Domino® Directories and Personal Address Books, including directory catalogs, known to the current session.
      - AgentContext (Session - Java™)
        Read-only. Represents the agent environment of the current program, if an agent is running it.
      - CommonUserName (Session - Java™)
        Read-only. The common name of the user that created the session.
      - EffectiveUserName (Session - Java™)
        Read-only. The user name that is in effect for the current program.
      - HttpURL (Session - Java™)
      - International (Session - Java™)
        Read-only. The international (regional) settings for the session's operating environment.
      - IsConvertMIME (Session - Java™)
        Read-Write. Indicates whether items of type Item.MIME_PART are converted to rich text upon Document instantiation.
      - IsOnServer (Session - Java™)
        Read-only. Indicates whether the session is running on a server.
      - IsTrustedSession (Session - Java™)
        Read-only. Indicates whether the session is a trusted session.
      - IsValid (Session - Java™)
        Read-only. Indicates whether an instantiated Session object is still valid.
      - NotesVersion (Session - Java™)
        Read-only. The release of Domino® the session is running on.
      - OrgDirectoryPath (Session - Java™)
        Read-only. The default directory of the current user in a hosted organization.
      - Platform (Session - Java™)
        Read-only. The name of the platform the session is running on.
      - ServerName (Session - Java™)
        Read-only. The full name of the server that the session is running on.
      - UserGroupNameList (Session - Java™)
        Read-only. The groups to which the current user belongs.
      - UserName (Session - Java™)
        Read-only. The full name of the user or server that created the session.
      - UserNameList (Session - Java™)
        Read-only. The name of the user or server that created the session, and the alternate name if it exists.
      - UserNameObject (Session - Java™)
        Read-only. The name, in the form of a Name object, of the user or server that created the session.
      - ApplicationShouldQuit (Session - Java®)
        Provides the backend interface for OSProcessShouldQuit. Returns a value of True if this process should quit.
      - createAdministrationProcess (Session - Java™)
      - createColorObject (Session - Java™)
      - createDateRange (Session - Java™)
        Creates a new DateRange object.
      - createDateTime (Session - Java™)
        Creates a DateTime object that represents a specified date and time.
      - createDxlExporter (Session - Java™)
      - createDxlImporter (Session - Java™)
      - createLog (Session - Java™)
        Creates a new Log object with the name you specify.
      - createName (Session - Java™)
        Creates a new Name object.
      - createNewsletter (Session - Java™)
        Given a DocumentCollection containing the documents you want, creates a new Newsletter.
      - createRegistration (Session - Java™)
        Creates a new Registration object.
      - createRichTextParagraphStyle (Session - Java™)
        Creates a new RichTextParagraphStyle object.
      - createRichTextStyle (Session - Java™)
        Creates a new RichTextStyle object.
      - createStream (Session - Java™)
        Creates a new Stream object.
      - evaluate (Session - Java™)
        Evaluates a Domino® formula.
      - freeResourceSearch (Session - Java™)
        Searches for free resource slots for calendaring and scheduling.
      - freeTimeSearch (Session - Java™)
        Searches for free-time slots in the calendar.
      - getCalendar (Session - Java)
        Creates a new NotesCalendar object.
      - getDatabase (Session - Java™)
        Creates a Database object that represents the database located at the server and file name you specify, and opens the database, if possible.
      - getDbDirectory (Session - Java™)
        Creates a new DbDirectory object using the name of the server you want to access.
      - getDirectory (Session - Java™)
        Creates a new Directory object using the name of the server you want to access.
      - getEnvironmentString (Session - Java™)
        Given the name of a string or numeric environment variable, retrieves its value.
      - getEnvironmentValue (Session - Java™)
        Given the name of a numeric environment variable, retrieves its value.
      - getPropertyBroker (Session - Java™)
        Retrieves the property broker for this session.
      - getSessionToken (Session - Java™)
        Gets a session token for enabling sign-on to Domino® and WebSphere® servers in a domain that supports Single Sign-on.
      - getURLDatabase (Session - Java™)
        Finds and opens the default Web Navigator database.
      - getUserPolicySettings (NotesSession - Java™)
        Gets a policy document.
      - hashPassword (Session - Java™)
        Hashes a string value so that it is not recognizable.
      - resetUserPassword (Session - Java™)
        Use an agent to change the password of a user ID stored in the ID vault and/or specify the number of times a user ID can be downloaded from the vault after a password reset or ID recovery.
      - resolve (Session - Java™)
        Returns the Domino® object that a URL addresses.
      - sendConsoleCommand (Session - Java™)
      - setEnvironmentVar (Session - Java™)
        Sets the value of a string or numeric environment variable.
      - verifyPassword (Session - Java™)
        Verifies a plain string value against a hashed value.
    - 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.

ApplicationShouldQuit (Session - Java®)

Provides the backend interface for OSProcessShouldQuit. Returns a value of True if this process should quit.

Defined in

Syntax

public boolean ApplicationShouldQuit()
			throws NotesException;

Legal Values


Value	Description
True	Boolean. True is returned if this process should quit.
False	Boolean. False is returned if this process should not quit.

Language cross-reference

ApplicationShouldQuit in JavaScript™ NotesSession class