info.magnolia.module.workflow.inbox
Class Inbox

java.lang.Object
  info.magnolia.cms.servlets.MVCServletHandlerImpl
      info.magnolia.cms.servlets.CommandBasedMVCServletHandler
          info.magnolia.module.admininterface.PageMVCHandler
              info.magnolia.module.admininterface.TemplatedMVCHandler
                  info.magnolia.module.admininterface.lists.AbstractList
                      info.magnolia.module.workflow.inbox.Inbox

All Implemented Interfaces:

info.magnolia.cms.servlets.MVCServletHandler

public class Inbox
extends info.magnolia.module.admininterface.lists.AbstractList

The AbstractList responsible for displaying a user's inbox, i.e current work items.

Version:

$Revision:3416 $ ($Author:philipp $)

Author:

Philipp Bracher

Field Summary

protected info.magnolia.cms.i18n.Messages

msgs

Fields inherited from class info.magnolia.module.admininterface.PageMVCHandler

COMMAND_PARAMETER_NAME, COMMAND_SHOW, VIEW_SHOW

Fields inherited from class info.magnolia.cms.servlets.MVCServletHandlerImpl

exception, request, response, VIEW_ERROR, VIEW_SUCCESS

Fields inherited from interface info.magnolia.cms.servlets.MVCServletHandler

VIEW_NOTHING

Constructor Summary

Inbox(String name, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Method Summary

String	cancel() Stop the workflow.
void	configureContextMenu(info.magnolia.cms.gui.control.ContextMenu menu)
void	configureFunctionBar(info.magnolia.cms.gui.control.FunctionBar bar) Same as the context menu.
void	configureList(info.magnolia.cms.gui.controlx.list.ListControl list) Sets the select js code and defines the columns.
String	getComment()
String	getFlowItemId()
protected String	getIcon(String path, String repository)
info.magnolia.cms.gui.controlx.list.ListModel	getModel()
protected String	getShowJSFunction(String repository, String path)
String	getSortBy()
boolean	isDebug()
String	onRender() Add some inbox specific stuff: mainly hidden fields.
String	proceed() Proceed the item.
String	reject() Reject the item (adds a comment).
void	setComment(String comment)
void	setDebug(boolean debug)
void	setFlowItemId(String flowItemId)

Methods inherited from class info.magnolia.module.admininterface.lists.AbstractList

addContextMenuItem, getContextMenu, getFunctionBar, getGroupBy, getGroupByOrder, getLanguage, getList, getRenderKit, getSortByOrder, getTemplateName, getURI, initList, onRenderHeader, setFunctionBar, setGroupBy, setGroupByOrder, setList, setSortBy, setSortByOrder, show

Methods inherited from class info.magnolia.module.admininterface.TemplatedMVCHandler

renderHtml

Methods inherited from class info.magnolia.module.admininterface.PageMVCHandler

getForm, getI18nBasename, getMsgs, getParams, init, setForm, setI18nBasename, setMsgs, setParams

Methods inherited from class info.magnolia.cms.servlets.CommandBasedMVCServletHandler

execute, findCommand, getCatalogueName, getCommandContext, getViewNameAfterExecution, setCatalogueName

Methods inherited from class info.magnolia.cms.servlets.MVCServletHandlerImpl

getCommand, getException, getExceptionStackTrace, getName, getRequest, getResponse, populateFromRequest, setCommand, setRequest, setResponse

Methods inherited from class java.lang.Object

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

Field Detail

msgs

protected info.magnolia.cms.i18n.Messages msgs

Constructor Detail

Inbox

public Inbox(String name,
             javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response)

Method Detail

getModel

public info.magnolia.cms.gui.controlx.list.ListModel getModel()

Specified by:

getModel in class info.magnolia.module.admininterface.lists.AbstractList

getSortBy

public String getSortBy()

Overrides:

getSortBy in class info.magnolia.module.admininterface.lists.AbstractList

configureList

public void configureList(info.magnolia.cms.gui.controlx.list.ListControl list)

Sets the select js code and defines the columns.

Specified by:

configureList in class info.magnolia.module.admininterface.lists.AbstractList

getIcon

protected String getIcon(String path,
                         String repository)

getShowJSFunction

protected String getShowJSFunction(String repository,
                                   String path)

configureContextMenu

public void configureContextMenu(info.magnolia.cms.gui.control.ContextMenu menu)

Overrides:

configureContextMenu in class info.magnolia.module.admininterface.lists.AbstractList

configureFunctionBar

public void configureFunctionBar(info.magnolia.cms.gui.control.FunctionBar bar)

Same as the context menu.

Overrides:

configureFunctionBar in class info.magnolia.module.admininterface.lists.AbstractList

onRender

public String onRender()

Add some inbox specific stuff: mainly hidden fields.

Overrides:

onRender in class info.magnolia.module.admininterface.lists.AbstractList

proceed

public String proceed()

Proceed the item.

reject

public String reject()

Reject the item (adds a comment).

cancel

public String cancel()

Stop the workflow.

getFlowItemId

public String getFlowItemId()

setFlowItemId

public void setFlowItemId(String flowItemId)

getComment

public String getComment()

setComment

public void setComment(String comment)

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)