ddf.catalog.federation

Interface Federatable

All Known Subinterfaces:

QueryRequest, SourceInfoRequest, Subscription

All Known Implementing Classes:

CswSubscription, FacetedQueryRequest, QueryRequestImpl, SourceInfoRequestEnterprise, SourceInfoRequestLocal, SourceInfoRequestSources, SubscriptionImpl

public interface Federatable

Interface describing an object that can be federated with other Sources

Author:

ddf.isgs@lmco.com

Method Summary

Modifier and Type	Method and Description
Set<String>	getSourceIds() Returns the source ids that are associated with the Federatable implementation.
boolean	isEnterprise() Specifies whether the Federatable implementation should be applied to the enterprise

Method Detail

getSourceIds

Set<String> getSourceIds()

Returns the source ids that are associated with the Federatable implementation. The source ids will be the complete set of sources that should be acted upon. A set is used to avoid duplicate ids.

Returns:

set of source ids that should be acted upon. Can be null or an empty list if isEnterprise() method returns true as that means all known sources should be acted upon (and the complete list might not have been known at Object creation).

isEnterprise

boolean isEnterprise()

Specifies whether the Federatable implementation should be applied to the enterprise

Returns:

true if the Federatable implementation should be applied to the entire enterprise (meaning all sources), otherwise false is returned. If false is returned then a list containing at least 1 source id should be returned by the getSourceIds() method.