org.imixs.workflow.office.views

Class BoardController

java.lang.Object

org.imixs.workflow.office.views.BoardController

All Implemented Interfaces:

Serializable

@Named
 @ViewScoped
public class BoardController
extends Object
implements Serializable

The BoardController provides a logic to split up the worklist by there workflow groups and status. The board contoler can select a worklist based on a unqiueIdRef or if not defined by the current user (task list).

The controller holds a cache map storing all tasks by workflow group and status.

The number of workitems loaded internally are restricted to the pageSize. The DEFAULT_PAGE_SIZE of 100 can be overwritten by the imixs.property 'boardcontroller.pagesize'

Author:

rsoika

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.imixs.workflow.faces.util.LoginController	loginController

Constructor Summary

Constructors

Constructor and Description
BoardController()

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	doLoadNext(BoardCategory category) Loads the next page for a category
void	doLoadPrev()
void	doLoadPrev(javax.faces.event.ActionEvent event)
void	doLoadPrev(javax.faces.event.AjaxBehaviorEvent event)
void	doLoadPrev(BoardCategory category) Loads the prev page for a category
List<BoardCategory>	getCategories() Returns a list of all workflow groups out of the current worklist.
int	getCategoryPageSize()
int	getPageIndex() Navigation
int	getPageSize()
String	getPhrase()
String	getQuery() This method computes the search query based on the property ref.
String	getRef()
String	getTitle() Get the board title.
String	getView()
List<org.imixs.workflow.ItemCollection>	getWorkitems(BoardCategory category) This method returns the current page of workitems for the given category.
boolean	isEndOfList()
boolean	isEndOfList(BoardCategory category)
void	onWorkflowEvent(org.imixs.workflow.faces.data.WorkflowEvent workflowEvent) WorkflowEvent listener listens to WORKITEM events and reset the result list after changing a workitem.
void	refresh() This method discards the cache.
void	reset() This method discards the cache an reset the current ref.
void	setCategoryPageSize(int categoryPageSize)
void	setEndOfList(boolean endOfList)
void	setPageIndex(int pageIndex)
void	setPageSize(int pageSize)
void	setPhrase(String phrase)
void	setQuery(String query)
void	setRef(String ref)
void	setTitle(String title)
void	setView(String view)

Methods inherited from class java.lang.Object

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

Field Detail

loginController

@Inject
protected org.imixs.workflow.faces.util.LoginController loginController

Constructor Detail

BoardController

public BoardController()

Method Detail

getPageIndex

public int getPageIndex()

Navigation

setPageIndex

public void setPageIndex(int pageIndex)

getPageSize

public int getPageSize()

setPageSize

public void setPageSize(int pageSize)

getRef

public String getRef()

setRef

public void setRef(String ref)

getPhrase

public String getPhrase()

setPhrase

public void setPhrase(String phrase)

getView

public String getView()

setView

public void setView(String view)

getTitle

public String getTitle()

Get the board title. The default board title is message['worklist.owner']

Returns:

setTitle

public void setTitle(String title)

getQuery

public String getQuery()

This method computes the search query based on the property ref. If no ref is defined, the default query selects the task list for the current user.

Returns:

setQuery

public void setQuery(String query)

reset

public void reset()

This method discards the cache an reset the current ref.

refresh

public void refresh()

This method discards the cache.

getCategories

public List<BoardCategory> getCategories()

Returns a list of all workflow groups out of the current worklist. If no worklist is yet selected, the method triggers the method readWorkList();

Returns:

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)

isEndOfList

public boolean isEndOfList()

setEndOfList

public void setEndOfList(boolean endOfList)

onWorkflowEvent

public void onWorkflowEvent(@Observes
                            org.imixs.workflow.faces.data.WorkflowEvent workflowEvent)

WorkflowEvent listener listens to WORKITEM events and reset the result list after changing a workitem.

Parameters:

workflowEvent -

getCategoryPageSize

public int getCategoryPageSize()

setCategoryPageSize

public void setCategoryPageSize(int categoryPageSize)

getWorkitems

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

This method returns the current page of workitems for the given category.

Parameters:

category -

Returns:

doLoadNext

public void doLoadNext(BoardCategory category)

Loads the next page for a category

doLoadPrev

public void doLoadPrev(BoardCategory category)

Loads the prev page for a category

isEndOfList

public boolean isEndOfList(BoardCategory category)