wt.federation
Interface FederationService

All Known Implementing Classes:

StandardFederationService

public interface FederationService

FederationService provides client invokable methods to federation services. These methods are executed on the server side.

Supported API: true

Extendable: false

Method Summary

QueryResult	findObjects(QuerySpec qs) Sends a query to all federated services, and returns the merged set of results.
QueryResult	findObjects(QuerySpec qs, String serviceName) Sends a query to the specified federated service, and returns the results.
QueryResult	findObjects(QuerySpec qs, String[] serviceNames) Sends a query to each of the specified federated services, and returns the merged set of results.
QueryResult	findObjects(QuerySpec qs, String[] serviceNames, boolean searchLocalDB) Sends a query to each of the specified federated services, and returns the merged set of results.
String[]	getAllServices() Returns an array of the names of all known federated services.
String[]	getNavigableServices(String linkClassName) Returns an array of the names of federated services that support navigating a specified link class.
Persistable	getPersistentInstance(Federated proxy) Returns a persisted instance of the specified proxy object or null if the proxy has no persisted instance.
String[]	getQueryableServices(String className) Returns an array of the names of federated services that support querying a specified class.
Vector	retrieveInfoEngineObjects(String url) Sends a request to Info*Engine to retrieve objects associated with the specified URL.
Federated	storeProxy(Federated proxy) Stores a proxy object in the persistent data service.
void	syncObjects(Externalizable source, Externalizable target) Copies the properties of a specified source object to a target object.

Method Detail

findObjects

QueryResult findObjects(QuerySpec qs)
                        throws wt.federation.FederationServicesException,
                               WTException

Sends a query to all federated services, and returns the merged set of results.

Supported API: true

Parameters:

qs - the search criteria to use for the query.

Returns:

QueryResult

Throws:

wt.federation.FederationServicesException

WTException

findObjects

QueryResult findObjects(QuerySpec qs,
                        String serviceName)
                        throws wt.federation.FederationServicesException,
                               WTException

Sends a query to the specified federated service, and returns the results.

Supported API: true

Parameters:

qs - the search criteria to use for the query.

serviceName - the name of the federated service to be queried.

Returns:

QueryResult

Throws:

wt.federation.FederationServicesException

WTException

findObjects

QueryResult findObjects(QuerySpec qs,
                        String[] serviceNames)
                        throws wt.federation.FederationServicesException,
                               WTException

Sends a query to each of the specified federated services, and returns the merged set of results.

Supported API: true

Parameters:

qs - the search criteria to use for the query.

serviceNames - the names of the federated services to be queried.

Returns:

QueryResult

Throws:

wt.federation.FederationServicesException

WTException

findObjects

QueryResult findObjects(QuerySpec qs,
                        String[] serviceNames,
                        boolean searchLocalDB)
                        throws wt.federation.FederationServicesException,
                               WTException

Sends a query to each of the specified federated services, and returns the merged set of results. If searchLocalDB is true, also queries the local system and includes any locally defined entries in the search results.

Supported API: true

Parameters:

qs - the search criteria to use for the query.

serviceNames - the names of the federated services to be queried.

searchLocalDB - set to true if the local system should be queried.

Returns:

QueryResult

Throws:

wt.federation.FederationServicesException

WTException

getAllServices

String[] getAllServices()
                        throws wt.federation.FederationServicesException,
                               WTException

Returns an array of the names of all known federated services.

Supported API: true

Returns:

String []

Throws:

wt.federation.FederationServicesException

WTException

getNavigableServices

String[] getNavigableServices(String linkClassName)
                              throws wt.federation.FederationServicesException,
                                     WTException

Returns an array of the names of federated services that support navigating a specified link class.

Supported API: true

Parameters:

linkClassName - the name of the class for which navigation is desired.

Returns:

String []

Throws:

wt.federation.FederationServicesException

WTException

getPersistentInstance

Persistable getPersistentInstance(Federated proxy)
                                  throws wt.federation.FederationServicesException,
                                         WTException

Returns a persisted instance of the specified proxy object or null if the proxy has no persisted instance.

Supported API: true

Parameters:

proxy - the proxy object.

Returns:

Persistable

Throws:

wt.federation.FederationServicesException

WTException

getQueryableServices

String[] getQueryableServices(String className)
                              throws wt.federation.FederationServicesException,
                                     WTException

Returns an array of the names of federated services that support querying a specified class.

Supported API: true

Parameters:

className - the name of the class for which querying is desired.

Returns:

String []

Throws:

wt.federation.FederationServicesException

WTException

retrieveInfoEngineObjects

Vector retrieveInfoEngineObjects(String url)
                                 throws wt.federation.FederationServicesException,
                                        WTException

Sends a request to Info*Engine to retrieve objects associated with the specified URL.

Supported API: true

Parameters:

url - the URL identifying the objects to be retrieved.

Returns:

Vector

Throws:

wt.federation.FederationServicesException

WTException

storeProxy

Federated storeProxy(Federated proxy)
                     throws wt.federation.FederationServicesException,
                            WTException

Stores a proxy object in the persistent data service.

Supported API: true

Parameters:

proxy - the object to be persisted.

Returns:

Federated

Throws:

wt.federation.FederationServicesException

WTException

syncObjects

void syncObjects(Externalizable source,
                 Externalizable target)
                 throws wt.federation.FederationServicesException,
                        WTException

Copies the properties of a specified source object to a target object.

Supported API: true

Parameters:

source - the source object.

target - the target object.

Throws:

wt.federation.FederationServicesException

WTException