com.bea.apps.groupspace.announcements.controls
Interface AnnouncementsControl

All Superinterfaces

CM_Control<Announcement>, ContentControlBase<Announcement,Folder>, GroupSpaceContentControl<Announcement>, Serializable

All Known Implementing Classes:

AnnouncementsControlImpl

public interface AnnouncementsControl
extends CM_Control<Announcement>

Nested Class Summary

Nested classes/interfaces inherited from interface com.bea.apps.groupspace.controls.generic.ContentControlBase

ContentControlBase.NodeSearchType, ContentControlBase.Params

Method Summary

Announcement	create(String title, String description, CommunityContent.Visibility visibility, Calendar expiration, String messageBody) Creates an announcement with the effective date of the announcement being set to the current time.
Announcement	create(String title, String description, CommunityContent.Visibility visibility, String severity, Calendar expiration, String messageBody, ID parentId) Creates an announcement with the effective date of the announcement being set to the current time.
Announcement	create(String title, String description, CommunityContent.Visibility visibility, String severity, String attachment, String addressTo, Calendar effective, Calendar expiration, String messageBody, ID parentId, ID[] relatedNodes) Creates an announcement.
Announcement	create(String title, String description, CommunityContent.Visibility visibility, String severity, String attachment, String addressTo, Calendar effective, Calendar expiration, String messageBody, ID parentId, ID[] relatedNodes, Set<CmxControl.PropertyPair> dynamicProps)
Set<Announcement>	getEffectiveAnnouncements() Returns the set of announcements that are: Currently in effect Apply to the currently logged in user.
SortableFilterablePagedResult	getEffectiveAnnouncementsAsPagedResult(SortCriteria[] sortCriteria) Returns the set of announcements that are: Currently in effect Apply to the currently logged in user.
String	getMessageBody(Announcement announcement)

Methods inherited from interface com.bea.apps.groupspace.controls.generic.CM_Control

getPersonalContentFolder

Methods inherited from interface com.bea.apps.groupspace.controls.generic.GroupSpaceContentControl

asSet, createFolder, createFolder, findByDescription, findByTitle, getCommunity, getCommunityAndPrivate, getCommunityFolder, getPersonal, getPrivate, getReferencingContent, getReferencingContent, getRelatedContent, promoteToCommunity, removeCommunityAndPrivate, removePersonal, removePrivate

Methods inherited from interface com.bea.apps.groupspace.controls.generic.ContentControlBase

createObjectClass, createObjects, createObjects, findById, findContentById, findMany, findMany, findManyChildren, getAllPropertyDefinitions, getDefaultStringValue, getFolder, getImmediateChildren, getImmediateChildren, getImmediateChildrenAsPagedResult, getObjectClass, getTopFolder, getTopNode, move, move, remove, remove, remove, removeAll, update, update

Method Detail

create

Announcement create(String title,
                    String description,
                    CommunityContent.Visibility visibility,
                    Calendar expiration,
                    String messageBody)
                    throws Exception

Creates an announcement with the effective date of the announcement being set to the current time. The parent node will be set to the default node ID (as defined in CommunityContent). The severity of the announcement will be set to NORMAL. The remaining items will be set to null:

• attachment
• addressTo
• relatedNodes

Parameters

title - Title of the announcement (or subject)

description - A lengthy description of the announcment.

visibility - Visibility (Community, personal, private)

expiration - Expiration date of announcement.

Returns

An Announcement object if successful.

Throws

Exception

create

Announcement create(String title,
                    String description,
                    CommunityContent.Visibility visibility,
                    String severity,
                    Calendar expiration,
                    String messageBody,
                    ID parentId)
                    throws Exception

Creates an announcement with the effective date of the announcement being set to the current time. The remaining items will be set to null:

• attachment
• addressTo
• relatedNodes

Parameters

title - Title of the announcement (or subject)

description - A lengthy description of the announcment.

visibility - Visibility (Community, personal, private)

severity - The severity of the announcement.

expiration - Expiration date of announcement.

parentId - The parent node ID

Returns

An Announcement object if successful.

Throws

Exception

create

Announcement create(String title,
                    String description,
                    CommunityContent.Visibility visibility,
                    String severity,
                    String attachment,
                    String addressTo,
                    Calendar effective,
                    Calendar expiration,
                    String messageBody,
                    ID parentId,
                    ID[] relatedNodes)
                    throws Exception

Creates an announcement.

Parameters

title - Title of the announcement (or subject)

description - A lengthy description of the announcment.

visibility - Visibility (Community, personal, private)

attachment - TODO

addressTo - If the visibility is community, this can be one of the roles defined as membership capability.

effective - Effective date of announcement.

expiration - Expiration date of announcement.

parentId - The parent node ID

relatedNodes - TODO

Returns

AnAnnouncement object if successful.

Throws

Exception

create

Announcement create(String title,
                    String description,
                    CommunityContent.Visibility visibility,
                    String severity,
                    String attachment,
                    String addressTo,
                    Calendar effective,
                    Calendar expiration,
                    String messageBody,
                    ID parentId,
                    ID[] relatedNodes,
                    Set<CmxControl.PropertyPair> dynamicProps)
                    throws Exception

Throws

Exception

getEffectiveAnnouncements

Set<Announcement> getEffectiveAnnouncements()
                                            throws AuthorizationException,
                                                   NoSuchNodeException,
                                                   RepositoryException

Returns the set of announcements that are:

1. Currently in effect
2. Apply to the currently logged in user.

Returns

A paired down set of announcements based on the above criteria.

Throws

AuthorizationException

NoSuchNodeException

RepositoryException

getEffectiveAnnouncementsAsPagedResult

SortableFilterablePagedResult getEffectiveAnnouncementsAsPagedResult(SortCriteria[] sortCriteria)
                                                                     throws AuthorizationException,
                                                                            NoSuchNodeException,
                                                                            RepositoryException

Returns the set of announcements that are:

1. Currently in effect
2. Apply to the currently logged in user.

Returns

A SortableFilterablePagedResult collection based on the above criteria.

Throws

AuthorizationException

NoSuchNodeException

RepositoryException

getMessageBody

String getMessageBody(Announcement announcement)
                      throws RepositoryException,
                             AuthorizationException

Throws

RepositoryException

AuthorizationException