wt.federation
Interface Federated

All Known Implementing Classes:

ProxyDocument, ProxyDocumentMaster, ProxyGroup, ProxyPartMaster, ProxyURLData, ProxyUser

public interface Federated

Supported API: true

Extendable: false

Field Summary

static String	EXPIRATION_TIME Label for the attribute.
static String	REFRESH_TIME Label for the attribute.
static String	SERVICE_ID Label for the attribute.
static String	SOURCE_OBJECT_ID Label for the attribute.
static String	SOURCE_URL Label for the attribute.

Method Summary

QueryResult	findLinks(Class targetLinkClass, String obj1Role, Persistable obj2) Return all link objects that exist between the Federated object and the specified source object.
long	getExpirationTime() Gets the value of the attribute: EXPIRATION_TIME.
long	getRefreshTime() Gets the value of the attribute: REFRESH_TIME.
FederatedService	getService() Return the service object referenced by the serviceId attribute.
ServiceIdentifier	getServiceId() Gets the object for the association that plays role: SERVICE_ID.
String	getSourceObjectId() Gets the value of the attribute: SOURCE_OBJECT_ID.
String	getSourceURL() Gets the value of the attribute: SOURCE_URL.
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	setExpirationTime(long a_ExpirationTime) Sets the value of the attribute: EXPIRATION_TIME.
void	setRefreshTime(long a_RefreshTime) Sets the value of the attribute: REFRESH_TIME.
void	setServiceId(ServiceIdentifier a_ServiceId) Sets the object for the association that plays role: SERVICE_ID.
void	setSourceObjectId(String a_SourceObjectId) Sets the value of the attribute: SOURCE_OBJECT_ID.
void	setSourceURL(String a_SourceURL) Sets the value of the attribute: SOURCE_URL.
void	update() Update the derived attributes of the object on the source service.

Field Detail

SOURCE_OBJECT_ID

public static final String SOURCE_OBJECT_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

SOURCE_URL

public static final String SOURCE_URL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

EXPIRATION_TIME

public static final String EXPIRATION_TIME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

REFRESH_TIME

public static final String REFRESH_TIME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

SERVICE_ID

public static final String SERVICE_ID

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getSourceObjectId

public String getSourceObjectId()

Gets the value of the attribute: SOURCE_OBJECT_ID.

Supported API: false

Returns:

String

setSourceObjectId

public void setSourceObjectId(String a_SourceObjectId)
                       throws WTPropertyVetoException

Sets the value of the attribute: SOURCE_OBJECT_ID.

Supported API: false

Parameters:

a_SourceObjectId -

Throws:

WTPropertyVetoException

getSourceURL

public String getSourceURL()

Gets the value of the attribute: SOURCE_URL.

Supported API: false

Returns:

String

setSourceURL

public void setSourceURL(String a_SourceURL)
                  throws WTPropertyVetoException

Sets the value of the attribute: SOURCE_URL.

Supported API: false

Parameters:

a_SourceURL -

Throws:

WTPropertyVetoException

getExpirationTime

public long getExpirationTime()

Gets the value of the attribute: EXPIRATION_TIME.

Supported API: false

Returns:

long

setExpirationTime

public void setExpirationTime(long a_ExpirationTime)
                       throws WTPropertyVetoException

Sets the value of the attribute: EXPIRATION_TIME.

Supported API: false

Parameters:

a_ExpirationTime -

Throws:

WTPropertyVetoException

getRefreshTime

public long getRefreshTime()

Gets the value of the attribute: REFRESH_TIME.

Supported API: false

Returns:

long

setRefreshTime

public void setRefreshTime(long a_RefreshTime)
                    throws WTPropertyVetoException

Sets the value of the attribute: REFRESH_TIME.

Supported API: false

Parameters:

a_RefreshTime -

Throws:

WTPropertyVetoException

getServiceId

public ServiceIdentifier getServiceId()

Gets the object for the association that plays role: SERVICE_ID.

Supported API: true

Returns:

ServiceIdentifier

setServiceId

public void setServiceId(ServiceIdentifier a_ServiceId)
                  throws WTPropertyVetoException

Sets the object for the association that plays role: SERVICE_ID.

Supported API: true

Parameters:

a_ServiceId -

Throws:

WTPropertyVetoException

getService

public FederatedService getService()
                            throws FederationServicesException

Return the service object referenced by the serviceId attribute.

Supported API: true

Returns:

FederatedService

Throws:

FederationServicesException

preset

public 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

public void refresh()
             throws FederationServicesException

Refresh the derived attributes of the object.

Supported API: true

Throws:

FederationServicesException

refreshIfStale

public void refreshIfStale()
                    throws FederationServicesException

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

Supported API: true

Throws:

FederationServicesException

update

public void update()
            throws FederationServicesException

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

Supported API: true

Throws:

FederationServicesException

prepareForStore

public 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

public 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

public 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

public 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

public 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