Purpose:
This class represents a datastore for federated.
Methods:
connect(LPCTSTR datastoreName, LPCTSTR userName, LPCTSTR authentication [, VARIANT connectString]);
disconnect()
setOption(long option, VARIANT value);
getOption(long option, VARIANT* value);
BSTR datastoreName();
BSTR datastoreType();
BSTR userName();
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.
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.
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.
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.
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(LPDISPATCH ddobase);
Adds the data object to the datastore. The input parameter LPDISPATCH pointer contains a DXDDOFed object.
deleteObject(LPDISPATCH ddobase);
Deletes the data object from the datastore. The input parameter LPDISPATCH pointer contains a DXDDOFed object.
retrieveObject(LPDISPATCH ddobase);
Retrieves the data object from the datastore. The input parameter LPDISPATCH pointer contains a DXDDOFed object.
updateObject(LPDISPATCH ddobase);
Updates the datastore with this data object. The input parameter LPDISPATCH pointer contains a DXDDOFed object.
commit();
rollback();
BOOL isConnected();
public DKHandle connection() throws Exception;
LPDISPATCH listDataSources();
Gets a list of servers. The returned LPDISPATCH pointer contains a DXSequentialCollectionFed object.
VARIANT listDataSourceNames(long* arraySize);
Gets a list of server names. The output parameter arraySize is the size of the array.
LPDISPATCH listEntities();
Gets a list of entities. The returned LPDISPATCH pointer contains a DXSequentialCollectionFed object.
VARIANT listEntityNames(long* arraySize);
Gets a list of entity names.
LPDISPATCH listEntityAttrs(LPCTSTR entityName);
Gets a list of entity attributes. The returned LPDISPATCH pointer contains a DXSequentialCollectionFed object.
VARIANT listEntityAttrNames(LPCTSTR entityName, long* arraySize);
Gets a list of entity attribute names.
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.