|
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 |
public interface AnnouncementService
Provides the ability to manipulate announcements. This service will allow you to create, delete, and expire announcements.
Method Summary | |
---|---|
Announcement |
createForumAnnouncement(long userID,
long forumID,
java.lang.String subject,
java.lang.String body,
java.util.Date startDate,
java.util.Date endDate)
Creates a new category or forum announcement. |
Announcement |
createForumCategoryAnnouncement(long userID,
long categoryID,
java.lang.String subject,
java.lang.String body,
java.util.Date startDate,
java.util.Date endDate)
Creates a new category announcement. |
Announcement |
createNonExpiringForumAnnouncement(long userID,
long forumID,
java.lang.String subject,
java.lang.String body,
java.util.Date startDate)
Creates a new non-expiring forum announcement. |
Announcement |
createNonExpiringForumCategoryAnnouncement(long userID,
long categoryID,
java.lang.String subject,
java.lang.String body,
java.util.Date startDate)
Creates a new non-expiring category announcement. |
Announcement |
createNonExpiringSystemAnnouncement(long userID,
java.lang.String subject,
java.lang.String body,
java.util.Date startDate)
Creates a new non-expiring system announcement. |
Announcement |
createSystemAnnouncement(long userID,
java.lang.String subject,
java.lang.String body,
java.util.Date startDate,
java.util.Date endDate)
Creates a new system announcement. |
void |
deleteAnnouncement(long announcementID)
Deletes an announcement. |
void |
editAnnouncement(Announcement announcement)
Updates an existing announcement. |
void |
expireAnnouncement(long announcementID)
Expires an announcement. |
Announcement |
getAnnouncement(long announcementID)
Returns an announcement by announcement ID. |
int |
getAnnouncementCount(int objectType,
long objectID)
Returns the count of all currently viewable announcements in a container. |
int |
getAnnouncementCount(int objectType,
long objectID,
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. |
Announcement[] |
getAnnouncements(int objectType,
long objectID)
Returns all currently viewable announcements in a container. |
Announcement[] |
getAnnouncements(int objectType,
long objectID,
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 than system announcements will be returned. |
int |
getForumAnnouncementCountWithFilter(long forumID,
AnnouncementFilter filter)
Returns the number of viewable announcements using the specified forumID and AnnouncementFilter. |
Announcement[] |
getForumAnnouncementsWithFilter(long forumID,
AnnouncementFilter filter)
Returns the viewable announcements using the specified forumID and AnnouncementFilter. |
int |
getRecursiveCategoryAnnouncementCount(long categoryID)
Returns the number of viewable announcements recursively using the categoryID provided. |
int |
getRecursiveCategoryAnnouncementCountWithFilter(long categoryID,
AnnouncementFilter filter)
Returns the number of viewable announcements recursively using the specified categoryID and AnnouncementFilter. |
Announcement[] |
getRecursiveCategoryAnnouncements(long categoryID,
int startIndex,
int numResults)
Returns the viewable announcements recursively using the categoryID provided. |
Announcement[] |
getRecursiveCategoryAnnouncementsWithFilter(long categoryID,
AnnouncementFilter filter)
Returns the viewable announcements recursively using the specified categoryID and AnnouncementFilter. |
int |
getSystemAnnouncementCountWithFilter(AnnouncementFilter filter)
Returns the number of viewable system announcements using the specified AnnouncementFilter. |
Announcement[] |
getSystemAnnouncementsWithFilter(AnnouncementFilter filter)
Returns the viewable system announcements using the specified AnnouncementFilter. |
Method Detail |
---|
Announcement createSystemAnnouncement(long userID, java.lang.String subject, java.lang.String body, java.util.Date startDate, java.util.Date endDate) throws UserNotFoundException, UnauthorizedException
userID
- the ID of the user creating the announcement.subject
- the subject of the announcement.body
- the body of the announcement.startDate
- the start date for the announcement. Cannot be null.endDate
- the end date for the announcement. Cannot be null.
UnauthorizedException
- if not allowed to create a system annoucement.
UserNotFoundException
Announcement createNonExpiringSystemAnnouncement(long userID, java.lang.String subject, java.lang.String body, java.util.Date startDate) throws UserNotFoundException, UnauthorizedException
userID
- the ID of the user creating the announcement.subject
- the subject of the announcement.body
- the body of the announcement.startDate
- the start date for the announcement. Cannot be null.
UnauthorizedException
- if not allowed to create a system annoucement.
UserNotFoundException
Announcement createForumAnnouncement(long userID, long forumID, java.lang.String subject, java.lang.String body, java.util.Date startDate, java.util.Date endDate) throws UserNotFoundException, ForumNotFoundException, UnauthorizedException
userID
- the user ID creating the announcement.forumID,
- the ID of the Forum.subject
- the subject of the announcement.body
- the body of the announcement.startDate
- the start date for the announcement. Cannot be null.endDate
- the end date for the announcement. Cannot be null.
UnauthorizedException
- if not allowed to create a system annoucement.
ForumCategoryNotFoundException
- if the category is not found.
ForumNotFoundException
- if the forum is not found.
UserNotFoundException
Announcement createNonExpiringForumAnnouncement(long userID, long forumID, java.lang.String subject, java.lang.String body, java.util.Date startDate) throws UserNotFoundException, ForumNotFoundException, UnauthorizedException
userID
- the user ID creating the announcement.forumID,
- the ID of the Forum.subject
- the subject of the announcement.body
- the body of the announcement.startDate
- the start date for the announcement. Cannot be null.
UnauthorizedException
- if not allowed to create a system annoucement.
ForumCategoryNotFoundException
- if the category is not found.
ForumNotFoundException
- if the forum is not found.
UserNotFoundException
Announcement createForumCategoryAnnouncement(long userID, long categoryID, java.lang.String subject, java.lang.String body, java.util.Date startDate, java.util.Date endDate) throws UserNotFoundException, ForumCategoryNotFoundException, UnauthorizedException
userID
- the user ID creating the announcement.categoryID,
- the ID of the Forum.subject
- the subject of the announcement.body
- the body of the announcement.startDate
- the start date for the announcement. Cannot be null.endDate
- the end date for the announcement. Cannot be null.
UnauthorizedException
- if not allowed to create a system annoucement.
ForumCategoryNotFoundException
- if the category is not found.
ForumNotFoundException
- if the forum is not found.
UserNotFoundException
Announcement createNonExpiringForumCategoryAnnouncement(long userID, long categoryID, java.lang.String subject, java.lang.String body, java.util.Date startDate) throws UserNotFoundException, ForumCategoryNotFoundException, UnauthorizedException
userID
- the user ID creating the announcement.categoryID,
- the ID of the Forum.subject
- the subject of the announcement.body
- the body of the announcement.startDate
- the start date for the announcement. Cannot be null.
UnauthorizedException
- if not allowed to create a system annoucement.
ForumCategoryNotFoundException
- if the category is not found.
ForumNotFoundException
- if the forum is not found.
UserNotFoundException
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.void editAnnouncement(Announcement announcement) throws AnnouncementNotFoundException
announcement
- the announcement to update.
AnnouncementNotFoundException
int getAnnouncementCount(int objectType, long objectID) throws ForumNotFoundException, ForumCategoryNotFoundException
objectType
- a forum, category, or -1 for system announcements.objectID
- an ID of a forums, category, or -1 for system announcmenents.
ForumNotFoundException
ForumCategoryNotFoundException
int getAnnouncementCount(int objectType, long objectID, java.util.Date startDate, java.util.Date endDate) throws ForumNotFoundException, ForumCategoryNotFoundException
objectType
- a forum, category, or -1 for system announcements.objectID
- an ID of a forums, category, or -1 for system announcmenents.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.
ForumNotFoundException
ForumCategoryNotFoundException
Announcement[] getAnnouncements(int objectType, long objectID) throws ForumNotFoundException, ForumCategoryNotFoundException
objectType
- a forum, category, or -1 for system announcements.objectID
- an ID of a forums, category, or -1 for system announcmenents.
ForumNotFoundException
ForumCategoryNotFoundException
Announcement[] getAnnouncements(int objectType, long objectID, java.util.Date startDate, java.util.Date endDate) throws ForumNotFoundException, ForumCategoryNotFoundException
objectType
- a forum, category, or -1 for system announcements.objectID
- an ID of a forums, category, or -1 for system announcmenents.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.
ForumNotFoundException
ForumCategoryNotFoundException
int getSystemAnnouncementCountWithFilter(AnnouncementFilter filter)
filter
- the AnnouncementFilter
Announcement[] getSystemAnnouncementsWithFilter(AnnouncementFilter filter)
filter
- the AnnouncementFilter
int getForumAnnouncementCountWithFilter(long forumID, AnnouncementFilter filter) throws ForumNotFoundException
forumID
- the forum IDfilter
- the AnnouncementFilter
ForumNotFoundException
- if the forum is not found.Announcement[] getForumAnnouncementsWithFilter(long forumID, AnnouncementFilter filter) throws ForumNotFoundException
forumID
- the forum IDfilter
- the AnnouncementFilter
ForumNotFoundException
- if the forum is not found.int getRecursiveCategoryAnnouncementCount(long categoryID) throws ForumCategoryNotFoundException
categoryID
- the category ID, or -1 to start with System Announcements
ForumCategoryNotFoundException
- if the category is not found.int getRecursiveCategoryAnnouncementCountWithFilter(long categoryID, AnnouncementFilter filter) throws ForumCategoryNotFoundException
categoryID
- the category ID, or -1 to start with System Announcementsfilter
- the AnnouncementFilter
ForumCategoryNotFoundException
- if the category is not found.Announcement[] getRecursiveCategoryAnnouncements(long categoryID, int startIndex, int numResults) throws ForumCategoryNotFoundException
categoryID
- the category ID, or -1 to start with System AnnouncementsstartIndex
- the 0 based index to start at.numResults
- the number of results to returned, or Integer.MAX_VALUE for all results.
ForumCategoryNotFoundException
- if the category is not found.Announcement[] getRecursiveCategoryAnnouncementsWithFilter(long categoryID, AnnouncementFilter filter) throws ForumCategoryNotFoundException
categoryID
- the category ID, or -1 to start with System Announcementsfilter
- the AnnouncementFilter
ForumCategoryNotFoundException
- if the category is not found.void deleteAnnouncement(long announcementID) throws UnauthorizedException, AnnouncementNotFoundException
announcementID
- the ID of the announcement to delete.
UnauthorizedException
- if not allowed to delete the announcement.
AnnouncementNotFoundException
void expireAnnouncement(long announcementID) throws UnauthorizedException, AnnouncementNotFoundException
announcementID
- the ID of the announcement to delete.
UnauthorizedException
- if not allowed to delete the announcement.
AnnouncementNotFoundException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |