Package wt.federation

Interface FederatedService

All Superinterfaces:

_FederatedService

All Known Implementing Classes:

_FederatedDirectoryService, _FederatedInfoEngineService, FederatedDirectoryService, FederatedInfoEngineService

@GeneratedProperty(name="serviceName",type=java.lang.String.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={})) @GeneratedProperty(name="serviceURL",type=java.lang.String.class) @GeneratedProperty(name="actionTable",type=java.util.Hashtable.class,columnProperties=@ColumnProperties(columnType=BLOB)) @GeneratedProperty(name="proxyRefreshInterval",type=long.class) @GeneratedProperty(name="proxyExpirationInterval",type=long.class) @GeneratedProperty(name="tightlyCoupled",type=boolean.class)
public interface FederatedService
extends _FederatedService

Defines the essential interface for all classes implementing Federated services that provide access to non-local objects.

Supported API: true

Extendable: false

Field Summary

Fields inherited from interface wt.federation._FederatedService

SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
Object	createObject(Class objectClass, String sourceObjectId, Hashtable attributes)	Create a new object in a remote information service.
void	deleteObject(String sourceObjectId)	Delete the specified object managed by this federated service.
QueryResult	findObjects(Class targetLinkClass, Persistable obj1, String obj1Role, Persistable obj2)	Return all link objects in this service that exist between two specified source objects.
QueryResult	findObjects(QuerySpec criteria)	Retrieve objects from this federated service using the specified selection criteria.
String	getActionURL(String actionName, Hashtable arguments)	Returns the URL associated with the specified action and set of named arguments.
Enumeration	getSupportedLinkClasses()	Return the enumeration of link class names for which this service supports navigation.
Enumeration	getSupportedObjectClasses()	Return the enumeration of class names for which this service supports queries.
boolean	isNavigationSupported(Class linkClass)	Return true if the named class is defined in the table of supported link classes for this federated service.
boolean	isQuerySupported(Class objectClass)	Return true if the named class is defined in the table of supported object classes for this federated service.
QueryResult	navigate(Persistable obj, String role, Class linkClass, boolean onlyOtherSide)	Return objects from this federated service related to the specified source object given a role and link class.
QueryResult	navigate(Persistable obj, String role, QuerySpec criteria, boolean onlyOtherSide)	Return objects from this federated service related to the specified source object given a role and link selection crtieria.
void	purgeCaches()	Purge any caches that might be kept by the service.
void	refreshObject(Federated proxy)	Refresh the properties of a proxy object that are derived from a remote object.
Hashtable	retrieveAttributes(String sourceObjectId)	Supported API: true
Object	retrieveObject(String sourceObjectId)	Returns a Federated instance of the remote object identified by the specified source object identifier.
void	updateObject(String sourceObjectId, Hashtable updateAttributes, Vector deleteAttributes)	Update the attributes of a specified remote object.

Methods inherited from interface wt.federation._FederatedService

getServiceName, setServiceName

Method Details

getActionURL

String getActionURL(String actionName,
 Hashtable arguments)
             throws FederationServicesException

Returns the URL associated with the specified action and set of named arguments.

Supported API: true

Parameters:

actionName -

arguments -

Returns:

String

Throws:

FederationServicesException

retrieveObject

Object retrieveObject(String sourceObjectId)
               throws FederationServicesException

Returns a Federated instance of the remote object identified by the specified source object identifier.

Supported API: true

Parameters:

sourceObjectId -

Returns:

Object

Throws:

FederationServicesException

retrieveAttributes

Hashtable retrieveAttributes(String sourceObjectId)
                      throws FederationServicesException

Supported API: true

Parameters:

sourceObjectId -

Returns:

Hashtable

Throws:

FederationServicesException

refreshObject

void refreshObject(Federated proxy)
            throws FederationServicesException

Refresh the properties of a proxy object that are derived from a remote object.

Supported API: true

Parameters:

proxy -

Throws:

FederationServicesException

createObject

Object createObject(Class objectClass,
 String sourceObjectId,
 Hashtable attributes)
             throws FederationServicesException

Create a new object in a remote information service.

Supported API: true

Parameters:

objectClass -

sourceObjectId -

attributes -

Returns:

Object

Throws:

FederationServicesException

updateObject

void updateObject(String sourceObjectId,
 Hashtable updateAttributes,
 Vector deleteAttributes)
           throws FederationServicesException

Update the attributes of a specified remote object.

Supported API: true

Parameters:

sourceObjectId -

updateAttributes -

deleteAttributes -

Throws:

FederationServicesException

deleteObject

void deleteObject(String sourceObjectId)
           throws FederationServicesException

Delete the specified object managed by this federated service.

Supported API: true

Parameters:

sourceObjectId -

Throws:

FederationServicesException

findObjects

QueryResult findObjects(QuerySpec criteria)
                 throws FederationServicesException

Retrieve objects from this federated service using the specified selection criteria.

Supported API: true

Parameters:

criteria -

Returns:

QueryResult

Throws:

FederationServicesException

findObjects

QueryResult findObjects(Class targetLinkClass,
 Persistable obj1,
 String obj1Role,
 Persistable obj2)
                 throws FederationServicesException

Return all link objects in this service that exist between two specified source objects.

Supported API: true

Parameters:

targetLinkClass -

obj1 -

obj1Role -

obj2 -

Returns:

QueryResult

Throws:

FederationServicesException

navigate

QueryResult navigate(Persistable obj,
 String role,
 Class linkClass,
 boolean onlyOtherSide)
              throws FederationServicesException

Return objects from this federated service related to the specified source object given a role and link class. Return only the related objects themselves if specified. Otherwise, return both the related objects as well as the link objects that associate them with the source object.

Supported API: true

Parameters:

obj -

role -

linkClass -

onlyOtherSide -

Returns:

QueryResult

Throws:

FederationServicesException

navigate

QueryResult navigate(Persistable obj,
 String role,
 QuerySpec criteria,
 boolean onlyOtherSide)
              throws FederationServicesException

Return objects from this federated service related to the specified source object given a role and link selection crtieria. Return only the related objects themselves if specified. Otherwise, return both the related objects as well as the link objects that associate them with the source object.

Supported API: true

Parameters:

obj -

role -

criteria -

onlyOtherSide -

Returns:

QueryResult

Throws:

FederationServicesException

getSupportedObjectClasses

Enumeration getSupportedObjectClasses()
                               throws FederationServicesException

Return the enumeration of class names for which this service supports queries.

Supported API: true

Returns:

Enumeration

Throws:

FederationServicesException

getSupportedLinkClasses

Enumeration getSupportedLinkClasses()
                             throws FederationServicesException

Return the enumeration of link class names for which this service supports navigation.

Supported API: true

Returns:

Enumeration

Throws:

FederationServicesException

isQuerySupported

boolean isQuerySupported(Class objectClass)
                  throws FederationServicesException

Return true if the named class is defined in the table of supported object classes for this federated service.

Supported API: true

Parameters:

objectClass -

Returns:

boolean

Throws:

FederationServicesException

isNavigationSupported

boolean isNavigationSupported(Class linkClass)
                       throws FederationServicesException

Return true if the named class is defined in the table of supported link classes for this federated service.

Supported API: true

Parameters:

linkClass -

Returns:

boolean

Throws:

FederationServicesException

purgeCaches

void purgeCaches()
          throws FederationServicesException

Purge any caches that might be kept by the service.

Supported API: true

Throws:

FederationServicesException