org.kuali.rice.ken.web.spring

Class SendEventNotificationMessageController

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.mvc.AbstractController

org.springframework.web.servlet.mvc.multiaction.MultiActionController

org.kuali.rice.ken.web.spring.BaseSendNotificationController

org.kuali.rice.ken.web.spring.SendEventNotificationMessageController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller, org.springframework.web.servlet.mvc.LastModified

public class SendEventNotificationMessageController
extends BaseSendNotificationController

This class is the controller for sending Event notification messages via an end user interface.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

Fields inherited from class org.kuali.rice.ken.web.spring.BaseSendNotificationController

dataObjectService, notificationChannelService, notificationMessageContentService, notificationRecipientService, notificationService, notificationWorkflowDocService

Fields inherited from class org.springframework.web.servlet.mvc.multiaction.MultiActionController

DEFAULT_COMMAND_NAME, LAST_MODIFIED_METHOD_SUFFIX, PAGE_NOT_FOUND_LOG_CATEGORY, pageNotFoundLogger

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

Constructors

Constructor and Description
SendEventNotificationMessageController()

Method Summary

Methods

Modifier and Type	Method and Description
protected NotificationBo	createNotification(javax.servlet.http.HttpServletRequest request, Map<String,Object> model, ErrorList errors) Provides an overridable method in which to customize a created NotificationBo instance.
org.springframework.web.servlet.ModelAndView	sendEventNotificationMessage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles the display of the form for sending a event notification message.
protected Map<String,Object>	setupModelForSendNotification(javax.servlet.http.HttpServletRequest request) Prepares the model used for sending the notification.
org.springframework.web.servlet.ModelAndView	submitEventNotificationMessage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles submitting the actual event notification message.

Methods inherited from class org.kuali.rice.ken.web.spring.BaseSendNotificationController

createNotificationWorkflowDocument, getDate, getGroupService, getIdentityService, getNamespaceService, getParameter, getParameter, getParameterList, getPrincipalIdFromIdOrName, isUserRecipientValid, isWorkgroupRecipientValid, parseCommaSeparatedValues, parseUserRecipients, parseWorkgroupNamespaceCodes, parseWorkgroupRecipients, populateNotificationInstance, setDataObjectService, setNotificationChannelService, setNotificationMessageContentService, setNotificationRecipientService, setNotificationService, setNotificationWorkflowDocumentService, submitNotificationMessage

Methods inherited from class org.springframework.web.servlet.mvc.multiaction.MultiActionController

bind, createBinder, getCommandName, getExceptionHandler, getLastModified, getMethodNameResolver, getValidators, getWebBindingInitializer, handleNoSuchRequestHandlingMethod, handleRequestInternal, initBinder, invokeNamedMethod, newCommandObject, setDelegate, setMethodNameResolver, setValidators, setWebBindingInitializer

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SendEventNotificationMessageController

public SendEventNotificationMessageController()

Method Detail

sendEventNotificationMessage

public org.springframework.web.servlet.ModelAndView sendEventNotificationMessage(javax.servlet.http.HttpServletRequest request,
                                                                        javax.servlet.http.HttpServletResponse response)
                                                                          throws javax.servlet.ServletException,
                                                                                 IOException

Handles the display of the form for sending a event notification message.

Parameters:

request - : a servlet request

response - the servlet response

Returns:

the next view to move to

Throws:

javax.servlet.ServletException

IOException

submitEventNotificationMessage

public org.springframework.web.servlet.ModelAndView submitEventNotificationMessage(javax.servlet.http.HttpServletRequest request,
                                                                          javax.servlet.http.HttpServletResponse response)
                                                                            throws javax.servlet.ServletException,
                                                                                   IOException

Handles submitting the actual event notification message.

Parameters:

request - the servlet request

response - the servlet response

Returns:

the next view to move to

Throws:

javax.servlet.ServletException

IOException

setupModelForSendNotification

protected Map<String,Object> setupModelForSendNotification(javax.servlet.http.HttpServletRequest request)

Prepares the model used for sending the notification. Populates values pertaining to an event notification message.

Overrides:

setupModelForSendNotification in class BaseSendNotificationController

Parameters:

request - the servlet request

Returns:

the Spring MVC model

createNotification

protected NotificationBo createNotification(javax.servlet.http.HttpServletRequest request,
                                Map<String,Object> model,
                                ErrorList errors)
                                     throws ErrorList

Provides an overridable method in which to customize a created NotificationBo instance. Overrides to set the content type to "event" and add extra attributes.

Overrides:

createNotification in class BaseSendNotificationController

Parameters:

request - the servlet request

model - the Spring MVC model

errors - the error list

Returns:

a new notification

Throws:

ErrorList