|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AnnouncementManager
Manages announcements, including viewing, creating, and deleting them.
Announcement
Method Summary | |
---|---|
void |
addAnnouncement(Announcement announcement)
Adds an an announcement to the database. |
Announcement |
createAnnouncement(User user)
Creates a new system announcement. |
Announcement |
createAnnouncement(User user,
Forum forum)
Creates a new forum announcement. |
Announcement |
createAnnouncement(User user,
ForumCategory category)
Creates a new category announcement. |
void |
deleteAnnouncement(Announcement announcement)
Deletes an announcement. |
Announcement |
getAnnouncement(long announcementID)
Returns an announcement by announcement ID. |
int |
getAnnouncementCount(java.lang.Object container)
Returns the count of all currently viewable announcements in a container. |
int |
getAnnouncementCount(java.lang.Object container,
java.util.Date startDate,
java.util.Date endDate)
Returns the count of all announcements in a container that are viewable within the specified date range. |
java.util.Iterator |
getAnnouncements(java.lang.Object container)
Returns all currently viewable announcements in a container. |
java.util.Iterator |
getAnnouncements(java.lang.Object container,
java.util.Date startDate,
java.util.Date endDate)
Returns the announcements in a container that are viewable within a specified date range.If container is null then system announcements will be returned. |
int |
getRecursiveAnnouncementCount(ForumCategory category)
Returns the count of all currently viewable announcements in a ForumCategory and its child Forums and SubCategories. |
java.util.Iterator |
getRecursiveAnnouncements(ForumCategory category,
int startIndex,
int numResults)
Returns all currently viewable announcements in a ForumCategory and its child Forums and SubCategories. |
Method Detail |
---|
Announcement createAnnouncement(User user) throws UnauthorizedException
addAnnouncement(Announcement)
method.
user
- the user creating the announcement.
UnauthorizedException
- if not allowed to create a system annoucement.Announcement createAnnouncement(User user, ForumCategory category) throws UnauthorizedException
addAnnouncement(Announcement)
method.
user
- the user creating the announcement.category
- the category to add the announcement to.
UnauthorizedException
- if not allowed to create a system annoucement.Announcement createAnnouncement(User user, Forum forum) throws UnauthorizedException
addAnnouncement(Announcement)
method.
user
- the user creating the announcement.forum
- the forum to add the announcement to.
UnauthorizedException
- if not allowed to create a system annoucement.void addAnnouncement(Announcement announcement) throws UnauthorizedException
announcement
- the announcement to add to the database.
UnauthorizedException
- if not allowed to create a system annoucement.
java.lang.IllegalStateException
- if the announcement has already been added.Announcement getAnnouncement(long announcementID) throws AnnouncementNotFoundException, UnauthorizedException
announcementID
- the ID of the announcement to return.
AnnouncementNotFoundException
- if the announcement could not be loaded
or does not exist.
UnauthorizedException
- if not allowed to get the announcement.int getAnnouncementCount(java.lang.Object container)
container
- a forum, category, or null for system announcements.
int getRecursiveAnnouncementCount(ForumCategory category)
category
- a category, or null for system announcements.
int getAnnouncementCount(java.lang.Object container, java.util.Date startDate, java.util.Date endDate)
container
- a forum, category, or null for system announcements.startDate
- the start date of announcements, or null to leave this value
unbounded.endDate
- the end date of announcements, or null to leave this value
unbounded.
java.util.Iterator getAnnouncements(java.lang.Object container)
container
- a forum, category, or null for system announcements.
java.util.Iterator getAnnouncements(java.lang.Object container, java.util.Date startDate, java.util.Date endDate)
container
- a forum, category, or null for system announcements.startDate
- the start date of announcements, or null to leave this value
unbounded.endDate
- the end date of announcements, or null to leave this value
unbounded.
java.util.Iterator getRecursiveAnnouncements(ForumCategory category, int startIndex, int numResults)
category
- a category, or null for system announcements.
void deleteAnnouncement(Announcement announcement) throws UnauthorizedException
announcement
- the announcement to delete.
UnauthorizedException
- if not allowed to delete the announcement.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |