dekoh.portal.syndication.aggregator.core
Interface SubscriptionList

All Known Implementing Classes:

InMemorySubscriptionList, PersistentSubscriptionList, PersistentSubscriptionListWrapper, SubscriptionListWrapper, XmlBasedPersistentSubscriptionList

public interface SubscriptionList

Represents a Collection of SubscriptionItem. All SubscriptionItems in SubscriptionList will be aggregated togather by Aggregator

Since:

Oct 9, 2007

Method Summary

SubscriptionItem	add(SubscriptionItem subscriptionItem)
void	add(URI feedUri)
void	addAll(List subscriptionItems)
boolean	addListener(SubscriptionListListener subscriptionListListener)
String	getAuthor()
String	getDescripton()
String	getProperty(String name)
Set	getSubscribedItems() Gets the list Feed items from this subscription list
String	getTitle() Gets the current subscription list title
long	lastModifiedTime() Gets the last updated time for subscription list
boolean	remove(SubscriptionItem subscriptionItem)
boolean	remove(URI feedURI) Removes the given feed from the subscription List
void	removeAll(List subscriptionItems)
boolean	removeListener(SubscriptionListListener subscriptionListListener)
void	setAuthor(String author)
void	setDescripton(String description)
void	setProperty(String name, String value)
void	setTitle(String title)

Method Detail

getTitle

String getTitle()

Gets the current subscription list title

Returns:

subscription title

getDescripton

String getDescripton()

getAuthor

String getAuthor()

setTitle

void setTitle(String title)

setDescripton

void setDescripton(String description)

setAuthor

void setAuthor(String author)

setProperty

void setProperty(String name,
                 String value)

getProperty

String getProperty(String name)

add

void add(URI feedUri)
         throws MalformedURLException

Throws:

MalformedURLException

add

SubscriptionItem add(SubscriptionItem subscriptionItem)

addAll

void addAll(List subscriptionItems)

remove

boolean remove(URI feedURI)

Removes the given feed from the subscription List

remove

boolean remove(SubscriptionItem subscriptionItem)

removeAll

void removeAll(List subscriptionItems)

getSubscribedItems

Set getSubscribedItems()

Gets the list Feed items from this subscription list

Returns:

List of subscription items

lastModifiedTime

long lastModifiedTime()

Gets the last updated time for subscription list

Returns:

last updated time

addListener

boolean addListener(SubscriptionListListener subscriptionListListener)

Parameters:

subscriptionListListener - to be added cannot be null

Returns:

true of add was successful

Throws:

NullPointerException - if subscriptionListListener passed is null

removeListener

boolean removeListener(SubscriptionListListener subscriptionListListener)