Topic (Announcements Portlet 2.5.0 API)

java.lang.Object
- org.jasig.portlet.announcements.model.Topic

```
public class Topic
extends Object
```
Topic class.

Version:

$Id: $Id

Author:

Erik A. Olsson (eolsson@uci.edu)
$LastChangedBy$ $LastChangedDate$

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`EMERGENCY` Constant `EMERGENCY=4`
`static int`	`PULLED` Constant `PULLED=3`
`static int`	`PUSHED_FORCED` Constant `PUSHED_FORCED=1`
`static int`	`PUSHED_INITIAL` Constant `PUSHED_INITIAL=2`

Constructor Summary

Constructors
Constructor and Description

Topic()
Constructor for Topic.

Constructors
Constructor and Description
`Topic()` Constructor for Topic.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Set<String>`	`getAdmins()` Getter for the field `admins`.
`Set<Announcement>`	`getAnnouncements()` Returns a list of all announcements in this topic, regardless of status.
`Set<String>`	`getAudience()` Getter for the field `audience`.
`Set<String>`	`getAuthors()` Getter for the field `authors`.
`String`	`getCreator()` Getter for the field `creator`.
`String`	`getDescription()` Getter for the field `description`.
`int`	`getDisplayingAnnouncementCount()` Get the current number of displaying announcements
`Set<String>`	`getGroup(String key)` getGroup.
`Set<Announcement>`	`getHistoricAnnouncements()` Returns a list of all historic announcements in this topic.
`Long`	`getId()` Getter for the field `id`.
`Set<String>`	`getModerators()` Getter for the field `moderators`.
`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()` 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()` Getter for the field `subscriptionMethod`.
`Set<TopicSubscription>`	`getSubscriptions()` Getter for the field `subscriptions`.
`String`	`getTitle()` Getter for the field `title`.
`int`	`hashCode()`
`boolean`	`hasId()` hasId.
`boolean`	`isAllowRss()` isAllowRss.
`void`	`setAdmins(Set<String> admins)` Setter for the field `admins`.
`void`	`setAllowRss(boolean allowRss)` Setter for the field `allowRss`.
`void`	`setAnnouncements(Set<Announcement> announcements)` Setter for the field `announcements`.
`void`	`setAudience(Set<String> audience)` Setter for the field `audience`.
`void`	`setAuthors(Set<String> authors)` Setter for the field `authors`.
`void`	`setCreator(String creator)` Setter for the field `creator`.
`void`	`setDescription(String description)` Setter for the field `description`.
`void`	`setGroup(String key, Set<String> members)` setGroup.
`void`	`setId(Long id)` Setter for the field `id`.
`void`	`setModerators(Set<String> moderators)` Setter for the field `moderators`.
`void`	`setSubscriptionMethod(int subscriptionMethod)` Setter for the field `subscriptionMethod`.
`void`	`setSubscriptions(Set<TopicSubscription> subscriptions)` Setter for the field `subscriptions`.
`void`	`setTitle(String title)` Setter for the field `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
```
    Constant PUSHED_FORCED=1
    
    See Also:
    
    Constant Field Values
  - PUSHED_INITIAL
```
public static final int PUSHED_INITIAL
```
    Constant PUSHED_INITIAL=2
    
    See Also:
    
    Constant Field Values
  - PULLED
```
public static final int PULLED
```
    Constant PULLED=3
    
    See Also:
    
    Constant Field Values
  - EMERGENCY
```
public static final int EMERGENCY
```
    Constant EMERGENCY=4
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Topic
```
public Topic()
```
    Constructor for Topic.
- Method Detail
  - getGroup
```
public Set<String> getGroup(String key)
```
    getGroup.
    
    Parameters:
    
    key - a String object.
    
    Returns:
    
    a Set object.
  - setGroup
```
public void setGroup(String key,
                     Set<String> members)
```
    setGroup.
    
    Parameters:
    
    key - a String object.
    
    members - a Set object.
  - hasId
```
public boolean hasId()
```
    hasId.
    
    Returns:
    
    a boolean.
  - getModerators
```
public Set<String> getModerators()
```
    Getter for the field moderators.
    
    Returns:
    
    a Set object.
  - getCreator
```
public String getCreator()
```
    Getter for the field creator.
    
    Returns:
    
    a String object.
  - getTitle
