org.jasig.portlet.announcements.model

Class Topic

java.lang.Object

org.jasig.portlet.announcements.model.Topic

public class Topic
extends Object

Author:

Erik A. Olsson (eolsson@uci.edu)

$LastChangedBy$ $LastChangedDate$

Field Summary

Fields

Modifier and Type	Field and Description
static int	EMERGENCY
static int	PULLED
static int	PUSHED_FORCED
static int	PUSHED_INITIAL

Constructor Summary

Constructors

Constructor and Description
Topic()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Set<String>	getAdmins()
Set<Announcement>	getAnnouncements() Returns a list of all announcements in this topic, regardless of status.
Set<String>	getAudience()
Set<String>	getAuthors()
String	getCreator()
String	getDescription()
int	getDisplayingAnnouncementCount() Get the current number of displaying announcements
Set<String>	getGroup(String key)
Set<Announcement>	getHistoricAnnouncements() Returns a list of all historic announcements in this topic.
Long	getId()
Set<String>	getModerators()
Set<Announcement>	getNonHistoricAnnouncements() Returns a list of all historic announcements in this topic.
int	getPendingAnnouncementCount() Get the current number of pending announcements
Set<Announcement>	getPendingAnnouncements()
Set<Announcement>	getPublishedAnnouncements() Returns a list of all published announcements in this topic.
int	getScheduledAnnouncementCount() Get the current number of approved & scheduled announcements
int	getSubscriptionMethod()
Set<TopicSubscription>	getSubscriptions()
String	getTitle()
int	hashCode()
boolean	hasId()
boolean	isAllowRss()
void	setAdmins(Set<String> admins)
void	setAllowRss(boolean allowRss)
void	setAnnouncements(Set<Announcement> announcements)
void	setAudience(Set<String> audience)
void	setAuthors(Set<String> authors)
void	setCreator(String creator)
void	setDescription(String description)
void	setGroup(String key, Set<String> members)
void	setId(Long id)
void	setModerators(Set<String> moderators)
void	setSubscriptionMethod(int subscriptionMethod)
void	setSubscriptions(Set<TopicSubscription> subscriptions)
void	setTitle(String title)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PUSHED_FORCED

public static final int PUSHED_FORCED

See Also:

Constant Field Values

PUSHED_INITIAL

public static final int PUSHED_INITIAL

See Also:

Constant Field Values

PULLED

public static final int PULLED

See Also:

Constant Field Values

EMERGENCY

public static final int EMERGENCY

See Also:

Constant Field Values

Constructor Detail

Topic

public Topic()

Method Detail

getGroup

public Set<String> getGroup(String key)

setGroup

public void setGroup(String key,
                     Set<String> members)

hasId

public boolean hasId()

getModerators

public Set<String> getModerators()

Returns:

the moderators

getCreator

public String getCreator()

Returns:

the creator

getTitle

public String getTitle()

Returns:

the title

getDescription

public String getDescription()

Returns:

the description

isAllowRss

public boolean isAllowRss()

Returns:

the allowRss

setModerators

public void setModerators(Set<String> moderators)

Parameters:

moderators - the moderators to set

setCreator

public void setCreator(String creator)

Parameters:

creator - the creator to set

setTitle

public void setTitle(String title)

Parameters:

title - the title to set

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

setAllowRss

public void setAllowRss(boolean allowRss)

Parameters:

allowRss - the allowRss to set

getSubscriptions

public Set<TopicSubscription> getSubscriptions()

setSubscriptions

public void setSubscriptions(Set<TopicSubscription> subscriptions)

getAnnouncements

public Set<Announcement> getAnnouncements()

Returns a list of all announcements in this topic, regardless of status.

Returns:

the announcements

getPublishedAnnouncements

public Set<Announcement> getPublishedAnnouncements()

Returns a list of all published announcements in this topic. For topics to be included in this list, they must also be within their specified display period.

Returns:

the announcements

getNonHistoricAnnouncements

public Set<Announcement> getNonHistoricAnnouncements()

Returns a list of all historic announcements in this topic. Non-historic announcements are simply all non-expired announcements as well as announcements that expired less than a day ago.

Returns:

the announcements

getHistoricAnnouncements

public Set<Announcement> getHistoricAnnouncements()

Returns a list of all historic announcements in this topic.

Returns:

the announcements

getDisplayingAnnouncementCount

public int getDisplayingAnnouncementCount()

Get the current number of displaying announcements

Returns:

getScheduledAnnouncementCount

public int getScheduledAnnouncementCount()

Get the current number of approved & scheduled announcements

Returns:

getPendingAnnouncements

public Set<Announcement> getPendingAnnouncements()

getPendingAnnouncementCount

public int getPendingAnnouncementCount()

Get the current number of pending announcements

Returns:

getId

public Long getId()

Returns:

the id

setAnnouncements

public void setAnnouncements(Set<Announcement> announcements)

Parameters:

announcements - the announcements to set

setId

public void setId(Long id)

Parameters:

id - the id to set

getAuthors

public Set<String> getAuthors()

Returns:

the authors

setAuthors

public void setAuthors(Set<String> authors)

Parameters:

authors - the authors to set

getAdmins

public Set<String> getAdmins()

Returns:

the admins

getAudience

public Set<String> getAudience()

Returns:

the audience

setAdmins

public void setAdmins(Set<String> admins)

Parameters:

admins - the admins to set

setAudience

public void setAudience(Set<String> audience)

Parameters:

audience - the audience to set

getSubscriptionMethod

public int getSubscriptionMethod()

Returns:

the subscriptionMethod

setSubscriptionMethod

public void setSubscriptionMethod(int subscriptionMethod)

Parameters:

subscriptionMethod - the subscriptionMethod to set

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object