A B C D E F G I L N O P R S T U V

A

AnnouncementAction - Class in org.sakaiproject.announcement.tool

AnnouncementAction is an implementation of Announcement service, which provides the complete function of announcements.

AnnouncementAction() - Constructor for class org.sakaiproject.announcement.tool.AnnouncementAction

AnnouncementAction.AnnouncementWrapper - Class in org.sakaiproject.announcement.tool

Decorator for the "Message" class.

AnnouncementAction.AnnouncementWrapper(AnnouncementMessage, AnnouncementChannel, AnnouncementChannel, AnnouncementActionState.DisplayOptions, String) - Constructor for class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

Constructor

AnnouncementAction.AnnouncementWrapper(AnnouncementAction.AnnouncementWrapper) - Constructor for class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

Constructor

AnnouncementActionState - Class in org.sakaiproject.announcement.tool

AnnouncementActionState is the state object for the AnnouncementAction tool.

AnnouncementActionState() - Constructor for class org.sakaiproject.announcement.tool.AnnouncementActionState

Creates new AnnouncementActionState

AnnouncementActionState.DisplayOptions - Class in org.sakaiproject.announcement.tool

Holds the display options for the Announcements tool

AnnouncementActionState.DisplayOptions() - Constructor for class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Default constructor

AnnouncementEntityProviderImpl - Class in org.sakaiproject.announcement.entityprovider

Allows some basic functions on announcements.

AnnouncementEntityProviderImpl() - Constructor for class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

AnnouncementEntityProviderImpl.DecoratedAnnouncement - Class in org.sakaiproject.announcement.entityprovider

Class to hold only the fields that we want to return

AnnouncementEntityProviderImpl.DecoratedAnnouncement() - Constructor for class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

AnnouncementEntityProviderImpl.DecoratedAnnouncement(String, String, String) - Constructor for class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

As we are packing these fields into the ID, we need all of them.

AnnouncementEntityProviderImpl.DecoratedAttachment - Class in org.sakaiproject.announcement.entityprovider

AnnouncementEntityProviderImpl.DecoratedAttachment() - Constructor for class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAttachment

AnnouncementEntityProviderImpl.DecoratedAttachment(String, String) - Constructor for class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAttachment

AnnouncementEntityProviderImpl.DecoratedAttachment(String, String, String, String, String) - Constructor for class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAttachment

B

buildCancelContext(VelocityPortlet, Context, RunData, AnnouncementActionState) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Build the context for cancelling the operation and going back to list view

buildDeleteAnnouncementContext(VelocityPortlet, Context, RunData, AnnouncementActionState) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Build the context for asking for the delete confirmation

buildMainPanelContext(VelocityPortlet, Context, RunData, SessionState) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Default is to use when Portal starts up

buildMergeContext(VelocityPortlet, Context, RunData, AnnouncementActionState, SessionState) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Build the context for showing merged view

buildOptionsPanelContext(VelocityPortlet, Context, RunData, SessionState) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Setup for the options panel.

buildPreviewContext(VelocityPortlet, Context, RunData, AnnouncementActionState) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Build the context for preview an attachment

buildReorderContext(VelocityPortlet, Context, RunData, AnnouncementActionState, SessionState) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Build the context for showing merged view

buildReviseAnnouncementContext(VelocityPortlet, Context, RunData, AnnouncementActionState, SessionState) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Build the context for revising the announcement

buildShowMetadataContext(VelocityPortlet, Context, RunData, AnnouncementActionState, SessionState) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Build the context for viewing announcement content

buildSortedContext(VelocityPortlet, Context, RunData, SessionState) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

C

compareTo(Object) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

compareTo(Object) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

createEntity(EntityReference, Object, Map<String, Object>) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

D

DEFAULT_DAYS_IN_PAST - Static variable in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

DEFAULT_DAYS_IN_PAST_OPTION - Static variable in class org.sakaiproject.announcement.tool.AnnouncementActionState

DEFAULT_DISPLAY_NUMBER_OPTION - Static variable in class org.sakaiproject.announcement.tool.AnnouncementActionState

DEFAULT_NUM_ANNOUNCEMENTS - Static variable in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

deleteEntity(EntityReference, Map<String, Object>) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

