Index

DXDatastoreOD

Purpose:

This is the class that is used to represent a datastore for OnDemand.

Methods:

connect
   connect(LPCTSTR datastoreName, LPCTSTR userName,
 
           LPCTSTR authentication, VARIANT connectString);

Connects to a datastore.

Parameters:

datastoreName
The name of this datastore.

userName
The user name being used to connect to the content server.

authentication
The authentication or password being used to connect.

connectString
This is a string value, which supplies all of the specific connection parameters to establish and maintain connection to the content server. Valid parameters include:

ODPORT=value
This is the port number of the OnDemand server. If the port number is not 0, this is a required parameter.

CACHEDIR=value
A fully qualified directory used by the connector to store intermediary work files.

NPWD=value
This is the new password to be used to change the user's password at connect time. This value must have a length of eight characters or less.

ODCONNECT=value
This is the protocol to be used with the OnDemand server. The default value is T. Valid choices for value are:
T -- TCP/IP
S -- IPX/SPX
L -- Local file system server

ODLOCAL=value
This is a fully qualified directory for the local file system server. This parameter overrides the current ODCONNECT parameter value if it is specified and forces the protocol to be 'L'.

createQuery
   LPDISPATCH createQuery(LPCTSTR command,
 
                          short commandLangType
 
                          [,VARIANT paramList]);

Creates a query object using a command. The parameter list is in the form of an array of DXNVPairOD objects. The returned LPDISPATCH pointer contains a DXParametricQueryOD object.

datastoreDef
   LPDISPATCH datastoreDef();

Gets the datastore def. The returned LPDISPATCH pointer contains a DXDatastoreDefOD object.

datastoreName
   BSTR datastoreName();

Gets the datastore name.

datastoreType
   BSTR datastoreType();

Gets the datastore type.

disconnect
   disconnect()

Disconnects from the datastore.

evaluate
   VARIANT evaluate(LPCTSTR command,
 
                    short commandLangType
 
                    [,VARIANT paramList]);

Evaluate a query using a command. The parameter list is in the form of an array of DXNVPairOD objects. The value of the returned VARIANT is a DXResultsOD object.

evaluateQuery
   VARIANT evaluateQuery(LPDISPATCH query);

Evaluate a query using a query object. The value of the returned VARIANT is a DXResultsOD object. The input parameter LPDISPATCH pointer contains a DXParametricQueryOD object.

execute
   LPDISPATCH execute(LPCTSTR command,
 
                      short commandLangType
 
                      [,VARIANT paramList]);

Execute a query using a command. The parameter list is in the form of an array of DXNVPairOD objects. The returned LPDISPATCH pointer contains a DXResultSetCursorOD object.

executeQuery
   LPDISPATCH executeQuery(LPDISPATCH query);

Execute a query using a query object. The input parameter LPDISPATCH pointer contains a DXParametricQueryOD object. The returned LPDISPATCH pointer contains a DXResultSetCursorOD object.

getOption
   getOption(long option, VARIANT* value);

Gets the value for the specified datastore option. Valid options for OnDemand are:

DX_OD_OPT_ACCESS_MODE
This option controls the updateability of the datastore. The default is DX_OD_READONLY

DX_OD_OPT_CONTENT
This option controls the amount of information returned in the DXDDOOD objects. The default is DX_OD_CONTENT_YES

DX_OD_OPT_INCLUDE_PENDING_DOCS
This option controls whether or not documents which are in pending state (the document contains no content) are included when searching for documents or listing the contents or folders. The default is DX_OD_PENDING_NO

initConfiguration
   initConfiguration(LPCTSTR configuration);

Initializes the datastore with the specified configuration string. The configuration string supplies the specific initialization parameters. Valid parameters include:

CC2MIMEURL=value
The URL for the file containing the content class to MIME type mapping.

The name of the file containing the content class to MIME type mapping. This parameter is ignored if the CC2MIMEURL is specified.

DSNAME=value
The name of this datastore.

isConnected
   BOOL isConnected();

Returns true if datastore is connected.

listDataSourceNames
   VARIANT listDataSourceNames(long* arraySize);

Gets a list of server names. The output parameter arraySize is the size of the array. For OnDemand, this will always be an empty list.

listDataSources
   LPDISPATCH listDataSources();

Gets a list of servers. The returned LPDISPATCH pointer contains a DXSequentialCollectionOD object.

listEntities
   LPDISPATCH listEntities();

Gets a list of entities. The returned LPDISPATCH pointer contains a DXSequentialCollectionOD object.

listEntityAttrNames
   VARIANT listEntityAttrNames(LPCTSTR entityName, long* arraySize);

Gets a list of entity attribute names. The output parameter arraySize is the size of the array.

listEntityAttrs
   LPDISPATCH listEntityAttrs(LPCTSTR entityName);

Gets a list of entity attributes. The returned LPDISPATCH pointer contains a DXSequentialCollectionOD object.

listEntityNames
   VARIANT listEntityNames(long* arraySize);

Gets a list of entity names. The output parameter arraySize is the size of the array.

retrieveObject
   retrieveObject(LPDISPATCH ddobase);

Retrieve the data object from the persistent datastore into memory. The input parameter LPDISPATCH pointer contains a DXDDOOD object.

setOption
   setOption(long option, VARIANT value);

Sets the value for the specified option. See getOption for the list of options for Image Plus for OS/390.

userName
   BSTR userName();

Returns the user name that was used to connect to the datastore.

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