com.atlassian.gadgets.directory.spi
Interface SubscribedGadgetFeedStore

All Known Implementing Classes:

SubscribedGadgetFeedStoreImpl

public interface SubscribedGadgetFeedStore

Provides persistent storage of the base URIs of external applications whose gadgets appear in the directory.

Method Summary

SubscribedGadgetFeed	addFeed(URI feedUri) Add the gadget feed to those that are subscribed to.
boolean	containsFeed(String feedId) Returns true if a feed with the given ID has been subscribed to, false otherwise.
Iterable<SubscribedGadgetFeed>	getAllFeeds() Returns the feeds that have been subscribed to
SubscribedGadgetFeed	getFeed(String feedId) Returns the feed with the given ID, if it exists.
void	removeFeed(String feedId) Remove the subscribed feed

Method Detail

addFeed

SubscribedGadgetFeed addFeed(URI feedUri)

Add the gadget feed to those that are subscribed to.

Parameters:

feedUri - the gadget spec URI to store. Must not be null.

Returns:

the persisted Subscribed Gadget Feed as represented by the application.

containsFeed

boolean containsFeed(String feedId)

Returns true if a feed with the given ID has been subscribed to, false otherwise.

Parameters:

feedId - ID of the feed to check for existence

Returns:

true if the feed with the given id has been subscribed to.

getFeed

SubscribedGadgetFeed getFeed(String feedId)

Returns the feed with the given ID, if it exists. null otherwise.

Parameters:

feedId - ID of the feed to retrieve

Returns:

feed with the given ID, if it exists, null otherwise

getAllFeeds

Iterable<SubscribedGadgetFeed> getAllFeeds()

Returns the feeds that have been subscribed to

Returns:

feeds that have been subscribed to

removeFeed

void removeFeed(String feedId)

Remove the subscribed feed

Parameters:

feedId - ID of the feed to remove