org.imixs.workflow.jee.faces.workitem

Class ViewController

java.lang.Object

org.imixs.workflow.jee.faces.workitem.ViewController

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

WorklistController

public class ViewController
extends Object
implements Serializable

The ViewController can be used in JSF Applications to manage lists of ItemCollections. The view property defines the view type returned by a method call of getWorkitems. The ViewController implements a lazy loading mechanism to cache the result. The request is delegated to an instance of IViewAdapter to compute the result set. IViewAdapter can be adapted by any custom implementation. The ViewController bean should be used in ViewScope.

Version:

0.0.1

Author:

rsoika

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ViewController.ViewAdapter

Constructor Summary

Constructors

Constructor and Description
ViewController()

Method Summary

Modifier and Type	Method and Description
void	doLoadNext()
void	doLoadNext(javax.faces.event.ActionEvent event)
void	doLoadNext(javax.faces.event.AjaxBehaviorEvent event)
void	doLoadPrev()
void	doLoadPrev(javax.faces.event.ActionEvent event)
void	doLoadPrev(javax.faces.event.AjaxBehaviorEvent event)
void	doRefresh() refreshes the current workitem list. so the list will be loaded again.
void	doRefresh(javax.faces.event.ActionEvent event)
void	doRefresh(javax.faces.event.AjaxBehaviorEvent event)
void	doReset() resets the current result and set the page pointer to 0.
void	doReset(javax.faces.event.ActionEvent event)
void	doReset(javax.faces.event.AjaxBehaviorEvent event)
EntityService	getEntityService() returns an instance of the EntityService EJB
int	getMaxResult() returns the maximum size of a search result
int	getRow() Navigation
String	getType() set the value for the attribute 'type' of a workitem to be generated or search by this controller
String	getView() Current view
IViewAdapter	getViewAdapter()
Map<String,String>	getViews() A map with containing a list of JPQL definitions.
List<org.imixs.workflow.ItemCollection>	getWorkitems() Returns the current view result.
void	init() This method is preparing the JPQL statements. views can also be set in the faces-config.xml
boolean	isEndOfList()
void	setEndOfList(boolean endOfList)
void	setMaxResult(int searchCount) set the maximum size of a search result
void	setType(String type) defines the type attribute of a workitem to be generated or search by this controller Subclasses may overwrite the type
void	setView(String view)
void	setViewAdapter(IViewAdapter viewAdapter)
void	setViews(Map<String,String> views)
void	setWorkitems(List<org.imixs.workflow.ItemCollection> workitems)

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewController

public ViewController()

Method Detail

init

@PostConstruct
public void init()

This method is preparing the JPQL statements. views can also be set in the faces-config.xml

getEntityService

public EntityService getEntityService()

returns an instance of the EntityService EJB

Returns:

getType

public String getType()

set the value for the attribute 'type' of a workitem to be generated or search by this controller

setType

public void setType(String type)

defines the type attribute of a workitem to be generated or search by this controller Subclasses may overwrite the type

Parameters:

type -

getViews

public Map<String,String> getViews()

A map with containing a list of JPQL definitions. The property 'view' defines the actual view.

Returns:

setViews

public void setViews(Map<String,String> views)

getView

public String getView()

Current view

Returns:

setView

public void setView(String view)

getMaxResult

public int getMaxResult()

returns the maximum size of a search result

Returns:

setMaxResult

public void setMaxResult(int searchCount)

set the maximum size of a search result

Parameters:

searchCount -

doReset

public void doReset()

resets the current result and set the page pointer to 0.

doReset

public void doReset(javax.faces.event.ActionEvent event)

doReset

public void doReset(javax.faces.event.AjaxBehaviorEvent event)

doRefresh

public void doRefresh()

refreshes the current workitem list. so the list will be loaded again. but start pos will not be changed!

doRefresh

public void doRefresh(javax.faces.event.ActionEvent event)

doRefresh

public void doRefresh(javax.faces.event.AjaxBehaviorEvent event)

doLoadNext

public void doLoadNext()

doLoadNext

public void doLoadNext(javax.faces.event.ActionEvent event)

doLoadNext

public void doLoadNext(javax.faces.event.AjaxBehaviorEvent event)

doLoadPrev

public void doLoadPrev()

doLoadPrev

public void doLoadPrev(javax.faces.event.ActionEvent event)

doLoadPrev

public void doLoadPrev(javax.faces.event.AjaxBehaviorEvent event)

getWorkitems

public List<org.imixs.workflow.ItemCollection> getWorkitems()

Returns the current view result. The request is delegated to an implementation of IViewAdapter. The method implements a lazy loading mechanism and caches the result locally. The returned result set is defined by the current view definition. The view definition can be set by the property view. All view definitions are stored in the property views. The ViewAdapter implements the behavior to return a collection of ItemCollections based on the current view type

Returns:

view result

setWorkitems

public void setWorkitems(List<org.imixs.workflow.ItemCollection> workitems)

getRow

public int getRow()

Navigation

isEndOfList

public boolean isEndOfList()

setEndOfList

public void setEndOfList(boolean endOfList)

getViewAdapter

public IViewAdapter getViewAdapter()

setViewAdapter

public void setViewAdapter(IViewAdapter viewAdapter)