Index

DXDatastoreFed

Purpose:

This class represents a datastore for federated.

Methods:

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

Connects to a datastore.

disconnect
  disconnect()

Disconnects from a datastore.

setOption
  setOption(long option, VARIANT value);

Sets a datastore option.

getOption
  getOption(long option, VARIANT* value);

Gets a datastore option.

datastoreName
  BSTR datastoreName();

Gets the datastore name.

datastoreType
  BSTR datastoreType();

Gets the datastore type.

userName
  BSTR userName();

Gets the user name.

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

Executes a query using a command. The parameter list is in the form of an array of DXNVPairFed objects. The returned LPDISPATCH pointer contains a DXResultSetCursorFed object.

executeQuery
  LPDISPATCH executeQuery(LPDISPATCH query);

Execute a query using a query object. The input parameter LPDISPATCH pointer contains a DXFederatedQueryFed object. The returned LPDISPATCH pointer contains a DXResultSetCursorFed object.

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 DXNVPairFed objects. The value of the returned VARIANT is a DXResultsFed object.

evaluateQuery
  VARIANT evaluateQuery(LPDISPATCH query);

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

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 DXNVPairFed objects. The returned LPDISPATCH pointer contains a DXFederatedQueryFed object.

addObject
  addObject(LPDISPATCH ddobase);

Adds the data object to the datastore. The input parameter LPDISPATCH pointer contains a DXDDOFed object.

deleteObject
  deleteObject(LPDISPATCH ddobase);

Deletes the data object from the datastore. The input parameter LPDISPATCH pointer contains a DXDDOFed object.

retrieveObject
  retrieveObject(LPDISPATCH ddobase);

Retrieves the data object from the datastore. The input parameter LPDISPATCH pointer contains a DXDDOFed object.

updateObject
  updateObject(LPDISPATCH ddobase);

Updates the datastore with this data object. The input parameter LPDISPATCH pointer contains a DXDDOFed object.

commit
  commit();

Commits the current transaction.

rollback
  rollback();

Rollbacks the current transaction.

isConnected
  BOOL isConnected();

Returns TRUE if datastore is connected.

connection
  public DKHandle connection() throws Exception;

Returns the connection handle of this datastore.

listDataSources
  LPDISPATCH listDataSources();

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

listDataSourceNames
  VARIANT listDataSourceNames(long* arraySize);

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

listEntities
  LPDISPATCH listEntities();

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

listEntityNames
  VARIANT listEntityNames(long* arraySize);

Gets a list of entity names.

Parameters
arraySize -- The size of the array.

listEntityAttrs
  LPDISPATCH listEntityAttrs(LPCTSTR entityName);

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

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

Gets a list of entity attribute names.

Parameters
arraySize -- The size of the array.

datastoreDef
  LPDISPATCH datastoreDef();

Gets the datastore definition. The returned LPDISPATCH pointer contains a DXDatastoreDefFed object.

Federated query string

The syntax of federated query string is similar to Content Manager parametric query string:

Federated Query Syntax:

        PARAMETRIC_SEARCH=([ENTITY=entity_name,]
                          [MAX_RESULTS=maximum_results,]
                          [COND=(conditional_expression)]
                          [; ...]
                         );
               [OPTION=([CONTENT=yes_no]
                            )]
  
      [and
  
       TEXT_SEARCH=(COND=(text_search_expression)
                    );
           [OPTION=([SEARCH_INDEX={search_index_name | (index_list) };]
                         [MAX_RESULTS=maximum_results;]
                         [TIME_LIMIT=time_limit]
                        )]
      ]
  
      [and
  
       IMAGE_SEARCH=(COND=(image_search_expression)
                    );
           [OPTION=([SEARCH_INDEX={search_index_name | (index_list) };]
                         [MAX_RESULTS=maximum_results;]
                         [TIME_LIMIT=time_limit]
                        )]
  
      ]

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