org.jasig.portlet.announcements.service

Interface IAnnouncementService

All Known Implementing Classes:

HibernateAnnouncementService

public interface IAnnouncementService

IAnnouncementService interface.

Version:

$Id: $Id

Author:

Erik A. Olsson (eolsson@uci.edu)

$LastChangedBy$ $LastChangedDate$

Method Summary

Modifier and Type	Method and Description
void	addOrSaveAnnouncement(Announcement ann) addOrSaveAnnouncement.
void	addOrSaveTopic(Topic topic) addOrSaveTopic.
void	addOrSaveTopicSubscription(List<TopicSubscription> subs) addOrSaveTopicSubscription.
void	deleteAnnouncement(Announcement ann) deleteAnnouncement.
void	deleteAnnouncementsPastCurrentTime() deleteAnnouncementsPastCurrentTime.
void	deleteAnnouncementsPastExpirationThreshold(int numDays) deleteAnnouncementsPastExpirationThreshold.
void	deleteTopic(Topic topic) deleteTopic.
void	deleteTopicSubscription(TopicSubscription sub) deleteTopicSubscription.
List<Topic>	getAllTopics() getAllTopics.
Announcement	getAnnouncement(Long id) getAnnouncement.
Topic	getEmergencyTopic() getEmergencyTopic.
Topic	getTopic(Long id) getTopic.
List<TopicSubscription>	getTopicSubscriptionFor(javax.portlet.PortletRequest request) getTopicSubscriptionFor.
void	mergeAnnouncement(Announcement ann) mergeAnnouncement.
void	mergeTopic(Topic topic) mergeTopic.
void	persistTopic(Topic topic) persistTopic.
void	persistTopicSubscription(List<TopicSubscription> subs) persistTopicSubscription.

Method Detail

getAllTopics

List<Topic> getAllTopics()

getAllTopics.

Returns:

a List object.

getEmergencyTopic

Topic getEmergencyTopic()

getEmergencyTopic.

Returns:

a Topic object.

addOrSaveTopic

void addOrSaveTopic(Topic topic)

addOrSaveTopic.

Parameters:

topic - a Topic object.

persistTopic

void persistTopic(Topic topic)

persistTopic.

Parameters:

topic - a Topic object.

mergeTopic

void mergeTopic(Topic topic)

mergeTopic.

Parameters:

topic - a Topic object.

addOrSaveAnnouncement

void addOrSaveAnnouncement(Announcement ann)

addOrSaveAnnouncement.

Parameters:

ann - a Announcement object.

mergeAnnouncement

void mergeAnnouncement(Announcement ann)

mergeAnnouncement.

Parameters:

ann - a Announcement object.

getTopic

Topic getTopic(Long id)
        throws javax.portlet.PortletException

getTopic.

Parameters:

id - a Long object.

Returns:

a Topic object.

Throws:

javax.portlet.PortletException - if any.

getAnnouncement

Announcement getAnnouncement(Long id)
                      throws javax.portlet.PortletException

getAnnouncement.

Parameters:

id - a Long object.

Returns:

a Announcement object.

Throws:

javax.portlet.PortletException - if any.

deleteAnnouncementsPastCurrentTime

void deleteAnnouncementsPastCurrentTime()

deleteAnnouncementsPastCurrentTime.

deleteAnnouncementsPastExpirationThreshold

void deleteAnnouncementsPastExpirationThreshold(int numDays)

deleteAnnouncementsPastExpirationThreshold.

Parameters:

numDays - a int.

getTopicSubscriptionFor

List<TopicSubscription> getTopicSubscriptionFor(javax.portlet.PortletRequest request)
                                         throws javax.portlet.PortletException

getTopicSubscriptionFor.

Parameters:

request - a PortletRequest object.

Returns:

a List object.

Throws:

javax.portlet.PortletException - if any.

addOrSaveTopicSubscription

void addOrSaveTopicSubscription(List<TopicSubscription> subs)

addOrSaveTopicSubscription.

Parameters:

subs - a List object.

persistTopicSubscription

void persistTopicSubscription(List<TopicSubscription> subs)

persistTopicSubscription.

Parameters:

subs - a List object.

deleteTopic

void deleteTopic(Topic topic)

deleteTopic.

Parameters:

topic - a Topic object.

deleteAnnouncement

void deleteAnnouncement(Announcement ann)

deleteAnnouncement.

Parameters:

ann - a Announcement object.

deleteTopicSubscription

void deleteTopicSubscription(TopicSubscription sub)

deleteTopicSubscription.

Parameters:

sub - a TopicSubscription object.