|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.proxy.AnnouncementManagerProxy
public class AnnouncementManagerProxy
Proxy class for AnnouncementManager objects.
Constructor Summary | |
---|---|
AnnouncementManagerProxy(AnnouncementManager manager,
AuthToken authToken,
Permissions permissions)
Creates a new AnnouncementManager to protect the supplied manager with the specified permissions. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AnnouncementManagerProxy(AnnouncementManager manager, AuthToken authToken, Permissions permissions)
Method Detail |
---|
public Announcement createAnnouncement(User user) throws UnauthorizedException
AnnouncementManager
AnnouncementManager.addAnnouncement(Announcement)
method.
createAnnouncement
in interface AnnouncementManager
user
- the user creating the announcement.
UnauthorizedException
- if not allowed to create a system annoucement.public Announcement createAnnouncement(User user, ForumCategory category) throws UnauthorizedException
AnnouncementManager
AnnouncementManager.addAnnouncement(Announcement)
method.
createAnnouncement
in interface AnnouncementManager
user
- the user creating the announcement.category
- the category to add the announcement to.
UnauthorizedException
- if not allowed to create a system annoucement.public Announcement createAnnouncement(User user, Forum forum) throws UnauthorizedException
AnnouncementManager
AnnouncementManager.addAnnouncement(Announcement)
method.
createAnnouncement
in interface AnnouncementManager
user
- the user creating the announcement.forum
- the forum to add the announcement to.
UnauthorizedException
- if not allowed to create a system annoucement.public void addAnnouncement(Announcement announcement) throws UnauthorizedException
AnnouncementManager
addAnnouncement
in interface AnnouncementManager
announcement
- the announcement to add to the database.
UnauthorizedException
- if not allowed to create a system annoucement.public Announcement getAnnouncement(long announcementID) throws AnnouncementNotFoundException, UnauthorizedException
AnnouncementManager
getAnnouncement
in interface AnnouncementManager
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.public int getAnnouncementCount(java.lang.Object container)
AnnouncementManager
getAnnouncementCount
in interface AnnouncementManager
container
- a forum, category, or null for system announcements.
public int getRecursiveAnnouncementCount(ForumCategory category)
AnnouncementManager
getRecursiveAnnouncementCount
in interface AnnouncementManager
category
- a category, or null for system announcements.
public int getAnnouncementCount(java.lang.Object container, java.util.Date startDate, java.util.Date endDate)
AnnouncementManager
getAnnouncementCount
in interface AnnouncementManager
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.
public java.util.Iterator getAnnouncements(java.lang.Object container)
AnnouncementManager
getAnnouncements
in interface AnnouncementManager
container
- a forum, category, or null for system announcements.
public java.util.Iterator getAnnouncements(java.lang.Object container, java.util.Date startDate, java.util.Date endDate)
AnnouncementManager
getAnnouncements
in interface AnnouncementManager
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.
public java.util.Iterator getRecursiveAnnouncements(ForumCategory category, int startIndex, int numResults)
AnnouncementManager
getRecursiveAnnouncements
in interface AnnouncementManager
category
- a category, or null for system announcements.
public void deleteAnnouncement(Announcement announcement) throws UnauthorizedException
AnnouncementManager
deleteAnnouncement
in interface AnnouncementManager
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 |