Class DKDatastoreICM

• DSNAME=<datastore_name> Supplies the datastore name. Optional
• DBAUTH=<SERVER | CLIENT> Database authentication information. If SERVER is supplied the database userid and password will be supplied to the server. If CLIENT is supplied no database userid and password will be supplied to the server. The default is SERVER. Optional
• LDAPORG=<(LDAP organization)> Specifies the LDAP organization providing the directory information. This can be used when the list of datasources is in IBM Secure Way. Optional
• ICMSERVERSFILE=<(datasource information file location)> Specifies the file location of the datasource information. Optional
• ICMSERVERSURL=<(datasource information url location)> Specifies the url location of the datasource information. Optional
• ICMENVFILE=<(database connection information file location)> Specifies the file location of the database connection information. Optional
• ICMENVURL=<(database connection information url location)> Specifies the url location of the database connection information. Optional
• CHKDBPOOL=<YES | NO> Check for database pooling. The default is YES. Optional

• SQLUID=<database userid> userid for the underlying database. Optional
• SQLPWD=<database password> user's password for the undelying database. Optional
• SSO=<TRUE | FALSE> Single signon information. If set to TRUE DBAUTH must be set to CLIENT, no user_name and no authentication should be supplied to this connect method. Optional
• DBAUTH=<SERVER | CLIENT> Database authentication information. If SERVER is supplied the database userid and password will be supplied to the server. If CLIENT is supplied no database userid and password will be supplied to the server. The default is SERVER. Optional
• SCHEMA=<database schema> database schema name to use. Optional
• HOSTNAME=<host name> library server host name. Optional
• REMOTEDB=<remote database name> library server remote database name. DB2 only. Optional
• PORT=<remote database port> library server remote database port. DB2 only. Optional
• REMOTE=<TRUE | FALSE> library server remote database indicator. DB2 only. Optional
• APPLNAME=<application name> Specifies the application name you are running. It is used to identify trace and log information. Optional
• NPWD=<new password for userid> Changes user's password to this new value. Only valid if userid is not a system userid. If the user wishes to use characters like single/double quotes, semi colons or equals they can enclose the new password in single quotes. If there are any single quotes in the new password those single quotes should become 2 single quotes. For example 'abc;=' would become NPWD='''abc;='''. Optional
• LANG=<database language> Server language. See "Content Manager System Administration" Manual for all the possible values. Optional
• REPTYPE=<DB2CON> Use the database connection id first to logon to the database. Optional
• TRACESERVERLEVEL=<trace level> Trace level for the server. Optional
  • The default trace level for the server is 0.
  • ICM trace flags
    • 0 ICMTRACE_OFF
    • 1 ICMTRACE_BASIC
    • 2 ICMTRACE_DETAILED
    • 4 ICMTRACE_DATA
    • 8 ICMTRACE_PERFORMANCE
    • 16 ICMTRACE_PARSEBUILD
    • 32 ICMTRACE_MEMDEBUG
    • 256 ICMTRACE_CACHE_TRACE
    • 512 ICMTRACE_CACHE_ALLOC
    • 1024 ICMTRACE_CACHE_MGT
  • Trace level is constructed by adding the numbers above. For example, a common tracing level is 15 (calculated by adding up 1 (ICMTRACE_BASIC), 2 (ICMTRACE_DETAILED), 4 (ICMTRACE_DATA), and 8 (ICMTRACE_PERFORMANCE)).
• ITEM_EXITS=<Class Name> Optional. Register a DB2 Content Manager v8 Connecor Exits Implementation that extends extending a supported Exit Interface such as DKItemExitsICM or supported subclass. For more information, refer to the DKItemExitsICM class documentation.
• TRUSTEDUSERLOGON=<TRUE | FALSE> Trusted user logon indicator. If set to FALSE, ignore trusted user logon privilege. The default is TRUE. Optional
• DYNAMICTABLESPACEINFO=<TRUE | FALSE> Return dynamic table space information when retrieving item type, component type or component type index from the library server. Default is FALSE (return static table space information). Optional. Note: This is an administrative option. Setting this option to TRUE may impact performance during runtime. If the library server configuration option to disable retrieving of dynamic table space information is turned on, this connect string option set to TRUE will be overridden.
• JDBCDRIVER=< JDBC Driver Class Name> Optional. The name of JDBC driver class used to access the database. IBM DB2 Driver for JDBC and SQLJ (com.ibm.db2.jcc.DB2Driver) Type 4 driver is used as default driver for access to DB2 except on iSeries. On iSeries DB2 JDBC Type 2 Driver (com.ibm.db2.jdbc.app.DB2Driver) is used as the default driver. ClassNotFoundException is thrown when this method is unable to load the driver class. This is option applicable only for DB2.
• JDBCURL=< a database URL of the form jdbc:subprotocol:subname> Optional. The database URL is used to establish a connection to the given database. If this parameter is not passed, the method builds a JDBC URL using the information in cmbicmsrvs.ini file. The properties in the cmbicmsrvs.ini file used to build the URL are ICMREMOTEDB, ICMHOSTNAME and ICMPORT. If these proprties are available in cmbicmsrvs.ini file for the datastore name passed, Type 4 driver will be used to connect to the database. Otherwise Type 2 driver will be used. This option is applicable for both DB2 and Oracle.
• DKLogPriority=< API log level for default logger only>, or DKAPIJavaLogLevel=< API log level for log4j logger only> Optional. This is to override log level specified in the cmblogconfig.properties file. API log levels are:
  • DISABLE (Disables logging)
  • FATAL (Logs FATAL messages)
  • ERROR (Logs FATAL + ERROR messages)
  • PERF (Logs FATAL + ERROR + PERFORMANCE messages, default logger only)
  • INFO (Logs FATAL + ERROR + PERFORMANCE + INFO messages)
  • TRACE_NATIVE_API (Logs FATAL + ERROR + PERFORMANCE + INFO + TRACE_NATIVE_API messages)
  • TRACE_ENTRY_EXIT (Logs FATAL + ERROR + PERFORMANCE + INFO + TRACE_NATIVE_API + TRACE_ENTRY_EXIT messages)
  • TRACE (Logs FATAL + ERROR + PERFORMANCE + INFO + TRACE_NATIVE_API + TRACE_ENTRY_EXIT + TRACE messages)
  • DEBUG (Logs FATAL + ERROR + PERFORMANCE + INFO + TRACE_NATIVE_API + TRACE_ENTRY_EXIT + TRACE + DEBUG messages)
• GMTSYSATTRTS=<TRUE | FALSE> Get the following system attribute timestamps in GMT. SYSROOTATTRS.CREATETS, SYSROOTATTRS.LASTCHANGEDTS, SYSROOTATTRS.CHKOUTTIMESTAMP, ICM$RETENTIONDATE and ICM$AUTODELETEDATE. If set to TRUE, get above system attributes in GMT. The default is FALSE. Optional Option in cmbicmsrvs.ini file is ICMGMTSYSATTRTS=<TRUE | FALSE>
• GMTSYSATTRDATE=<TRUE | FALSE> Get the following system attributes dates in GMT. SYSROOTATTRS.EXPIRATIONDATE If set to TRUE, get above system attributes in GMT. The default is FALSE. Optional Option in cmbicmsrvs.ini file is ICMGMTSYSATTRDATE=<TRUE | FALSE>
• GMTDOCROUTINGATTRTS=<TRUE | FALSE> Get the following document routing attribute timestamps in GMT. ICMUT00204001.LASTACCTIME, ICMUT00204001.RESUMETIME, ICMUT00204001.NOTIFYTIME and ICMUT00204001.ICMPRNOTIFYTIME. If set to TRUE, get above document routing attributes in GMT. The default is FALSE. Optional Option in cmbicmsrvs.ini file is ICMGMTDOCROUTINGATTRTS=<TRUE | FALSE>
• GMTUSERATTRTS=<TRUE | FALSE> Get user attribute timestamps in GMT. If set to TRUE, get user attribute timestamps in GMT. The default is FALSE. Optional Option in cmbicmsrvs.ini file is ICMGMTUSERATTRTS=<TRUE | FALSE>
• GMTUSERATTRDATE=<TRUE | FALSE> Get user attribute dates in GMT. If set to TRUE, get user attribute dates in GMT. The default is FALSE. Optional Option in cmbicmsrvs.ini file is ICMGMTUSERATTRDATE=<TRUE | FALSE>
• GMTUSERATTRTIME=<TRUE | FALSE> Get user attribute times in GMT. If set to TRUE, get user attribute times in GMT. The default is FALSE. Optional Option in cmbicmsrvs.ini file is ICMGMTUSERATTRTIME=<TRUE | FALSE>
• JDBCPOOLCFG=<TRUE | FALSE> JDBC pool configuration indicator. If TRUE then use jdbc pool configuration options instead of cmbpool.ini. If FALSE the use cmbpool.ini for jdbc pool configuration. The default is FALSE. Optional
• JDBCPOOLTYPE=<jdbc pool type> JDBC pool type. Valid values are: DKPoolWAS - use the WebSphere connection pooling no value - no pool, connection owned by each datastore Optional
• JDBCPOOLSUBTYPE=<jdbc pool sub type> JDBC pool sub type. Valid values are: Liberty - WebSphere Liberty pool sub type Note: JDBCPOOLTYPE should be set to DKPoolWAS otherwise this option is ignored. no value - no pool sub type specified Optional
• JDBCPOOLPREFIX=<jdbc pool prefix> JDBC pool prefix. Examples of jdbc pool prefix for JNDI look up: java:comp/env/jdbc/ jdbc/ Optional
• TRUSTWASAUTH=<TRUE | FALSE> Trust WebSphere authentication indicator for connection with credential. If TRUE then trust WebSphere authentication of the LTPA token . If the principal is missing from the LTPA token, the token will be validated. If FALSE then validate the LTPA token with WebSphere. The default is FALSE. Optional
• ALLOWADMINIDFORDBPOOL=<TRUE | FALSE> Allow administrative user to logon and disable database connection pooling for this datastore instance while the database pool is using a database connect id and the representation type is DB2CON or ORACON. If set to TRUE, Allow this feature. The default is FALSE. Optional
• RMCOMMTYPE=<HTTPS_AVAILABLE | HTTPS_ONLY | HTTP> Resource manager communication type.
  • HTTPS_AVAILABLE Use Resource Manager HTTPS communication if available.
  • HTTPS_ONLY Use Resource Manager HTTPS communication only.
  • HTTP Use Resource Manager HTTP communication. (Default)
  Optional Note: If the resource manager communication type option is set to HTTPS_AVAILABLE or HTTPS_ONLY the cmbrm.ini file will not be used.
• RMSSLTRUSTSTORE=<resource manager SSL trust store> Resource manager SSL trust store. Optional
• RMSSLTRUSTSTOREPWD=<resource mgr SSL trust store password> Resource manager SSL trust store password. Optional
• RMSSLTRUSTSTORETYPE=<resource manager SSL trust store type> Resource manager SSL trust store type. Optional
• RMSSLTRUSTSTOREPROVIDERNAME=<resource manager SSL trust store provider name> Resource manager SSL trust store provider name. If this value is set, this option is only used if the trust store type option is specified. Optional
• RMSSLTRUSTMGRALGORITHM=<resource manager SSL trust manager algorithm> Resource manager SSL trust manager algorithm. If this value is not set a default value of IbmX509 will be used Optional
• RMSSLTRUSTMGRPROVIDERNAME=<resource manager SSL trust manager provider name> Resource manager SSL trust manager provider name. If this value is set, this option is only used if the trust manager algorithm option is specified. Optional
• RMSSLKEYSTORE=<resource manager SSL key store> Resource manager SSL key store. If this value is not set a default value of java.home System Property file separator lib file separator security file separator cacerts will be used if the resource manager communication type is HTTPS_AVAILABLE or HTTPS_ONLY. Optional
• RMSSLKEYSTOREPWD=<resource mgr SSL key store password> Resource manager SSL key store password. Optional
• RMSSLKEYSTORETYPE=<resource manager SSL key store type> Resource manager SSL key store type. If this value is not set a default value of JKS will be used if the resource manager communication type is HTTPS_AVAILABLE or HTTPS_ONLY. Optional
• RMSSLKEYSTOREPROVIDERNAME=<resource manager SSL key store provider name> Resource manager SSL key store provider name. If this value is set, this option is only used if the key store type option is specified.
• RMSSLKEYMGRALGORITHM=<resource manager SSL key manager algorithm> Resource manager SSL key manager algorithm. If this value is not set a default value of IbmX509 will be used Optional
• RMSSLKEYMGRPROVIDERNAME=<resource manager SSL key manager provider name> Resource manager SSL key manager provider name. If this value is set, this option is only used if the key manager algorithm option is specified. Optional
• RMSSLCERTIFICATELABEL=<resource mgr SSL keystore certificate label> Resource manager SSL key store certificate label for a certificate. This option is ignored if the resource manager SSL certificate authentication is FALSE. Note: If the resource manager SSL certificate authentication is TRUE and the keystore certificate label is specified, a check will be performed to see if the certificate associated with the specified label is found in the keystore. If the certificate is not found a DKUsageError will be thrown. Optional
• RMSSLCERTIFICATEAUTH=<TRUE | FALSE> Resource manager SSL certificate authentication. If TRUE then use SSL certificate authentication. If FALSE anonymous SSL resource manager communication. The default is FALSE. Optional
• RMSSLCBCPROTECTION=<TRUE | FALSE> Resource manager SSL cbc protection enabled indicator. If TRUE then enable SSL cbc protection. If FALSE do not enable SSL cbc protection. The default is TRUE. Optional
• RMSSLPROTOCOLMINTLS12=<TRUE | FALSE> Resource manager SSL protocol minimum is TLS 1.2. If TRUE then SSL protocol minimum is TLS 1.2. If FALSE then TLS 1.2 is not the minimum protocol. The default is FALSE. Optional
• RMSSLCIPHERSUITEFILTERING=<TRUE | FALSE> Resource manager SSL cipher suite filtering enabled If TRUE then SSL cipher Suites that contain the following words will be filtered out. NULL, _anon_, _40_, _DES_, _MD5, DES40 If FALSE then no filtering of cipher suites The default is FALSE. Optional
• RMSSLCONTEXTPROTOCOL=<resource manager SSL Context protocol> Resource manager SSL Context Protocol. The default is SSL Optional
• RMSSLRNGALGORITHM=<resource manager SSL Random Number Generator Algorithm> Resource manager SSL Random Number Generator Algorithm for SSLContext. If not specified this will not be used to initialize the SSLContext. Optional
• RMSSLCIPHERSUITES=<resource manager SSL cipher suites> Resource manager SSL cipher suites. Optional
• RMSSLALLOWABLEPROTOCOLS=<resource manager SSL allowable protocols> Resource manager SSL allowable protocols. Optional
• RMUSESSLFORURLBASEDRETRIEVES=<TRUE|FALSE> Use SSL for URL based retrieves to the Resource Manager. If TRUE then use SSL for URL based retrieves to the Resource Manager. If FALSE do not use SSL for URL base retrieves to the Resource Manager. The default is FALSE. Optional Note: If resource manager communication type option is set to HTTPS_AVAILABLE or HTTPS_ONLY this option will be ignored. Note: If this is option is set the cmbrm.ini file will not be used.
• RMCONNTIMEOUT=<resource manager connection timeout> Resource manager connection timeout. Timeout value is in milliseconds. If value is less than 0 or not set, timeout is disabled. If value is 0 then default value of 5000 is used. Optional Note: If this is option is set the cmbrm.ini file will not be used.
• RMCONNPOLLINTERVAL=<resource manager connection poll interval> Resource manager connection will be polled every interval until the connection is established or reosurce manager connection timeout is out. Interval value is in milliseconds. This value only takes effect if resource manager connection timeout is set. If value is less than 0 or not set, timeout is disabled. If value is equal to 0 then default value which is 5 is used. If value is greater than 2000 then DKUsageError exception is thrown. If value is greater than resource manager connection timeout (wrong settings) then DKUsageError exception is thrown. Optional Note: If this is option is set the cmbrm.ini file will not be used.
• RMCONNREADTIMEOUT=<resource manager connection read timeout> Resource manager connection read timeout. Read timeout value is in milliseconds. If value is less than 0 or not set, read timeout is disabled If value is 0 then default value of 5000 is used. Optional Note: If this is option is set the cmbrm.ini file will not be used.
• DBSSL=<TRUE | FALSE> SSL Database connection indicator The default is FALSE. Optional
• DBSSLPORT=<database SSL port number> Database SSL port DB2 Only. Optional
• DBSSLTRUSTSTORE=<database SSL trust store> database SSL trust store. Oracle Only. Optional
• DBSSLTRUSTSTOREPWD=<database SSL trust store password> database SSL trust store password. Note: Must be supplied if database SSL trust store is supplied by connect string or ini file. Oracle Only. Optional
• DBSSLTRUSTSTORETYPE=<database SSL trust store type> database SSL trust store type. Oracle Only. Optional
• DBSSLKEYSTORE=<database SSL key store> database SSL key store. Oracle Only. Optional
• DBSSLKEYSTOREPWD=<database SSL key store password> database SSL key store password. Note: Must be supplied if database SSL key store is supplied by connect string or ini file. Oracle Only. Optional
• DBSSLKEYSTORETYPE=<database SSL key store type> database SSL key store type. Oracle Only. Optional
• DBSSLVERSION=<database SSL version> database SSL version. Oracle Only. Optional
• DBSSLCIPHERSUITES=<database SSL cipher suites> database SSL cipher suites. Oracle Only. Optional
• DBSSLDISTINGUISHEDNAMEMATCH=<TRUE | FALSE> database SSL distinguished name match. The default is FALSE. Oracle Only. Optional
• INITACLCACHESIZE=<size> Set the national language string keyword access control list name initial cache size. If size is set to 1 , then only that acl name requested will be put into the acl name cache initially. If more acl names are required they will be added to the cache as requested. If the size is greater than 1 then that many acl names will be cached initially. Any additional acl names that are required will be added to the cache as requested. The default is 0 which means initially cache all acl names. Optional Option in cmbicmsrvs.ini file is ICMINITACLCACHESIZE=<size>
• IGNOREINIFILES=<TRUE | FALSE> Ignore ini files for connector information. If this option is used, make sure to supply all connector connection information with the connection string including SQLUID and SQLPWD. Ignored ini files: cmbicmsrvs.ini, cmbicmenv.ini, cmbrm.ini The default is FALSE. Optional
• SYSATTRTSASJAVASQLTS=<TRUE | FALSE> Get the following system attribute timestamps as java.sql.Timestamp instead of DKTimestamp for SYSROOTATTRS.CREATETS, SYSROOTATTRS.LASTCHANGEDTS and SYSROOTATTRS.CHKOUTTIMESTAMP. If set to TRUE, get above system attributes as java.sql.Timestamp instead of DKTimestamp. The default is FALSE. Optional Option in cmbicmsrvs.ini file is ICMSYSATTRTSASJAVASQLTS=<TRUE | FALSE>
• GMTSYSTS=<TRUE | FALSE> Get the following system timestamps in GMT. Event subscription created and updated timestamps, Event created timestamps If set to TRUE, get above system timestamps in GMT. The default is FALSE. Optional Option in cmbicmsrvs.ini file is ICMGMTSYSTS=<TRUE | FALSE>

• DK_CM_OPT_CACHE: Enabled/disabled cache.
• DK_ICM_OPT_LAN_CACHE: Enabled/disabled lan cache.

• DK_CM_OPT_CACHE: Enable/disable cache. Values are: DK_CM_TRUE (default), DK_CM_FALSE

• DK_ICM_OPT_LAN_CACHE: Enable/disable lan cache. Values are: DK_CM_TRUE (default), DK_CM_FALSE

• DK_CM_OPT_CACHE: Enable/disable cache. Values are: DK_CM_TRUE (default), DK_CM_FALSE
• DK_ICM_OPT_LAN_CACHE: Enable/disable lan cache. Values are: DK_CM_TRUE (default), DK_CM_FALSE

• DKConstant.DK_CM_PARM_RETRIEVE = < DKRetrieveOptionsICM instance>
  [Strongly Recommended] You should always specify your own retrieve options with your own list of requests and exclusions for the best possible performance based on the detailed performance considerations documented in the DKRetrieveOptionsICM reference documentation. Additionally, submitting a DKRetrieveOptionsICM instance enables additional retrieve optimizations that are not available through default or deprecated bitwise option behavior and avoids using the deprecated bitwise options by default.
  • See the " Retrieve Options (STRONGLY RECOMMENDED)" section of multi-item retrieve.
  • See detailed DKRetrieveOptionsICM) reference documentation (includes performance considerations).
  
  You can perform an "IDONLY" (nothing selected to retrieve beyond the PID) query by submitting a DKRetrieveOptionsICM with all selections set to 'false' (initial values) to exclude all selections. Since query itself returns the PID information in DDOs and can call multi-item retrieve on your behalf, the fastest possible response time from query is to simply return without retrieving any meta-data or content. You can call multi-item retrieve or single-item retrieve on some or all DDOs at any time on your own once you have the DDOs. If you do not set retrieve options, this is not the default.
  
  
• (deprecated) DKConstant.DK_CM_PARM_RETRIEVE = <Integer instance>
  [Deprecated and not recommended]. Use DKRetrieveOptionsICM instances instead. DKRetrieveOptionsICM offers performance advantages and enables optimizations not available when using deprecated bitwise 'int' options. This setting accepts deprecated bitwise int option values in an Integer object. All bitwise 'int' retrieve options are deprecated and not recommended. For deprecated bitwise values, see DKDatastoreICM::retrieveObjects(dkCollection,int bitwiseRetrieveOptionsInt.
  
  If no retrieve option (of any value type) is provided at all, the default retrieve option assumed is deprecated bitwise 'int' option DKConstant.DK_CM_CONTENT_ATTRONLY. However, it is always better to clearly indicate your intent with retrieve options.
  
  
• (deprecated) DKConstant.DK_CM_PARM_CONTENT = <String instance>
  [Deprecated and not recommended]. Use "Retrieve Options" (DKConstant.DK_CM_PARM_RETRIEVE = < DKRetrieveOptionsICM instance>) instead of "Content Options". Always use retrieve options and value type DKRetrieveOptionsICM. DKRetrieveOptionsICM offers performance advantages and enables optimizations not available when using deprecated bitwise 'int' retrieve options or "content options".
  
  "Content Options" specify how much content is retrieved when results are returned from query. This option is ignored if any retrieve option (DKConstant.DK_CM_PARM_RETRIEVE) is specified, which takes precedent in all cases.
  
  Content options are specified as String objects with the following supported values. The values are mapped to the bitwise 'int' retrieve options indicated. However, all bitwise 'int' retrieve options are deprecated and not recommended. For details on the mapped deprecated bitwise values, see DKDatastoreICM::retrieveObjects(dkCollection,int bitwiseRetrieveOptionsInt.
  

          Content Options              Bitwise 'int' Retrieve Options
     ------------------------   ------------------------------------------------
     (deprecated)   "IDONLY"  = (deprecated) DKConstant.DK_CM_CONTENT_IDONLY
     (deprecated)  "ATTRONLY" = (deprecated) DKConstant.DK_CM_CONTENT_ATTRONLY
     (deprecated)     "NO"    = (deprecated) DKConstant.DK_CM_CONTENT_NO
     (deprecated)    "YES"    = (deprecated) DK_CM_CONTENT_ATTRONLY | DK_CM_CONTENT_CHILDREN | DK_CM_CONTENT_YES
                     

• (deprecated) DKConstant.DK_CM_PARM_PROJECTION_LIST = <DKNVPair[] instance>
  [Deprecated and not recommended]. Use integrated DKProjectionListICM with DKRetrieveOptionsICM::attributeFilters(DKProjectionListICM) instead for projection list and attribute filtering capabilities. Submit as part of retrieve options instance under integrated interface. Do not submit separate projection list requests or using the deprecated DKNVPair[] form of a projection list.
  
  
• DKConstant.DK_CM_PARM_MAX_RESULTS = <String instance> (containing integer)
  [Recommended] Specify a maximum number of results desired as a non-negative integer formatted in a String. To specify no maximum number of results, specify value "0" (zero) (which is also the default if this option is not specified). No indication is provided to indicate whether or not there exist additional results beyond the maximum number requested. You cannot extend the results of an existing open cursor. However, if you sort your results by a unique attribute value (or perhaps based on ITEMID, you can issue another query with a condition on all returned values such that the value (such as ITEMID) is greater than the value contained in the last DDO in the set. This effectively allows you to resume where you left off.
  
  Example: options[0] = new DKNVPair(DKConstant.DK_CM_PARM_MAX_RESULTS, "50");
  
  
• DKConstant.DK_CM_PARM_PREFETCH_SIZE = <Integer instance>
  The integer value of this option indicates the desired block size in which results are fetched and retrieved in the optimized cursor. For example, when the first result is accessed, this many actual results will be pre-fetched and retrieved (with multi-item retrieve) to minimuze number of individual fetch and retrieve operations while balancing how far ahead to read and pre-fetch. Then when the second result is accessed, the next pre-fetched result is returned without any additional server calls. When a request is made and no more readily available pre-fetched results exist for the existing pre-fetched block, the next block is pre-fetched.
  
  A small pre-fetch value N allows for faster display of the first N results, but will increase the overall retrieval time for the whole result set. Retrieving all results in one block (effectively an evaluate() call) is the fastest overall time, but costs more time up front for the call to return and loads more DDOs concurrently in memory, which can be a scaling concern if you have a very large set of results.
  
  If not specified, an unspecified default block size managed by the system is used which is typically reasonable for the majority of applications.
  
  
• DKConstant.DK_CM_PREPARE_QUERY = null (no value required)
  If this option is specified, the query is only prepared, but the cursor is not opened and the query is not actually executed. Use the result set cursor's dkResultSetCursor::open() method to open the cursor after a prepare call, which executes the query, opens a new connection, and begins processing results. This option effectively means "prepare only". If not specified, by default the query is prepared, the cursor opened, and the query is executed.
  
  
• DKConstant.DK_CM_SQL_TIMEOUT = <Integer instance> (milliseconds)
  Specify a timeout (in milliseconds) for the maximum amount of time that the query should be allowed to run before it is automatically terminated (or canceled). Upon expiration of the timeout period, the system will attempt to cancel the processing of the query as soon as possible. The exact time of cancellation cannot be guaranteed, but a DKException will be thrown from this method to the caller as soon as the cancellation attempt has initiated. The query on the server cannot necessarily be immediately terminated and the server database might continue to run the query until it reaches a point where the query can be interrupted.
  
  If this option is not specified, the API will wait indefinitely for the query to finish. The timeout query function is supported if both the DBMS and driver support aborting an SQL statement.
  
  Error handling. The timeout value must be a positive integer. A zero value is equivalent to not specifying the timeout at all, and the API will wait until the query finishes. A negative timeout value will result in a DKException.
  
  To use this feature on a z/OS system DB2 database, the z/OS system DB2 database needs to be catalogued in DB2 UDB using the following set of commands. In the example, suppose that the DB2 SSID is "SGE1", the remote z/OS host (which DDF is running on port 5111) is "ihsap3", and the remote location (which can be queried on z/OS with DISPLAY DDF) is "SGE1".
  
  db2 catalog dcs database SGE1 as SGE1 PARMS \",,INTERRUPT_ENABLED\"
db2 catalog tcpip node SGE1SAP3 remote IHSAP3 server 5111
db2 catalog database SGE1 at node SGE1SAP3 authentication server
  
  Note that parameter value INTERRUPT_ENABLED above is important because it enables the canceling of DB2 threads on the z/OS host.

When adding a hierarchical item, all hierarchical constraints must be met when the item is created. For example, the item must have a single hierarchical parent. The parent is specified by setting the DKConstantICM.DK_ICM_PROPERTY_PARENT_FOLDER property to the parent DDO. Note that naming and other hierarchical constraints must also be met. For more details on hierarchical constraints, see: DKDatastoreICM::getRootFolder().

Note that when creating a hierarchical item, if that item's parent can also be concurrently reindexed or deleted, or its hierarchical links modified, an inconsistency might be introduced into the hierarchical model. For more details on this, see: DKDatastoreICM::getRootFolder().

• DK_CM_CHECKIN (8196)(default): Check in (unlock) the item.
• DK_CM_CHECKOUT (8): Check out (lock) the item.
• 0 (default): Uses option DK_CM_CHECKIN.
• DK_ICM_NO_LINKS_MEMORY_CURRENCY (32) : This option tells the API not to update referenced DDOs, in memory, to reflect newly added links. This option is very useful when adding a large number of links. Without this option, newly added links will be made persistent and the API will reflect these links in all referenced DDOs. With this option the links are still made persistent, however referenced DDOs are not updated to include this new link information. This option may be used to improve performance when an application does not require the information in the referenced DDOs to be updated. Even though this information will not be reflected in the referenced DDOs, the application can still call retrieve on these DDOs to get the latest links information when/if it is needed.
• DK_ICM_NO_ERROR_FOR_DUP_OR_NOT_FOUND_LINKS (64): Ignore any duplicate links (or folder relationships) added for any links that already exist in the system and ignore any delete link requests for links that have already been deleted. This allows you to add as many links as you desire without the need to retrieve and compare against the current links in memory and save the item with the intent that the submitted links should exist in the system. Similarly you can remove links without the need to verify that it was not already deleted by another request. For more details, refer to the documentation provided with constant DKConstantICM.DK_ICM_NO_ERROR_FOR_DUP_OR_NOT_FOUND_LINKS.

• Meta-Data Options:
  
  • (deprecated) DKConstant.DK_CM_CONTENT_ATTRONLY
    [Recommded] (Recommended starting point for considering options.) This option retrieves user and system attributes for DDOs directly submitted to retrieve. This option has unique behavior such that it overrides automatic single-item retrieve behavior that otherwise can include resource content, one level of children, and document parts listing (TOC) if anything other than DK_CM_CONTENT_ATTRONLY is used. Always use this option to eliminate automatically included data if not needed. This is one of the fastest options among the bitwise retrieve options.
  • (deprecated) DKConstant.DK_CM_CONTENT_RETRIEVE_IGNORE_CHECKEDOUT_INFO
    [Recommended] If you do not need the checked out user ID and timestamp status for the item, save some performance by not fetching this data. In addition to any other option specified (or defaults if no other options), this option excludes fetching values for DDO properties "Checked_Out_UserID" (DKConstantICM.DK_ICM_PROPERTY_CHECKEDOUTUSERID) and "Checked_Out_TS" (DKConstantICM.DK_ICM_PROPERTY_CHECKEDOUTTIMESTAMP). while the value for the properties are returned as null. With this option, the property is still listed when iterationg through properties in the DDO, but the value is returned as 'null'. Note that 'null' is also returned if the item is not currently checked out. 'null' means either not currently checked out or not fetched. Use DKRetrieveOptionsICM::basePropertyCheckedOutDetails(false) to omit the DDO properties entirely to avoid overloading the 'null' value. (This option is subject to automatic inclusions when using single-item retrieve depending on the retrieve method used, which can include document parts listing, parts attributes, and resource content (loaded in memory).)
  • (deprecated) DKConstant.DK_CM_CONTENT_RETRIEVE_IGNORE_ACL_NAME
    [Recommended] If you do not need the ACL name retrieved for the item, save some performance by not fetching this data. In addition to any other option specified (or defaults if no other options), this option excludes fetching value for DDO property "SYSROOTATTRS.ACLCODE" (DKConstantICM.DK_ICM_PROPERTY_ACL) while the value for the properties are returned as an empty string (""). With this option, the property is still listed when iterationg through properties in the DDO, but the value is returned as "". Use DKRetrieveOptionsICM::basePropertyAclName(false) to omit the DDO property entirely to avoid overloading the value. (This option is subject to automatic inclusions when using single-item retrieve depending on the retrieve method used, which can include document parts listing, parts attributes, and resource content (loaded in memory).)
  • (deprecated) DKConstant.DK_CM_CONTENT_CHILDREN
    Retrieves the list of child DDOs under any parent DDO submitted to retrieve. The child DDOs are populated within child collections and have completed PID information. No attributes of the children are retrieved. (This option is subject to automatic inclusions when using single-item retrieve depending on the retrieve method used, which can include document parts listing, parts attributes, and resource content (loaded in memory).)
  • (deprecated) DKConstant.DK_CM_CONTENT_ONELEVEL
    Similar (but not identical) to (DK_CM_CONTENT_ATTRONLY | DK_CM_CONTENT_CHILDREN) such that it retrieves the attributes for DDOs submitted directly to retrieve and lists the child component DDOs (without attributes of the children). However, it is not equivalent such that it does not have the excluding behavior of DK_CM_CONTENT_ATTRONLY that prohibits resource content and document parts listing (TOC). Consider using (DK_CM_CONTENT_ATTRONLY | DK_CM_CONTENT_CHILDREN) instead if you do not need the resource content or parts TOC during single-item retrieve calls. (This option is subject to automatic inclusions when using single-item retrieve depending on the retrieve method used, which can include document parts listing, parts attributes, and resource content (loaded in memory).)
  • (deprecated) DKConstant.DK_CM_CONTENT_LINKS_INBOUND
    In addition to any other option specified or defaults, also retrieve one level of inbound links. Populates link collections with link objects. For inbound links, the source DDO is the other item linking to the item submitted to retrieve. The source DDO will be "listed" simply with completed PID information. No attributes or other meta-data is retrieved for the linked DDO. This requires one additional server call per DDO submitted to retrieve for inbound link information. (This option is subject to automatic inclusions when using single-item retrieve depending on the retrieve method used, which can include document parts listing, parts attributes, and resource content (loaded in memory).)
  • (deprecated) DKConstant.DK_CM_CONTENT_LINKS_OUTBOUND
    In addition to any other option specified or defaults, also retrieve one level of outbound links (and folder relationships. Populates link collections with link objects and folder collections with DDOs for the folder contents. For outbound links, the target DDO is the other item linking to the item submitted to retrieve. The target DDO will be "listed" simply with completed PID information. No attributes or other meta-data is retrieved for the linked DDO. This requires one additional server call per DDO submitted to retrieve for outbound link information. (This option is subject to automatic inclusions when using single-item retrieve depending on the retrieve method used, which can include document parts listing, parts attributes, and resource content (loaded in memory).)
  • (deprecated) DKConstant.DK_CM_CONTENT_LINKS_LEVELTWO_COUNT
    Along with the first level of links, retrieve the count of the second level of links as well. All items linked under ddos submitted will have the count of their links retrieved. The count is stored as a property in the respective DDO. The property named with constant DKConstant.DK_CM_PROPERTY_LINKS_OUTBOUND_SELECTED_COUNT contains the count of the number of outbound links of the link type(s) selected for retrieval. The property names with constant DKConstant.DK_CM_PROPERTY_LINKS_INBOUND_SELECTED_COUNT contains the count of the number of inbound links of the link type(s) selected for retrieval. This option only applies if the first level of links is also requested through options DK_CM_CONTENT_LINKS_INBOUND or DK_CM_CONTENT_LINKS_OUTBOUND or this option is otherwise ignored. (This option is subject to automatic inclusions when using single-item retrieve depending on the retrieve method used, which can include document parts listing, parts attributes, and resource content (loaded in memory).)
  • (deprecated) DKConstant.DK_CM_CONTENT_ITEMTREE_NO_LINKS
    Retrieves the whole tree of components from the components submitted to retrieve through the full child hierarchy (beyond just one level) and includes attributes on all DDOs (including children). If you must retrieve the full hierarchy with attributes, this is the fastest option. No link or folder relationship information is retrieved. (This option is subject to automatic inclusions when using single-item retrieve depending on the retrieve method used, which can include document parts listing, parts attributes, and resource content (loaded in memory).)
  • (deprecated) DKConstant.DK_CM_CONTENT_ITEMTREE
    [Not Recommended] Equivalent to (DK_CM_CONTENT_ITEMTREE_NO_LINKS | DK_CM_CONTENT_LINKS_OUTBOUND | DK_CM_CONTENT_LINKS_INBOUND). Same as DK_CM_CONTENT_ITEMTREE_NO_LINKS except that this method also includes inbound and outbound links (including folder relationships). Avoid using this option unless necessary. Selecting everything typically leads to sub-optimal retrieve option usage and unnecessary performance costs. Instead, use options wisely to retrieve only data that you need for the fastest possible performance. See retrieve option information in DKDatastoreICM::retrieveObjects(dkCollection ddoColl,DKNVPair[] retrieveOptions). (This option is subject to automatic inclusions when using single-item retrieve depending on the retrieve method used, which can include document parts listing, parts attributes, and resource content (loaded in memory).)
  • (deprecated) DKConstant.DK_CM_CONTENT_IDONLY
    [(!) APPLIES TO QUERY METHODS ONLY (!)] When used with query/search ( evaluate(), execute(), executeWithCallback()) and without any other retreive options, this option instructs query to return only blank DDOs with complete PID information. Query will not call retrieve on the results on your behalf. This option is ignored by retrieve if used when calling retrieve methods directly and instead assumes original deprecated bitwise 'int retrieve option defaults. Submitting a DKConstant.DK_CM_CONTENT_IDONLY request to retrieve (not through query) actually results in far more data retrieved than you might expect by submitting this option since it is ignored. For example, the "IDONLY" request actually is behaves as a DKConstant.DK_CM_CONTENT_ONELEVEL request (or much more) for many retrieve methods by default. For modelling a true "nothing selected" request, use a DKRetrieveOptionsICM instance and do not make any requests (all settings set to 'false'). This option is deprecated for both query and retrieve. (Excluding query, this option is subject to automatic inclusions when using single-item retrieve depending on the retrieve method used, which can include document parts listing, parts attributes, and resource content (loaded in memory).)
• Resource Content Options:
  
  • (deprecated) DKConstant.DK_CM_CONTENT_YES
    [Use Carefully] In addition to other retrieve options submitted (or defaults if no other option submitted), when retreive called directly on a DKLobICM (or subclass) object's single-item retrieve methods, retrieves the resource content for both any "resource" or "document part" classified item submitted to retrieve and any document parts listed under documents submitted directly to retrieve. Also includes document parts listing and parts attributes. When used with multi-item retrieve or other single-item retrieve methods, does not retrieve any resource content, but does retreive the parts listing (TOC) for all documents (but no parts attributes). Retrieving resource content has significant performance considerations. use carefully.
  • (deprecated) DKConstant.DK_CM_CONTENT_ONLY
    [Use Carefully] Applies only when used with a retrieve method directly on a DKLobICM (or subclass) object. Ignored by all other retrieve methods. By default, every time resource content is retrieved, the meta-data is refreshed with new attrubtes (or any default if no other meta-data options specified) to refresh the system resource attributes identifying the current details of the resource content. However, if you can guarantee that the object has not changed (by any session), this option provides an optmization that skips the meta-data refresh if the system attributes have already been retrieved. For example, perhaps you previously retrieved the item through any retrieve option with DK_CM_CONTENT_ATTRONLY, this will trust the original values retrieved last time. However, you accept the reprecussions and errors if the object has in fact changed. This option is ignored by non-resource items and is ignored if meta-data has not been previously retrieved. If the system attributes are missing, the meta data will still be refreshed.
  • (deprecated) DKConstant.DK_CM_CONTENT_NO
    Use DKConstant.DK_CM_CONTENT_ATTRONLY instead, which restricts resource content retrieve processing further than DKConstant.DK_CM_CONTENT_NO. This option does perform some resource-related retrieve processing, but does not retrieve resource content. DKConstant.DK_CM_CONTENT_ATTRONLY also prohibits resource content as well as additional resource-related processing.
• Other Options:
  
  • (deprecated) DKConstant.DK_CM_CHECKOUT
    In addition to other retrieve options (or defaults if no other options), also checks out (locks) the items submitted to retrieve. Checkout only applies to root components of items and not to children or document parts. This is a faster solution to checkout many items in one optimized call if used with multi-item retrieve compared to checking out items individually. (This option is subject to automatic inclusions when using single-item retrieve depending on the retrieve method used, which can include document parts listing, parts attributes, and resource content (loaded in memory).)
  • (deprecated) DKConstant.DK_CM_VERSION_LATEST
    In addition to other retrieve options (or defaults if no other options), also updates the PID to the latest version and retrieves the latest version instead of the version indicated by the original PID. (This option is subject to automatic inclusions when using single-item retrieve depending on the retrieve method used, which can include document parts listing, parts attributes, and resource content (loaded in memory).)
  • (deprecated) DKConstant.DK_CM_CONTENT_RETRIEVE_USING_COMMITTED_READ
    [Not Recommended] In addition to other retrieve options (or defaults if no other options), use committed read for retrieving attributes and children. The default is to use uncommitted read when using DB2. This does not apply to parts listed, parts attributes, links listing, or resource content. Using this option can signfiicantly slow performance and introduce deadlocks and "-911" SQL errors. (This option is subject to automatic inclusions when using single-item retrieve depending on the retrieve method used, which can include document parts listing, parts attributes, and resource content (loaded in memory).)

• Returned through query or search ( evaluate(), execute()).
• Retrieved under other valid DDOs through previous retrieve calls.
• Created using DKDatastoreICM::createDDO(...) methods ( createDDOFromPID(DKPidICM), createDDOFromPID(pidString), createDDO(itemType,semanticType), createChildDDO(itemType,childType)).

• Returned through query (or search).
• Retrieved under other valid DDOs through previous retrieve calls.
• Created using DKDatastoreICM::createDDO(...) methods.

1. Create an instance using DKRetrieveOptionsICM.createInstance(). Examples and additional information provided in createInstance() method documentation.
2. Pass an instance using DKRetrieveOptionsICM.dkNVPair(). Examples and additional information provided in dkNVPair() method documentation.

• DKConstant.DK_CM_PARM_RETRIEVE = < DKRetrieveOptionsICM instance>
  [Recommended] Already described above.
  
  
• (deprecated) DKConstant.DK_CM_PARM_RETRIEVE = <Integer instance>
  [Deprecated and not recommended]. Use DKRetrieveOptionsICM instances instead. DKRetrieveOptionsICM offers performance advantages and enables optimizations (see " Retrieve Options (STRONGLY RECOMMENDED)" section of method DKDatastoreICM::retrieveObjects(dkCollection ddoColl,DKNVPair[] retrieveOptions) (above)). This setting accepts deprecated bitwise int option values in an Integer object. For deprecated bitwise values, see DKDatastoreICM::retrieveObjects(dkCollection,int bitwiseRetrieveOptionsInt.
  
  
• (deprecated) DKConstant.DK_CM_PARM_PROJECTION_LIST = <DKNVPair[] instance>
  [Deprecated and not recommended]. Use integrated DKProjectionListICM with DKRetrieveOptionsICM::attributeFilters(DKProjectionListICM) instead for projection list and attribute filtering capabilities. Submit as part of retrieve options instance under integrated interface. Do not submit separate projection list requests or using the deprecated DKNVPair[] form of a projection list.
  
  Deprecated DKNVPair[] Form of Projection List
  A projection list (in the deprecated form) consists of individual projections for each item type. Each item type projection is specified through a DKNVPair where the DKNVPair name is the name of the item type and the value is a dkCollection of String objects contianing the "qualified" attribute names (including child component type steps) projected for that item type. All item type projections are combined into one DKNVPair[] to be passed as the value to the retrieve options DKNVPair[].
  
  The attribute names in the projection list should be "partially qualified" (contain the component type path to the attribute starting from [but NOT including] the root component type). Use method DKAttrDefICM.getQualifiedName() on the attribute definitions to identify the qualified name.
  
  Example:
  • DKNVPair[0] = DKNVPair(ItemType Name, dkCollection of "qualified" attribute names as Strings)
  • DKNVPair[1] = DKNVPair(ItemType Name, dkCollection of "qualified" attribute names as Strings)
  • ...
  • DKNVPair[N] = DKNVPair(ItemType Name, dkCollection of "qualified" attribute names as Strings)
  
  
  • DKNVPair[0] = DKNVPair("Journal", dkCollection{"Journal_Article/Journal_Section/Title","Title","Journal_Article/Title","Journal_Article/Classification"})
  • DKNVPair[1] = DKNVPair("Book", dkCollection{"Book_Chapter/"+DK_ICM_ALL_ATTRS,"Book_Author/"+DK_ICM_SYSTEM_ATTRS,"Book_Chapter/Book_Section/SectionNum"})
  • DKNVPair[2] = DKNVPair("Converence", dkCollection{DK_ICM_ALL_ATTRS,"Conference_Note/NoteNum"})
  
  Special Keywords:
  • DKConstantICM.DK_ICM_ALL_ATTRS
    Include all attributes (both system-defined and user-defined) should be returned for the component type identified by the preceding "qualified" type information.
  • DKCosntantICM.DK_ICM_SYSTEM_ATTRS
    Only system attributes (or properties) should be returned for the component type identified by the preceding "qualified" type information.
  
  Restrictions:
  • No holes in the projection list are allowed.
  • You must specify projections in terms of the root item type, regardless of what child component is to be retrieved.
  
  Projection lists are significantly improved through the integrated DKProjectionListICM to be used with DKRetrieveOptionsICM::attributeFilters(DKProjectionListICM)

• DK_CM_CHECKIN (8192):
  check the item in after update. The default is not to check in the item.
• DK_CM_VERSION_LATEST (256):
  update the latest version rather than the specific version identified in the PID that the current DKDDO represents.
• DK_CM_VERSION_NEW (2):
  create a new version of this item. This is applicable only if the version control on the item type is set to version the item or to application controlled. If this is not the case, the item is updated and no error is returned but a new version is not created.
• DK_ICM_NO_LINKS_MEMORY_CURRENCY (32):
  This option tells the API not to update referenced DDOs, in memory, to reflect newly added links. This option is very useful when adding a large number of links. Without this option, newly added links will be made persistent and the API will reflect these links in all referenced DDOs. With this option the links are still made persistent, however referenced DDOs are not updated to include this new link information. This option may be used to improve performance when an application does not require the information in the referenced DDOs to be updated. Even though this information will not be reflected in the referenced DDOs, the application can still call retrieve on these DDOs to get the latest links information when/if it is needed.
• DK_ICM_NO_ERROR_FOR_DUP_OR_NOT_FOUND_LINKS (64): Ignore any duplicate links (or folder relationships) added for any links that already exist in the system and ignore any delete link requests for links that have already been deleted. This allows you to add as many links as you desire without the need to retrieve and compare against the current links in memory and save the item with the intent that the submitted links should exist in the system. Similarly you can remove links without the need to verify that it was not already deleted by another request. For more details, refer to the documentation provided with constant DKConstantICM.DK_ICM_NO_ERROR_FOR_DUP_OR_NOT_FOUND_LINKS.

• 0 (zero) default - Perform a regular delete, deleting the item version represented by this DDO.
• DKConstantICM.DK_ICM_DELETE_ALL_VERSIONS - Delete all versions of the item.
• DKConstant.DK_CM_DESTROY_DELETE - Irrecoverably destroy associated content while deleting it. This option is presently only supported for the ICM connector
• DKConstantICM.DK_ICM_DESTROY_ALL_VERSIONS - Irrecoverably destroy associated content for all versions while deleting it. This option is presently only supported for the ICM connector
• DK_ICM_NO_LINKS_MEMORY_CURRENCY ( 32): This option tells the API not to update referenced DDOs, in memory, to reflect newly deleted links. This option is very useful when deleting a large number of links. Without this option, newly deleted links will not be reflected these links in all referenced DDOs. even those links have been removed from the persistent datastore. This option may be used to improve performance when an application does not require the information in the referenced DDOs to be updated. Even though this information will not be reflected in the referenced DDOs, the application can still call retrieve on these DDOs to get the latest links information when/if it is needed.
• DK_ICM_NO_ERROR_FOR_DUP_OR_NOT_FOUND_LINKS (64): Ignore any duplicate links (or folder relationships) added for any links that already exist in the system and ignore any delete link requests for links that have already been deleted. This allows you to add as many links as you desire without the need to retrieve and compare against the current links in memory and save the item with the intent that the submitted links should exist in the system. Similarly you can remove links without the need to verify that it was not already deleted by another request. For more details, refer to the documentation provided with constant DKConstantICM.DK_ICM_NO_ERROR_FOR_DUP_OR_NOT_FOUND_LINKS.

• 0 (zero) default - Perform a regular delete, deleting the item version represented by this DDO.
• DKConstantICM.DK_ICM_DELETE_ALL_VERSIONS - Delete all versions of the item.
• DKConstant.DK_CM_DESTROY_DELETE - Irrecoverably destroy associated content while deleting it. This option is presently only supported for the ICM connector

• DK_CM_CHECKIN : the default is not to checkin the item.
• DK_CM_VERSION_NEW : the default is not to create a new version. This option has some limitations, it is applicable to non resource item only. If specified, the version number of the item will be incremented by one, regardless of the version control of the item type.
• DK_CM_KEEP_IN_AUTOFOLDER : the default is to remove from the current auto folder.

• The Item Type name given does not exist in this datastore.
• The Semantic Type specified is incompatible with the Item Type specified.
• Child Component Type name specified instead of a Root Item Type name.
• Other Usage Errors

• DKDDO properties, including but not limited to "semantic type" and "item type property". (See "WARNING")
• DKDDO data items for attributes (initialized with NULL or default value if exists)
• Creation of empty child collections for all sub-entity types.
• Creation of empty DKParts coll for "document" classified item types.
• Creation of empty DKFolder coll for root components specified with semantic type "Folder".

• For new items or components that have not yet been saved persistently for the first time, you typically want the DDO to be filled out with all meta-data structures and default/initial values. In this case submit TRUE.
• Extremely advanced users might prefer to set to FALSE and populate exactly what is desired in order to minimize overhead (not typical).
• To recreate DDOs for existing items or components based on a PID or PID String, you should submit FALSE. Leverage retrieve functionality to populate the DDO with the data structures you request with the actual values. Initializing with defaults can be misleading or confusing since the state of the existing DDO appears as if it has data retrieved but does not contain accurate information.
• For examples on when and why you should or should not initialize metadata structures, see section "Blank DDOs versus Initialized Metadata Structures (WARNING for C++)" in method createDDOFromPID(String pidString).

• For createDDO() and createChildDDO() methods without this parameter, this setting defaults to TRUE in C++ and FALSE in Java. Note that for recreated DDOs from PIDs, FALSE is strongly recommended.
• For createDDOFromPID() methods in either C++ or Java, this setting defaults to FALSE which is strongly recommended for recreating from a PID.

• Attributes are initialized default values and do not reflect actual values in the persisted item.
• Properties such as semantic type, ACL, and Records Enabled are not accurate until properly retrieved.

The return values are:

• 0: OK
• 1: connection is invalid
• 2: no connection exist
• 3: unknown (for connectors can't do validation)

• DKTextIndexTypeICM.DB2 if index type is DB2 NSE only.
• DKTextIndexTypeICM.ORACLE if index type is ORACLE.
• DKTextIndexTypeICM.DB2TS if index type is DB2 Text Search only. Even if you have coexistence between DB2 NSE and DB2 Text Search, you will still get DKTextIndexTypeICM.DB2TS back.

• Prefetches the object to the staging area. This option is not valid for zOS RM.
  Name = DKConstantICM.DK_ICM_STAGE_IT .
  Value = Boolean in string format , "true" or "false".
• Prefetches the object Synchronously.
  Name = DKConstantICM.DK_ICM_SYNCHRONOUS .
  Value = Boolean in string format , "true" or "false".
• Target RM the object to be prefetched to.This option is not valid for zOS RM.
  Name = DKConstantICM.DK_ICM_TARGET_RMNAME
  Value = Valid RMName in string format.

• If there is no prefetch collection associated with the itemtype.
• If there is RM associated with itemtype is not available.
• If there is prefetchcollection pamar value is null or has zero elements. Following exception is thrown. DKUsageError with errorid= DKMessageIdICM.DK_ICM_MSG_COLLECTION_HAD_NO_VALID_ELEMENTS
• If prefetchColl param value has more than one element. Following exception is thrown. DKException with errorid= DKMessageIdICM.DK_ICM_MSG_FEATURE_NOT_SUPPORTED