Package wt.federation

Interface Federated

All Superinterfaces:

_Federated

All Known Implementing Classes:

_ProxyDocument, _ProxyDocumentMaster, _ProxyGroup, _ProxyPartMaster, _ProxyURLData, _ProxyUser, ProxyDocument, ProxyDocumentMaster, ProxyGroup, ProxyPartMaster, ProxyURLData, ProxyUser

@GeneratedProperty(name="sourceObjectId",type=java.lang.String.class,constraints=@PropertyConstraints(upperLimit=1000)) @GeneratedProperty(name="sourceURL",type=java.lang.String.class,constraints=@PropertyConstraints(upperLimit=1000)) @GeneratedProperty(name="expirationTime",type=long.class) @GeneratedProperty(name="refreshTime",type=long.class) @GeneratedProperty(name="serviceId",type=ServiceIdentifier.class,supportedAPI=PUBLIC,constraints=@PropertyConstraints(required=true))
public interface Federated
extends _Federated

Supported API: true

Extendable: false

Field Summary

Fields inherited from interface wt.federation._Federated

EXPIRATION_TIME, REFRESH_TIME, SERVICE_ID, SOURCE_OBJECT_ID, SOURCE_URL

Method Summary

Modifier and Type	Method	Description
QueryResult	findLinks(Class targetLinkClass, String obj1Role, Persistable obj2)	Return all link objects that exist between the Federated object and the specified source object.
FederatedService	getService()	Return the service object referenced by the serviceId attribute.
QueryResult	navigate(String role, Class linkClass, boolean onlyOtherSide)	Return objects related to this federated source object given a role and link class.
QueryResult	navigate(String role, QuerySpec criteria, boolean onlyOtherSide)	Return objects related to this federated source object given a role and link selection crtieria.
void	postStore()	The persistence manager calls this method just after storing the proxy object in the database.
void	prepareForStore()	The persistence manager calls this method just before storing the proxy object in the database.
void	preset()	This method is called when a proxy object is first created by a service, just after the object is instantiated and its readExternal method has been called to populate its properties from attributes obtained from the remote information source.
void	refresh()	Refresh the derived attributes of the object.
void	refreshIfStale()	Refresh the derived attributes of the object, but only if the properties are stale.
void	update()	Update the derived attributes of the object on the source service.

Methods inherited from interface wt.federation._Federated

getExpirationTime, getRefreshTime, getServiceId, getSourceObjectId, getSourceURL, setExpirationTime, setRefreshTime, setServiceId, setSourceObjectId, setSourceURL

Method Details

getService

FederatedService getService()
                     throws FederationServicesException

Return the service object referenced by the serviceId attribute.

Supported API: true

Returns:

FederatedService

Throws:

FederationServicesException

preset

void preset()
     throws FederationServicesException

This method is called when a proxy object is first created by a service, just after the object is instantiated and its readExternal method has been called to populate its properties from attributes obtained from the remote information source. This method allows the proxy object to do further class-specific initialization.

Supported API: true

Throws:

FederationServicesException

refresh

void refresh()
      throws FederationServicesException

Refresh the derived attributes of the object.

Supported API: true

Throws:

FederationServicesException

refreshIfStale

void refreshIfStale()
             throws FederationServicesException

Refresh the derived attributes of the object, but only if the properties are stale.

Supported API: true

Throws:

FederationServicesException

update

void update()
     throws FederationServicesException

Update the derived attributes of the object on the source service.

Supported API: true

Throws:

FederationServicesException

prepareForStore

void prepareForStore()
              throws FederationServicesException

The persistence manager calls this method just before storing the proxy object in the database. This gives the object an opportunity to make associated proxy objects persistent, if necessary.

Supported API: true

Throws:

FederationServicesException

findLinks

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

Return all link objects that exist between the Federated object and the specified source object.

Supported API: true

Parameters:

targetLinkClass -

obj1Role -

obj2 -

Returns:

QueryResult

Throws:

FederationServicesException

navigate

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

Return objects related to this federated 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:

role -

linkClass -

onlyOtherSide -

Returns:

QueryResult

Throws:

FederationServicesException

navigate

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

Return objects related to this federated 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:

role -

criteria -

onlyOtherSide -

Returns:

QueryResult

Throws:

FederationServicesException

postStore

void postStore()
        throws FederationServicesException

The persistence manager calls this method just after storing the proxy object in the database. This gives the object an opportunity to make associated objects persistent, if necessary. For example, links between the proxy object and other objects need to be persisted after the proxy object is persisted.

Supported API: true

Throws:

FederationServicesException