doAnnouncement_form(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Dispatcher function for various actions on add/revise announcement page

doAttachments(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

doCancel(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Action is to use when doCancel requested, corresponding to chef_announcement "eventSubmit_doCancel"

doDelete(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Action is to use when ddoDelete requested, to perform deletion corresponding to chef_announcements-delete "eventSubmit_doDelete"

doDelete_announcement_link(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Action is to use when doDelete_announcement_link requested, corresponding to chef_announcements the link of deleting announcement item

doDeleteannouncement(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Action is to use when doDeleteannouncement requested, corresponding to chef_announcements or chef_announcements-metadata menu "Delete"

doLinkcancel(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Action is to use when doLinkcancel requested, corresponding to chef_announcement "eventSubmit_doLinkcancel"

doMerge(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Handle the "Merge" button on the toolbar

doNewannouncement(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Action is to use when doNewannouncement requested, corresponding to chef_announcements menu "New..."

doNext_message(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Responding to the request of going to next message

doOptions(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

doOptionsUpdate(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

This handles the "doUpdate" if we're in a processing an update from the options page.

doPermissions(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Fire up the permissions editor

doPost(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Action is to use when doPost requested, corresponding to chef_announcements-revise or -preview "eventSubmit_doPost"

doPrev_message(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Responding to the request of going to previous message

doPreviewrevise(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Action is to use when doPreviewrevise requested from preview status corresponding to chef_announcements-preview "eventSubmit_doPreviewrevise"

doReorder(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Handle the "Reorder" button on the toolbar

doReorderUpdate(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

This handles the "doUpdate" if we're processing an update from the "reorder" page.

doReviseannouncement(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Action is to use when doReviseannouncement requested, corresponding to chef_announcements the link of any draft announcement item

doReviseannouncementfrommenu(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Action is to use when doReviseannouncementfrommenu requested, corresponding to chef_announcements.vm and -metadata.vm menu "Revise"

doRevisepreview(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Action is to use when doRevisePreview requested, corresponding to chef_announcements-revise "eventSubmit_doRevisePreview" from revise view to preview view

doSavedraft(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Action is to use when doSavedraft requested, corresponding to chef_announcements-preview "eventSubmit_doSavedraft"

doShowmetadata(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

corresponding to chef_announcements doShowMetadata

doSortbychannel(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Do sort by the announcement channel name.

doSortbydate(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Do sort by the date of the announcement.

doSortbyfor(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Do sort by for - grouop/site/public

doSortbyfrom(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Do sort by from - the author

doSortbygroupdescription(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Do sort by group description

doSortbygrouptitle(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Do sort by group title

doSortbymessage_order(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

doSortbypublic(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Do sort by public

doSortbyreleasedate(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

doSortbyretractdate(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

doSortbysubject(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Do sort by subject

doUpdate(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Handles the user clicking on the save button on the page to specify which calendars will be merged into the present schedule.

doView(RunData, Context) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

E

enableObserver(SessionState, boolean) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Enable or disable the observer

ENTITY_PREFIX - Static variable in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

entityExists(String) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

F

findEntityById(String, String) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

findEntityRefs(String[], String[], String[], boolean) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

Unimplemented EntityBroker methods

G

getAnnouncementByID(EntityView, Map<String, Object>) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

message/siteId/EntityID

getAnnouncementHeader() - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

getAnnouncementId() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

getAnnouncements(String, Map<String, Object>, boolean) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

Get the list of announcements for a site (or user site, or !

getAnnouncementsForSite(EntityView, Map<String, Object>) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

site/siteId

getAnnouncementsForUser(EntityView, Map<String, Object>) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

user

getAttachments() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

getAttachments() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get

getAttachProperties(String) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get the attachment properties

getAuthorDisplayName() - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

getBody() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

getBody() - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

getChannelDisplayName() - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

Returns the string that is used to show the channel to the user.

getChannelId() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get the channel id of current state

getCreatedByDisplayName() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

getCreatedOn() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

getCurrentOrder() - Static method in class org.sakaiproject.announcement.tool.AnnouncementAction

getCurrentSortAsc() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

get the current sort property

getCurrentSortedBy() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

get the current sorted by property name

getDelete_messages() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get

getDisplayOptions() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

getEdit() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get edit object

getEditSite() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

getEntities(EntityReference, Search) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

getEntity(EntityReference) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

getEntityPrefix() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

Prefix for this provider

getFileProperties(String) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get the the file properties for uploading

getHandledInputFormats() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

getHandledOutputFormats() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

getHeader() - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

getId() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

getId() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAttachment

getId() - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

getIsListVM() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get the current vm: true - in main list view; false - in other view

getIsNewAnnouncement() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get the status of preview: true - view new created; false - view revised existed

getMessage() - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

getMessageReference() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Returns the currently selected message reference.

getMessagesOfTheDay(EntityView, Map<String, Object>) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

motd

getMoreAttachments() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get

getName() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAttachment

getNumberOfAnnouncements() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Gets the number of announcements that we will show (if the limit is enabled).

getNumberOfCharsPerAnnouncement() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Gets the number of characters that we will show in an announcement (if the limit is enabled).

getNumberOfDaysInThePast() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Gets the number of days in the past for which we will show announcments (if the limit is enabled).

getProperties() - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

getRange() - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

returns the range string

getRef() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAttachment

getReference() - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

getReference(String) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

getSampleEntity() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

getSelectedAttachments() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get

getSiteId() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

getSiteTitle() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

getState(Context, RunData, Class) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Get the proper state for this instance (if portlet is not known, only context).

getState(VelocityPortlet, RunData, Class) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Get the proper state for this instance (if portlet is known).

getState(String, RunData, Class) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Get the proper state for this instance (if portlet id is known).

getStatus() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get the status to be

getTempAnnounceTo() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get

getTempAnnounceToGroups() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get

getTempAttachments() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get

getTempBody() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get

getTempHidden() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

getTemplate(VelocityPortlet, Context, RunData, SessionState, AnnouncementActionState, String) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

getTempMoreAttachments() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get

getTempReleaseDate() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

getTempRetractDate() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

getTempSubject() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get

getTitle() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

getTrimmedBody() - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

getType() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAttachment

getUrl() - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAttachment

getUrl() - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

getUrl(String) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

getVarNameEnforceNumberOfAnnouncementsLimit() - Static method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Gets a variable name for use in Velocity scripts to name input fields, etc.

getVarNameEnforceNumberOfCharsPerAnnouncementLimit() - Static method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Gets a variable name for use in Velocity scripts to name input fields, etc.

getVarNameEnforceNumberOfDaysInPastLimit() - Static method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Gets a variable name for use in Velocity scripts to name input fields, etc.

getVarNameNumberCharsPerAnnouncement() - Static method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Gets a variable name for use in Velocity scripts to name input fields, etc.

getVarNameNumberOfAnnouncements() - Static method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Gets a variable name for use in Velocity scripts to name input fields, etc.

getVarNameNumberOfDaysInPast() - Static method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Gets a variable name for use in Velocity scripts to name input fields, etc.

getVarNameShowAllColumns() - Static method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Gets a variable name for use in Velocity scripts to name input fields, etc.

getVarNameShowAnnouncementBody() - Static method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Gets a variable name for use in Velocity scripts to name input fields, etc.

I

init() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Init to startup values

initState(SessionState, VelocityPortlet, JetspeedRunData) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Populate the state object, if needed.

isEditable() - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

Returns true if the message is editable.

isEnforceNumberOfAnnouncementsLimit() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Returns true if we should limit the number of announcments shown.

isEnforceNumberOfCharsPerAnnouncement() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Returns true if we should limit the number of characters per announcement.

isEnforceNumberOfDaysInThePastLimit() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Returns true if we should limit the announcements displayed based on the number of days in the past on which the occurred.

isShowAllColumns() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Gets whether or not we should show all the columns associated with the announcement.

isShowAnnouncementBody() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Gets whether or not we should show the announcement body.

isShowOnlyOptionsButton() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

L

loadProperties(Map<?, ?>) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Loads properties from a map into our object.

loadProperties(ParameterParser) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Loads properties from a ParameterParser object (usually gotten from a user's page submission).

N

notificationEnabled(AnnouncementActionState) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

is notification enabled?

O

org.sakaiproject.announcement.entityprovider - package org.sakaiproject.announcement.entityprovider

org.sakaiproject.announcement.tool - package org.sakaiproject.announcement.tool

P

postOrSaveDraft(RunData, Context, boolean) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

post or save draft of a message?

R

readAnnouncementForm(RunData, Context, boolean) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Read user inputs in announcement form

readResourcesPage(SessionState, int, int) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

recycle() - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Release any resources and restore the object to initial conditions to be reused.

releaseState(Context, RunData) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Release the proper state for this instance (if portlet is not known, only context).

releaseState(VelocityPortlet, RunData) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Release the proper state for this instance (if portlet is known).

releaseState(String, RunData) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

Release the proper state for this instance (if portlet id is known).

S

saveProperties(Properties) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Saves the properties in this object to a ResourcePropertiesEdit object.

setAnnouncementId(String) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

setAnnouncementService(AnnouncementService) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

setAttachments(List<AnnouncementEntityProviderImpl.DecoratedAttachment>) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

setAttachments(List) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Set

setAttachProperties(String, Vector) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Set the attachProperties

setBody(String) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

setChannelId(String) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Set the chat channel id to listen to.

setCreatedByDisplayName(String) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

setCreatedOn(Date) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

setCurrentSortAsc(boolean) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

set the current sort property

setCurrentSortedBy(String) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

set the current sorted by property name

setDeleteMessages(Vector) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Set

setDisplayOptions(AnnouncementActionState.DisplayOptions) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

setEdit(AnnouncementMessageEdit) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get edit The edit object

setEditSite(Site) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

setEnforceNumberOfAnnouncementsLimit(boolean) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Sets whether or not we should limit the number of announcements displayed.

setEnforceNumberOfCharsPerAnnouncement(boolean) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Sets whether or not we should limit the number of chars per announcement.

setEnforceNumberOfDaysInThePastLimit(boolean) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Sets whether or not we shoud limit the announcements displayed based on the number of days in the past on which they occurred.

setEntityBrokerManager(EntityBrokerManager) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

setEntityManager(EntityManager) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

setFileProperties(String, Vector) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Set the fileProperties

setId(String) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAttachment

setIsListVM(boolean) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Set the current vm: true - in main list view; false - in other view

setIsNewAnnouncement(boolean) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Set the status of preview: true - view new created; false - view revised existed

setMessageReference(String) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Sets the currently selected message reference.

setMoreAttachments(Vector) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Set

setName(String) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAttachment

setNumberOfAnnouncements(int) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Sets the limit on the number of announcements to show (if the limit is enabled).

setNumberOfCharsPerAnnouncement(int) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Sets the number of characters to show per announcement (if the limit is enabled).

setNumberOfDaysInThePast(int) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Sets the number of days in the past for which we will show announcments (if the limit is enabled).

setRange(String) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

Set the range string

setRef(String) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAttachment

setSecurityService(SecurityService) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

setSelectedAttachments(Vector) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Set

setSessionManager(SessionManager) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

setShowAllColumns(boolean) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Sets whether or not we should show all the columns associated with the announcement.

setShowAnnouncementBody(boolean) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Sets whether or not we should show the announcement body.

setShowOnlyOptionsButton(boolean) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

setSiteId(String) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

setSiteService(SiteService) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

setSiteTitle(String) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

setStatus(String) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Set the status to be

setTempAnnounceTo(String) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

set

setTempAnnounceToGroups(Collection) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

set

setTempAttachments(Vector) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Set

setTempBody(String) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get

setTempHidden(Boolean) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

setTempMoreAttachments(Vector) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Set

setTempReleaseDate(Time) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

setTempRetractDate(Time) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

setTempSubject(String) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

Get

setTimeService(TimeService) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

setTitle(String) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAnnouncement

setToolManager(ToolManager) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

setType(String) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAttachment

setUrl(String) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl.DecoratedAttachment

setUserDirectoryService(UserDirectoryService) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

showAnnouncement(EntityView, Map<String, Object>) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

This handles announcements, URLs should be like, /announcement/msg/{context}/{channelId}/{announcementId} an example would be /announcement/msg/21b1984d-af58-43da-8583-f4adee769aa2/main/5641323b-761a-4a4d-8761-688f4928141b .

sizeResources(SessionState) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction

STATE_INITED - Static variable in class org.sakaiproject.announcement.tool.AnnouncementAction

STATE_MESSAGE - Static variable in class org.sakaiproject.announcement.tool.AnnouncementAction

STATE_MESSAGES - Static variable in class org.sakaiproject.announcement.tool.AnnouncementAction

T

toXml(Document, Stack) - Method in class org.sakaiproject.announcement.tool.AnnouncementAction.AnnouncementWrapper

U

update(Observable, Object) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

This method is called whenever the observed object is changed.

updateEntity(EntityReference, Object, Map<String, Object>) - Method in class org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

V

valueBound(SessionBindingEvent) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

SessionBindingListener implementation

valueUnbound(SessionBindingEvent) - Method in class org.sakaiproject.announcement.tool.AnnouncementActionState

A B C D E F G I L N O P R S T U V