oracle.workspaces.ws
Interface AnnouncementsService

public interface AnnouncementsService

Workspace members can post announcements at the workspace level - AnnouncementsService provides methods to operate on announcements in a workspace.

The major operations supported include: creation, update, retrieval and deletion of announcements

Method Summary

AnnouncementItem	createAnnouncement(java.lang.String wspcUid, AnnouncementDefinition aDef) Create an announcement
void	deleteAnnouncements(java.lang.String wspcUid, java.lang.String[] announcementUids) Delete the specified announcements within a workspace.
void	deleteExpiredAnnouncements(java.lang.String wspcUid) Delete all expired announcements within a workspace.
AnnouncementItem	getAnnouncementByUid(java.lang.String wspcUid, java.lang.String announcementUid) Get an announcement by its id
AnnouncementItem[]	listAllAnnouncements(java.lang.String wspcUid) List all announcements within a workspace
AnnouncementItem[]	listExpiredAnnouncements(java.lang.String wspcUid) List all expired announcements within a workspace.
AnnouncementItem[]	listUnExpiredAnnouncements(java.lang.String wspcUid) List all unexpired announcements within a workspace
void	updateAnnouncement(java.lang.String wspcUid, AnnouncementItem aItem) Update announcement

Method Detail

createAnnouncement

public AnnouncementItem createAnnouncement(java.lang.String wspcUid,
                                           AnnouncementDefinition aDef)
                                    throws CwWSException

Create an announcement

Parameters:

wspcUid - - UID of the workspace

aDef - The values that can be set are:

• BODY
• CONTENT_TYPE
• EXPIRATION_TIME
• TITLE

• Returns:

  the created announcement

  Throws:

  CwWSException - - If objects passed are null or invalid

getAnnouncementByUid

public AnnouncementItem getAnnouncementByUid(java.lang.String wspcUid,
                                             java.lang.String announcementUid)
                                      throws CwWSException

Get an announcement by its id

Parameters:

wspcUid - -UID of the workspace

announcementUid - - Announcement UID to be fetched

Throws:

CwWSException - - If objects passed are null or invalid

updateAnnouncement

public void updateAnnouncement(java.lang.String wspcUid,
                               AnnouncementItem aItem)
                        throws CwWSException

Update announcement

Parameters:

wspcUid - - UID of the workspace

aItem - - AnnouncementItem with modified values to be updated

Throws:

CwWSException - - If objects passed are null or invalid

deleteExpiredAnnouncements

public void deleteExpiredAnnouncements(java.lang.String wspcUid)
                                throws CwWSException

Delete all expired announcements within a workspace.

Parameters:

wspcUid - - UID of the workspace

Throws:

CwWSException - - If objects passed are null or invalid

listAllAnnouncements

public AnnouncementItem[] listAllAnnouncements(java.lang.String wspcUid)
                                        throws CwWSException

List all announcements within a workspace

Parameters:

wspcUid - - UID of the workspace

Range based listing is not implemented in the current version.

Throws:

CwWSException - - If objects passed are null or invalid

listExpiredAnnouncements

public AnnouncementItem[] listExpiredAnnouncements(java.lang.String wspcUid)
                                            throws CwWSException

List all expired announcements within a workspace.

Parameters:

wspcUid - - UID of the workspace

Range based listing is not implemented in the current version.

Throws:

CwWSException - - If objects passed are null or invalid

listUnExpiredAnnouncements

public AnnouncementItem[] listUnExpiredAnnouncements(java.lang.String wspcUid)
                                              throws CwWSException

List all unexpired announcements within a workspace

Parameters:

wspcUid - - UID of the workspace

Range based listing is not implemented in the current version.

Throws:

CwWSException - - If objects passed are null or invalid

deleteAnnouncements

public void deleteAnnouncements(java.lang.String wspcUid,
                                java.lang.String[] announcementUids)
                         throws CwWSException

Delete the specified announcements within a workspace.

Parameters:

wspcUid - - UID of the workspace

announcementUids - - List of announcement UIDs

Throws:

CwWSException - - If objects passed are null or invalid