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
DxlImporter (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.
    - DocumentCollection (Java™)
      Represents a collection of documents from a database, selected according to specific criteria.
    - DxlExporter (Java™)
    - DxlImporter (Java™)
      - Example: DxlImporter class
      - AclImportOption (DxlImporter - Java™)
        Read-write. Indicates the handling of the incoming ACL entries: ignore, replace, or update.
      - CompileLotusScript (DxlImporter - Java™)
        Read-write. Specifies whether the Importer should compile any LotusScript® code that occurs within imported notes.
      - CreateFTIndex (DxlImporter - Java™)
        Read-write. Indicates whether the database receiving the imported notes is full-text indexed.
      - DesignImportOption (DxlImporter - Java™)
        Read-write. Indicates the handling of the incoming design elements: create, ignore, or replace.
      - DocumentImportOption (DxlImporter - Java™)
        Read-write. Indicates the handling of incoming documents: create, ignore, replace, or update.
      - ExitOnFirstFatalError (DxlImporter - Java™)
        Read-write. Indicates that processing should terminate if any fatal error is encountered.
      - ImportedNoteCount (DxlImporter - Java™)
        Read-only. The number of Domino® notes being imported.
      - InputValidationOption (DxlImporter - Java™)
        Read-write. Indicates that if a DTD is specified in the XML declaration statement, it should be used to validate the input XML.
      - Log (DxlImporter - Java™)
        Read-only. An XML representation of warnings, errors, and fatal errors generated by the processor.
      - LogComment (DxlImporter - Java™)
        Read-write. A comment added to the beginning of the log.
      - ReplaceDbProperties (DxlImporter - Java™)
        Read-write. Indicates whether the incoming DXL replaces the database properties.
      - ReplicaRequiredForReplaceOrUpdate (DxlImporter - Java™)
        Read-write. Indicates whether the replica ID of the DXL and the target database must match.
      - UnknownTokenLogOption (DxlImporter - Java™)
        Enables you to assign different error messages to different types of errors thrown when unrecognized data is encountered by the importer.
      - getFirstImportedNoteID (DxlImporter - Java™)
        Gets the first note in the collection.
      - getNextImportedNoteID (DxlImporter - Java™)
        Given a note, finds the note immediately following it in a collection.
      - importDxl (DxlImporter - Java™)
        Converts DXL data to Domino® data.
    - 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.

DxlImporter (Java™)

Represents the conversion of DXL (Domino® XML) to Domino® data.

Note: This class is new with Release 6.5.

Containment

Contained by: Session

Properties

AclImportOption through getAclImportOption and setAclImportOption

CompileLotusScript through getCompileLotusScript and setCompileLotusScript

CreateFTIndex through getCreateFTIndex and setCreateFTIndex

DesignImportOption through getDesignImportOption and setDesignImportOption

DocumentImportOption through getDocumentImportOption and setDocumentImportOption

ExitOnFirstFatalError through getExitOnFirstFatalError and setExitOnFirstFatalError

ImportedNoteCount through getImportedNoteCount

InputValidationOption through getInputValidationOption and setInputValidationOption

Log through getLog

LogComment through getLogComment and setLogComment

ReplaceDbProperties through getReplaceDbProperties and setReplaceDbProperties

ReplicaRequiredForReplaceOrUpdate through getReplicaRequiredForReplaceOrUpdate and setReplicaRequiredForReplaceOrUpdate

UnknownTokenLogOption through getUnknownTokenLogOption and setUnknownTokenLogOption

Methods

getFirstImportedNoteID

getNextImportedNoteID

recycle

Creation and access

Use createDxlImporter in Session to create a DxlImporter object.

Use AclImportOption, DesignImportOption, and DocumentImportOption to indicate whether you want to create additional elements in the output database from the incoming DXL, ignore incoming elements, replace existing elements, or update existing elements.

Call importDxl to initiate an import.