Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface DKConstantDD

All Superinterfaces:
DKConstant
All Known Implementing Classes:
DKAccessControlDD, DKAttrDefDD, DKAttrFieldDefDD, DKAttrKeywordDefDD, DKAttrProfileDefDD, DKBinderDefDD, DKCabinetDefDD, DKDatastoreDefDD, DKDocumentDefDD, DKMessageDD, DKRoomDefDD, DKServerDefDD, DKBlobDD, DKAccessControlListDD, DKAccessDataDD, DKDatastoreExtDD, DKDatastoreDD, DKResultSetCursorDD

public interface DKConstantDD
extends DKConstant

This interface contains constants used by the Domino.Doc client connector code.

See Also:
DKConstant

Field Summary
static java.lang.String copyright
           
static java.lang.String DK_ACTYPE_DD
           
static int DK_DD_APPEND
          Append to existing file
static short DK_DD_ATTR
          Attribute type is Domino.Doc
static short DK_DD_BINDER
          Entity type is Binder
static int DK_DD_BLOB
          Constant used to specify that a large object is of type binary (a BLOB)
static short DK_DD_CABINET
          Entity type is Cabinet
static int DK_DD_CREATE
          Create a new file, do not overwrite existing file
static java.lang.String DK_DD_CREATE_DATE
          Field name used for searching a Domino.Doc server.
static java.lang.String DK_DD_DATASTORE_EXT
           
static java.lang.String DK_DD_DEFAULT_MIMETYPE
           
static java.lang.String DK_DD_DLL_NAME
           
static java.lang.String DK_DD_DOC_TYPE
          Field name used for searching a Domino.Doc server.
static short DK_DD_DOCUMENT
          Entity type is Document
static java.lang.String DK_DD_DS_API_NAME
          The name of the Domino.Doc Desktop Enabler API
static java.lang.String DK_DD_DSTYPE
          Constant used to build Domino.Doc identifiers
static short DK_DD_FIELD
          Attribute type is Field
static java.lang.String DK_DD_FILENAME
          Field name used for searching a Domino.Doc server.
static short DK_DD_KEYWORD
          Attribute type is Keyword
static short DK_DD_LIBRARY
          Entity type is Library
static int DK_DD_OPT_CONTENT
          This options is used to control whether or not attributes and data definitions are added to the DKDDO's which are returned in a result.
static int DK_DD_OPT_CONTENT_ATTRONLY
           
static int DK_DD_OPT_CONTENT_NO
           
static int DK_DD_OPT_CONTENT_YES
           
static int DK_DD_OPT_LIMIT
          This option is used to limit the number of documents returned when a query is executed.
static int DK_DD_OPT_NO_LIMIT
          Specify this value for DK_DD_OPT_LIMIT to retrieve all possible documents when doing a search.
static int DK_DD_OPT_RUN_FINALIZE_ON_EXIT
          This option is used to control whether or not the java runtime environment (JRE) will be forced to do garbage collection when it exits.
static int DK_DD_OPT_RUN_FINALIZE_ON_EXIT_NO
           
static int DK_DD_OPT_RUN_FINALIZE_ON_EXIT_YES
           
static int DK_DD_OPT_SEARCH_OPTION
          This option is not used in this verion of Domino.Doc support.
static int DK_DD_OPT_SEARCH_OPTION_STEMS
          A Value for DK_DD_OPT_SEARCH_OPTION option.
static int DK_DD_OPT_SEARCH_OPTION_THESAURUS
          A Value for DK_DD_OPT_SEARCH_OPTION option.
static int DK_DD_OPT_SORT_ORDER
          This option is used to change the order of the results of a query.
static int DK_DD_OPT_SORT_ORDER_DATE_ASC
          A Value for DK_DD_OPT_SORT_ORDER option.
static int DK_DD_OPT_SORT_ORDER_DATE_DES
          A Value for DK_DD_OPT_SORT_ORDER option.
static int DK_DD_OPT_SORT_ORDER_SCORES
          A Value for DK_DD_OPT_SORT_ORDER option.
static int DK_DD_OVERWRITE
          Create a new file, or overwrite an existing file
