org.osivia.services.editor.common.controller

Class SourceDocumentController

java.lang.Object

org.osivia.services.editor.common.controller.SourceDocumentController

Direct Known Subclasses:

EditorImageSourceDocumentController, EditorLinkSourceDocumentController

public abstract class SourceDocumentController
extends Object

Source document portlet controller abstract super-class.

Author:

Cédric Krommenhoek

Constructor Summary

Constructors

Constructor and Description
SourceDocumentController() Constructor.

Method Summary

Modifier and Type	Method and Description
SourceDocumentForm	getDocumentForm(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response) Get source document form.
protected abstract CommonService	getService() Get portlet service.
void	search(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response, String filter, String scope) Search resource mapping.
void	select(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, String path) Select document action mapping.
String	view() View render mapping.

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceDocumentController

public SourceDocumentController()

Constructor.

Method Detail

getService

protected abstract CommonService getService()

Get portlet service.

Returns:

portlet service

view

@RenderMapping
public String view()

View render mapping.

Returns:

view path

select

@ActionMapping(value="select")
public void select(javax.portlet.ActionRequest request,
                                                  javax.portlet.ActionResponse response,
                                                  @RequestParam(value="path")
                                                  String path)
                                           throws javax.portlet.PortletException,
                                                  IOException

Select document action mapping.

Parameters:

request - action request

response - action response

path - document path request parameter

Throws:

javax.portlet.PortletException

IOException

search

@ResourceMapping(value="search")
public void search(javax.portlet.ResourceRequest request,
                                                    javax.portlet.ResourceResponse response,
                                                    @RequestParam(name="filter",required=false)
                                                    String filter,
                                                    @RequestParam(name="scope",required=false)
                                                    String scope)
                                             throws javax.portlet.PortletException,
                                                    IOException

Search resource mapping.

Parameters:

request - resource request

response - resource response

filter - search filter request parameter

scope - search scope request parameter

Throws:

javax.portlet.PortletException

IOException

getDocumentForm

@ModelAttribute(value="documentForm")
public SourceDocumentForm getDocumentForm(javax.portlet.PortletRequest request,
                                                                                javax.portlet.PortletResponse response)
                                                                         throws javax.portlet.PortletException

Get source document form.

Parameters:

request - portlet request

response - portlet response

Returns:

source document form

Throws:

javax.portlet.PortletException