magoffin.matt.ma2.web
Class BrowseAlbumsController

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.BaseCommandController
                      org.springframework.web.servlet.mvc.AbstractCommandController
                          magoffin.matt.ma2.web.AbstractCommandController
                              magoffin.matt.ma2.web.BrowseAlbumsController

All Implemented Interfaces:

org.springframework.context.ApplicationContextAware, org.springframework.web.servlet.mvc.Controller

public class BrowseAlbumsController
extends AbstractCommandController

Controller for browsing albums.

This serves as a web-based interface to the SearchBiz.findAlbumsForBrowsing(BrowseAlbumsCommand, PaginationCriteria, BizContext) method.

This class looks for registered BrowseModePlugin instances via SystemBiz.getPluginsOfType(Class), and for each plugin returned will create a Metadata instance for each plugin's BrowseModePlugin.getSupportedModes() values, using a key of browse-mode. This allows the view to display a list of options to the user for browsing shared items in any available browse mode.

If the BrowseAlbumsCommand.getSection() value is provided on the request, this value will be set as the PaginationCriteria.setIndexKey(String) value passed to the SearchBiz.findAlbumsForBrowsing(BrowseAlbumsCommand, PaginationCriteria, BizContext) method.

The configurable properties of this class are:

userBiz

The UserBiz implemntation to use.

searchBiz

The SearchBiz implemntation to use.

Version:

$Revision: 52 $ $Date: 2007-11-08 18:53:52 +1300 (Thu, 08 Nov 2007) $

Author:

Matt Magoffin (spamsqr@msqr.us)

Field Summary

Fields inherited from class magoffin.matt.ma2.web.AbstractCommandController

HTTP_USER_AGENT_HEADER

Fields inherited from class org.springframework.web.servlet.mvc.BaseCommandController

DEFAULT_COMMAND_NAME

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

HEADER_CACHE_CONTROL, HEADER_EXPIRES, HEADER_PRAGMA, METHOD_GET, METHOD_HEAD, METHOD_POST

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

logger

Constructor Summary

BrowseAlbumsController()

Method Summary

protected java.lang.Object	getCommand(javax.servlet.http.HttpServletRequest request)
SearchBiz	getSearchBiz()
UserBiz	getUserBiz()
protected org.springframework.web.servlet.ModelAndView	handle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object command, org.springframework.validation.BindException errors)
void	setSearchBiz(SearchBiz searchBiz)
void	setUserBiz(UserBiz userBiz)

Methods inherited from class magoffin.matt.ma2.web.AbstractCommandController

getDomainObjectFactory, getErrorView, getMessagesSource, getSuccessView, getSystemBiz, getWebHelper, initApplicationContext, registerCalendarEditor, setDomainObjectFactory, setErrorView, setMessagesSource, setSuccessView, setSystemBiz, setWebHelper

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

handleRequestInternal

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

bindAndValidate, checkCommand, createBinder, createCommand, getBindingErrorProcessor, getCommandClass, getCommandName, getMessageCodesResolver, getPropertyEditorRegistrars, getValidator, getValidators, initBinder, isValidateOnBinding, onBind, onBind, onBindAndValidate, setBindingErrorProcessor, setCommandClass, setCommandName, setMessageCodesResolver, setPropertyEditorRegistrar, setPropertyEditorRegistrars, setValidateOnBinding, setValidator, setValidators, suppressBinding, suppressValidation

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, isRequireSession, isUseCacheControlHeader, isUseExpiresHeader, preventCaching, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseExpiresHeader

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

getServletContext, getTempDir, getWebApplicationContext, isContextRequired

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

getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

BrowseAlbumsController

public BrowseAlbumsController()

Method Detail

getCommand

protected java.lang.Object getCommand(javax.servlet.http.HttpServletRequest request)
                               throws java.lang.Exception

Overrides:

getCommand in class org.springframework.web.servlet.mvc.BaseCommandController

Throws:

java.lang.Exception

handle

protected org.springframework.web.servlet.ModelAndView handle(javax.servlet.http.HttpServletRequest request,
                                                              javax.servlet.http.HttpServletResponse response,
                                                              java.lang.Object command,
                                                              org.springframework.validation.BindException errors)
                                                       throws java.lang.Exception

Specified by:

handle in class org.springframework.web.servlet.mvc.AbstractCommandController

Throws:

java.lang.Exception

getUserBiz

public UserBiz getUserBiz()

Returns:

the userBiz

setUserBiz

public void setUserBiz(UserBiz userBiz)

Parameters:

userBiz - the userBiz to set

getSearchBiz

public SearchBiz getSearchBiz()

Returns:

the searchBiz

setSearchBiz

public void setSearchBiz(SearchBiz searchBiz)

Parameters:

searchBiz - the searchBiz to set