static int DK_DD_PID_DOC_EXT
           
static int DK_DD_PID_DOC_ID
           
static int DK_DD_PID_DOC_ID_CNT
           
static short DK_DD_PROFILE
          Attribute type is Profile
static short DK_DD_ROOM
          Entity type is Room
static java.lang.String DK_DD_SERVER_TYPE
          A string to describe the type of server connector
static java.lang.String DK_DD_TITLE
          Field name used for searching a Domino.Doc server.
static int DK_DD_UNKNOWN
          A constant to indicate an undefined state
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 

Field Detail

DK_DD_DATASTORE_EXT

public static final java.lang.String DK_DD_DATASTORE_EXT

DK_DD_UNKNOWN

public static final int DK_DD_UNKNOWN
A constant to indicate an undefined state

DK_DD_DLL_NAME

public static final java.lang.String DK_DD_DLL_NAME

DK_DD_DOC_TYPE

public static final java.lang.String DK_DD_DOC_TYPE
Field name used for searching a Domino.Doc server. The name of a profile is referred to as a "DocType" in Domino.Doc documents at the server.

DK_DD_CREATE_DATE

public static final java.lang.String DK_DD_CREATE_DATE
Field name used for searching a Domino.Doc server.

DK_DD_TITLE

public static final java.lang.String DK_DD_TITLE
Field name used for searching a Domino.Doc server.

DK_DD_FILENAME

public static final java.lang.String DK_DD_FILENAME
Field name used for searching a Domino.Doc server.

DK_DD_OPT_LIMIT

public static final int DK_DD_OPT_LIMIT
This option is used to limit the number of documents returned when a query is executed. DK_DD_OPT_LIMIT_NO_LIMIT is the default. You can specify any positive DK_DD_OPT_LIMIT option you like.

DK_DD_OPT_NO_LIMIT

public static final int DK_DD_OPT_NO_LIMIT
Specify this value for DK_DD_OPT_LIMIT to retrieve all possible documents when doing a search. (Any number greater than zero will limit the number of documents returned.)

DK_DD_OPT_SORT_ORDER

public static final int DK_DD_OPT_SORT_ORDER
This option is used to change the order of the results of a query.

DK_DD_OPT_SORT_ORDER_SCORES

public static final int DK_DD_OPT_SORT_ORDER_SCORES
A Value for DK_DD_OPT_SORT_ORDER option. See documentation for Lotus FTSearch method for an explanation of this value.

DK_DD_OPT_SORT_ORDER_DATE_DES

public static final int DK_DD_OPT_SORT_ORDER_DATE_DES
A Value for DK_DD_OPT_SORT_ORDER option. See documentation for Lotus FTSearch method for an explanation of this value.

DK_DD_OPT_SORT_ORDER_DATE_ASC

public static final int DK_DD_OPT_SORT_ORDER_DATE_ASC
A Value for DK_DD_OPT_SORT_ORDER option. See documentation for Lotus FTSearch method for an explanation of this value.

DK_DD_OPT_SEARCH_OPTION

public static final int DK_DD_OPT_SEARCH_OPTION
This option is not used in this verion of Domino.Doc support. It is here for compatibility with the Domino.Doc search options only.

DK_DD_OPT_SEARCH_OPTION_STEMS

public static final int DK_DD_OPT_SEARCH_OPTION_STEMS
A Value for DK_DD_OPT_SEARCH_OPTION option. See documentation for Lotus FTSearch method for an explanation of this value.

DK_DD_OPT_SEARCH_OPTION_THESAURUS

public static final int DK_DD_OPT_SEARCH_OPTION_THESAURUS
A Value for DK_DD_OPT_SEARCH_OPTION option. See documentation for Lotus FTSearch method for an explanation of this value.

DK_DD_OPT_CONTENT

public static final int DK_DD_OPT_CONTENT
This options is used to control whether or not attributes and data definitions are added to the DKDDO's which are returned in a result. If your query is in a DKCQExpr, then the contents of the schema mapping and display list also control the contents of a DKDDO in a result.
DK_DD_OPT_CONTENT_NO
No attributes or data definitions will be returned in the result.
DK_DD_OPT_CONTENT_YES
Attributes and data definitions will be returned in the result.
DK_DD_OPT_CONTENT_ATTRONLY
Attributes, but no data definitions, will be returned in the result.

