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
Document (Java™)
Represents a document in a database.
NotesURL (Document - Java™)

IBM Domino Designer Basic User Guide and Reference
Basic product usage information and programming language reference information.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
- Domino® Designer templates
  The templates described in the following table are available with Domino® Designer and are specifically intended for use by application developers.
- Importing to and exporting from views
- Developing applications using MAPI
  Domino® Designer Release 6 and later supports the messaging application program interface (MAPI), which allows mail integration between Domino and a MAPI-compliant messaging application, such as Microsoft™ Outlook, Microsoft Office applications, or user-written C++ programs.
- Features to avoid using in Web applications
  Developers creating applications specifically for the Web, or for the dual purpose of serving Notes® and Web clients, should review the following tables for features that are not supported on the Web.
- URL commands for Web applications
  You have a variety of options for programming a Web site. You can directly manipulate objects such as documents or views in an application using Domino® URL commands. Adding Domino URL commands as HTML in forms gives users shortcuts for navigating databases and performing other tasks quickly.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- 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.
      - Examples: Document class
      - Authors (Document - Java™)
        Read-only. The names of the people who have saved a document.
      - ColumnValues (Document - Java™)
        Read-only. A vector of values, each element of which corresponds to a column value in the document's parent view. The first value in the vector is the value that appears in the view's first column for the document, the second value is the one that appears in the second column, and so on. The value of each element of the vector is the result of the corresponding column's formula and the items on the current document. Some elements in the vector might have no value.
      - Created (Document - Java™)
        Read-only. The date/time a document was created.
      - EmbeddedObjects (Document - Java™)
        Read-only. The OLE/2 and OLE/1 embedded objects in a document.
      - EncryptionKeys (Document - Java™)
        Read-Write. The key(s) used to encrypt a document. The encrypt method uses these keys when it encrypts the document.
      - FolderReferences (Document - Java™)
        Read-only. The names of the folders containing a document.
      - FTSearchScore (Document - Java™)
        Read-only. The full-text search score of a document, if it was retrieved as part of a full-text search.
      - HasEmbedded (Document - Java™)
        Read-only. Indicates whether a document contains one or more embedded objects, object links, or file attachments.
      - HttpURL (Document - Java™)
      - IsDeleted (Document - Java™)
        Read-only. Indicates whether a Document object represents an existing document (not a deletion stub) on an ongoing basis.
      - IsEncrypted (Document - Java™)
      - IsEncryptOnSend (Document - Java™)
        Read-Write. Indicates whether a document is encrypted when mailed.
      - IsNewNote (Document - Java™)
        Read-only. Indicates whether a document is new. A document is new if it has not been saved.
      - IsProfile (Document - Java™)
        Read-only. Indicates whether a Document object is a profile document.
      - IsResponse (Document - Java™)
        Read-only. Indicates whether a document is a response to another document.
      - IsSaveMessageOnSend (Document - Java™)
        Read-Write. Indicates whether a document is saved to a database when mailed. Applies only to new documents that have not yet been saved.
      - IsSentByAgent (Document - Java™)
        Read-only. Indicates whether a document was mailed by a Domino® program.
      - IsSigned (Document - Java™)
        Read-only. Indicates whether a document contains a signature.
      - IsSignOnSend (Document - Java™)
        Read-Write. Indicates whether a document is signed when mailed.
      - IsValid (Document - Java™)
        Read-only. Indicates whether a Document object represents an existing document (not a deletion stub) initially.
      - Items (Document - Java™)
        Read-only. All the items in a document. An item is any piece of data stored in a document.
      - Key (Document - Java™)
        Read-only. If a profile document, the user name (key) of the profile.
      - LastAccessed (Document - Java™)
        Read-only. The date/time a document was last modified or read.
      - LastModified (Document - Java™)
        Read-only. The date/time a document was last modified.
      - LockHolders (Document - Java™)
      - NameOfProfile (Document - Java™)
        Read-only. If a profile document, the name of the profile.
      - NoteID (Document - Java™)
        Read-only. The note ID of a document, which is a hexadecimal value of up to 8 characters that uniquely identifies a document within a particular database.
      - NotesURL (Document - Java™)
        Examples: NotesURL property (Document - Java™)
        This agent gets the Notes® and HTTP URLs for a document in the current database. The agent varies the display depending on whether access is through Notes (the HTTP URL is blank) or HTTP protocols.
      - ParentDatabase (Document - Java™)
        Read-only. The database that contains a document.
      - ParentDocumentUNID (Document - Java™)
        Read-only. The universal ID of a document's parent, if the document is a response. Returns an empty string if a document doesn't have a parent.
      - ParentView (Document - Java™)
        Read-only. The view from which a document was retrieved, if any.
      - Responses (Document - Java™)
        Read-only. The immediate responses to a document.
      - Signer (Document - Java™)
        Read-only. The name of the person who created the signature, if a document is signed.
      - Size (Document - Java™)
        Read-only. The size of a document in bytes, which includes the size of any file attachments to the document.
      - UniversalID (Document - Java™)
        Read-Write. The universal ID, which uniquely identifies a document across all replicas of a database. In character format, the universal ID is a 32-character combination of hexadecimal digits (0-9, A-F).
      - Verifier (Document - Java™)
        Read-only. The name of the certificate that verified a signature, if a document is signed.
      - appendItemValue (Document - Java™)
        Creates a new item in a document and optionally sets the item value.
      - attachVCard (Document - Java™)
        Attaches one or more documents in vCard format.
      - closeMIMEEntities (Document - Java™)
        Closes MIME processing associated with items of a specified name.
      - computeWithForm (Document - Java™)
        Validates a document by executing the default value, translation, and validation formulas, if any are defined in the document form.
      - convertToMIME (Document - Java™)
        Converts a document in Notes® format to MIME format similar to a mail router.
      - copyAllItems (Document - Java™)
        Copies all items in the current document into the destination document. The item names are unchanged.
      - copyItem (Document - Java™)
        Copies an item into the current document and optionally assigns the copied item a new name.
      - copyToDatabase (Document - Java™)
        Copies a document to a specified database.
      - createMIMEEntity (Document - Java™)
        Creates an uninitialized top-level MIME entity in a document.
      - createReplyMessage (Document - Java™)
        Creates a new document that is formatted as a reply to the current document.
      - createRichTextItem (Document - Java™)
        Creates a new rich-text item in a document.
      - encrypt (Document - Java™)
        Encrypts a document.
      - generateXML (Document - Java™)
      - getAttachment (Document - Java™)
        Returns a representation of a file attachment. You can use this method to find file attachments that are not contained in a rich text item (such as an attachment in a Release 2 database) as well as file attachments that are contained in a rich text item.
      - getFirstItem (Document - Java™)
        Returns the first item of a specified name in a document.
      - getItemValue (Java™)
        Returns the value of an item.
      - getItemValueCustomData (Document - Java™)
        Returns as an object the value of an item containing custom data.
      - getItemValueCustomDataBytes (Document - Java™)
        Returns as a byte array the value of an item containing custom data.
      - getItemValueDateTimeArray (Document - Java™)
      - getItemValueDouble (Document - Java™)
        Returns the value of an item with a single numeric value.
      - getItemValueInteger (Document - Java™)
        Returns the value of an item with a single numeric value.
      - getItemValueString (Document - Java™)
        Returns the value of an item with a single text value.
      - getMIMEEntity (Document - Java™)
        Gets a top-level MIME entity.
      - getRead (Document - Java™)
      - getReceivedItemText (Document - Java™)
      - hasItem (Document - Java™)
        Indicates whether an item exists in the document.
      - lock (Document - Java™)
      - lockProvisional (Document - Java™)
      - makeResponse (Document - Java™)
        Makes one document a response to another. The two documents must be in the same database.
      - markRead (Document - Java™)
        Marks the document as read.
      - markUnread (Document - Java™)
        Marks the document as unread.
      - putInFolder (Document - Java™)
        Adds a document to a folder. If the folder does not exist, it is created.
      - remove (Document - Java™)
        Permanently removes a document from a database, but does a soft deletion if soft deletions are enabled.
      - removeFromFolder (Document - Java™)
        Removes a document from a folder.
      - removeItem (Document - Java™)
        Removes an item from a document.
      - removePermanently (Document - Java™)
      - renderToRTItem (Document - Java™)
        Creates a picture of a document and places it into a rich-text item that you specify.
      - replaceItemValue (Java™)
        Replaces all items of the specified name with one new item, which is assigned the specified value. If the document does not contain an item with the specified name, this method creates a new item and adds it to the document.
      - replaceItemValueCustomData (Document - Java™)
        Replaces all items of the specified name with one new item, which is assigned custom data from an object. If the document does not contain an item with the specified name, this method creates a new item and adds it to the document.
      - replaceItemValueCustomDataBytes (Document - Java™)
        Replaces all items of the specified name with one new item, which is assigned custom data from a byte array. If the document does not contain an item with the specified name, this method creates a new item and adds it to the document.
      - save (Document - Java™)
        Saves any changes you have made to a document.
      - send (Document - Java™)
        Mails a document.
      - sign (Document - Java™)
        Signs a document.
      - unlock (Document - Java™)
    - DocumentCollection (Java™)
      Represents a collection of documents from a database, selected according to specific criteria.
    - 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.
    - 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.
- 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.

NotesURL (Document - Java™)

Read-only. The Domino® URL of a form when Notes® protocols are in effect.

Note: This property is new with Release 6.5.

Defined in

Document

Data type

String

Syntax

public String getNotesURL()
    throws NotesException

Usage

If Notes® protocols are not available, this property returns an empty string. See HttpURL.

See resolve in Session for additional information and examples.

Example