```
public String getTitle()
```
    Getter for the field title.
    
    Returns:
    
    a String object.
  - getDescription
```
public String getDescription()
```
    Getter for the field description.
    
    Returns:
    
    a String object.
  - isAllowRss
```
public boolean isAllowRss()
```
    isAllowRss.
    
    Returns:
    
    a boolean.
  - setModerators
```
public void setModerators(Set<String> moderators)
```
    Setter for the field moderators.
    
    Parameters:
    
    moderators - a Set object.
  - setCreator
```
public void setCreator(String creator)
```
    Setter for the field creator.
    
    Parameters:
    
    creator - a String object.
  - setTitle
```
public void setTitle(String title)
```
    Setter for the field title.
    
    Parameters:
    
    title - a String object.
  - setDescription
```
public void setDescription(String description)
```
    Setter for the field description.
    
    Parameters:
    
    description - a String object.
  - setAllowRss
```
public void setAllowRss(boolean allowRss)
```
    Setter for the field allowRss.
    
    Parameters:
    
    allowRss - a boolean.
  - getSubscriptions
```
public Set<TopicSubscription> getSubscriptions()
```
    Getter for the field subscriptions.
    
    Returns:
    
    a Set object.
  - setSubscriptions
```
public void setSubscriptions(Set<TopicSubscription> subscriptions)
```
    Setter for the field subscriptions.
    
    Parameters:
    
    subscriptions - a Set object.
  - 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:
    
    a int.
  - getScheduledAnnouncementCount
```
public int getScheduledAnnouncementCount()
```
    Get the current number of approved & scheduled announcements
    
    Returns:
    
    a int.
  - getPendingAnnouncements
```
public Set<Announcement> getPendingAnnouncements()
```
    getPendingAnnouncements.
    
    Returns:
    
    a Set object.
  - getPendingAnnouncementCount
```
public int getPendingAnnouncementCount()
```
    Get the current number of pending announcements
    
    Returns:
    
    a int.
  - getId
```
public Long getId()
```
    Getter for the field id.
    
    Returns:
    
    a Long object.
  - setAnnouncements
```
public void setAnnouncements(Set<Announcement> announcements)
```
    Setter for the field announcements.
    
    Parameters:
    
    announcements - a Set object.
  - setId
```
public void setId(Long id)
```
    Setter for the field id.
    
    Parameters:
    
    id - a Long object.
  - getAuthors
```
public Set<String> getAuthors()
```
    Getter for the field authors.
    
    Returns:
    
    a Set object.
  - setAuthors
```
public void setAuthors(Set<String> authors)
```
    Setter for the field authors.
    
    Parameters:
    
    authors - a Set object.
  - getAdmins
```
public Set<String> getAdmins()
```
    Getter for the field admins.
    
    Returns:
    
    a Set object.
  - getAudience
```
public Set<String> getAudience()
```
    Getter for the field audience.
    
    Returns:
    
    a Set object.
  - setAdmins
```
public void setAdmins(Set<String> admins)
```
    Setter for the field admins.
    
    Parameters:
    
    admins - a Set object.
  - setAudience
```
public void setAudience(Set<String> audience)
```
    Setter for the field audience.
    
    Parameters:
    
    audience - a Set object.
  - getSubscriptionMethod
```
public int getSubscriptionMethod()
```
    Getter for the field subscriptionMethod.
    
    Returns:
    
    a int.
  - setSubscriptionMethod
```
public void setSubscriptionMethod(int subscriptionMethod)
```
    Setter for the field subscriptionMethod.
    
    Parameters:
    
    subscriptionMethod - a int.
  - 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

Class Topic

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PUSHED_FORCED

PUSHED_INITIAL

PULLED

EMERGENCY

Constructor Detail

Topic

Method Detail

getGroup

setGroup

hasId

getModerators

getCreator

getTitle

getDescription

isAllowRss

setModerators

setCreator

setTitle

setDescription

setAllowRss

getSubscriptions

setSubscriptions

getAnnouncements

getPublishedAnnouncements

getNonHistoricAnnouncements

getHistoricAnnouncements

getDisplayingAnnouncementCount

getScheduledAnnouncementCount

getPendingAnnouncements

getPendingAnnouncementCount

getId

setAnnouncements

setId

getAuthors

setAuthors

getAdmins

getAudience

setAdmins

setAudience

getSubscriptionMethod

setSubscriptionMethod

equals

hashCode

toString