DK_DD_OPT_CONTENT_NO

public static final int DK_DD_OPT_CONTENT_NO

DK_DD_OPT_CONTENT_YES

public static final int DK_DD_OPT_CONTENT_YES

DK_DD_OPT_CONTENT_ATTRONLY

public static final int DK_DD_OPT_CONTENT_ATTRONLY

DK_DD_OPT_RUN_FINALIZE_ON_EXIT

public static final int DK_DD_OPT_RUN_FINALIZE_ON_EXIT
This option is used to control whether or not the java runtime environment (JRE) will be forced to do garbage collection when it exits.

The reason this is an option for the Domino.Doc connector is that this connector creates temporary files to hold document contents. In order to avoid retrieving document contents more than once, the temporary files are kept until the result objects are garbage collected by the JRE.

The default is DK_DD_OPT_RUN_FINALIZE_ON_EXIT_YES.

DK_DD_OPT_RUN_FINALIZE_ON_EXIT_YES
Forces the JRE to run finalize methods of unreferenced objects, but waits until the JRE exits.
DK_DD_OPT_RUN_FINALIZE_ON_EXIT_NO
Does not force the JRE to run finalize methods when it exits. Whether or not temporary Domino.Doc files are deleted is left to the whims of the JRE and it's garbage collection behavior.

DK_DD_OPT_RUN_FINALIZE_ON_EXIT_NO

public static final int DK_DD_OPT_RUN_FINALIZE_ON_EXIT_NO

DK_DD_OPT_RUN_FINALIZE_ON_EXIT_YES

public static final int DK_DD_OPT_RUN_FINALIZE_ON_EXIT_YES

DK_DD_LIBRARY

public static final short DK_DD_LIBRARY
Entity type is Library

DK_DD_ROOM

public static final short DK_DD_ROOM
Entity type is Room

DK_DD_CABINET

public static final short DK_DD_CABINET
Entity type is Cabinet

DK_DD_BINDER

public static final short DK_DD_BINDER
Entity type is Binder

DK_DD_DOCUMENT

public static final short DK_DD_DOCUMENT
Entity type is Document

DK_DD_PROFILE

public static final short DK_DD_PROFILE
Attribute type is Profile

DK_DD_FIELD

public static final short DK_DD_FIELD
Attribute type is Field

DK_DD_KEYWORD

public static final short DK_DD_KEYWORD
Attribute type is Keyword

DK_DD_ATTR

public static final short DK_DD_ATTR
Attribute type is Domino.Doc

DK_DD_DSTYPE

public static final java.lang.String DK_DD_DSTYPE
Constant used to build Domino.Doc identifiers

DK_DD_SERVER_TYPE

public static final java.lang.String DK_DD_SERVER_TYPE
A string to describe the type of server connector

DK_DD_DS_API_NAME

public static final java.lang.String DK_DD_DS_API_NAME
The name of the Domino.Doc Desktop Enabler API

DK_DD_BLOB

public static final int DK_DD_BLOB
Constant used to specify that a large object is of type binary (a BLOB)

DK_DD_DEFAULT_MIMETYPE

public static final java.lang.String DK_DD_DEFAULT_MIMETYPE

DK_DD_OVERWRITE

public static final int DK_DD_OVERWRITE
Create a new file, or overwrite an existing file

DK_DD_CREATE

public static final int DK_DD_CREATE
Create a new file, do not overwrite existing file

DK_DD_APPEND

public static final int DK_DD_APPEND
Append to existing file

DK_ACTYPE_DD

public static final java.lang.String DK_ACTYPE_DD

DK_DD_PID_DOC_ID

public static final int DK_DD_PID_DOC_ID

DK_DD_PID_DOC_EXT

public static final int DK_DD_PID_DOC_EXT

DK_DD_PID_DOC_ID_CNT

public static final int DK_DD_PID_DOC_ID_CNT

copyright

public static final java.lang.String copyright

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.