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
Supported API: true
Extendable: false
-
Field Summary
Fields inherited from interface wt.federation._FederatedService
SERVICE_NAME -
Method Summary
Modifier and TypeMethodDescriptioncreateObject(Class objectClass, String sourceObjectId, Hashtable attributes) Create a new object in a remote information service.voiddeleteObject(String sourceObjectId) Delete the specified object managed by this federated service.findObjects(Class targetLinkClass, Persistable obj1, String obj1Role, Persistable obj2) Return all link objects in this service that exist between two specified source objects.findObjects(QuerySpec criteria) Retrieve objects from this federated service using the specified selection criteria.getActionURL(String actionName, Hashtable arguments) Returns the URL associated with the specified action and set of named arguments.Return the enumeration of link class names for which this service supports navigation.Return the enumeration of class names for which this service supports queries.booleanisNavigationSupported(Class linkClass) Return true if the named class is defined in the table of supported link classes for this federated service.booleanisQuerySupported(Class objectClass) Return true if the named class is defined in the table of supported object classes for this federated service.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.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.voidPurge any caches that might be kept by the service.voidrefreshObject(Federated proxy) Refresh the properties of a proxy object that are derived from a remote object.retrieveAttributes(String sourceObjectId)
Supported API: trueretrieveObject(String sourceObjectId) Returns a Federated instance of the remote object identified by the specified source object identifier.voidupdateObject(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
Returns the URL associated with the specified action and set of named arguments.
Supported API: true- Parameters:
actionName-arguments-- Returns:
- String
- Throws:
FederationServicesException
-
retrieveObject
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
Supported API: true- Parameters:
sourceObjectId-- Returns:
- Hashtable
- Throws:
FederationServicesException
-
refreshObject
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
Delete the specified object managed by this federated service.
Supported API: true- Parameters:
sourceObjectId-- Throws:
FederationServicesException
-
findObjects
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
-
getSupportedObjectClasses
Return the enumeration of class names for which this service supports queries.
Supported API: true- Returns:
- Enumeration
- Throws:
FederationServicesException
-
getSupportedLinkClasses
Return the enumeration of link class names for which this service supports navigation.
Supported API: true- Returns:
- Enumeration
- Throws:
FederationServicesException
-
isQuerySupported
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
-
purgeCaches
Purge any caches that might be kept by the service.
Supported API: true- Throws:
FederationServicesException
-