Package org.imixs.workflow.office.views
Class BoardController
java.lang.Object
org.imixs.workflow.office.views.BoardController
- All Implemented Interfaces:
Serializable
The BoardController provides a logic to split up the worklist by there
workflow groups and status. The board controller 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 property "boardcontroller.pagesize". The default size is 100.
The workitems displayed within ony category are restricted to the property "boardcontroller.categorysize". The default size is 5.
- Version:
- 2.0
- Author:
- rsoika
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.imixs.workflow.faces.util.LoginController -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoiddoLoadNext(BoardCategory category) Loads the next page for a categoryvoiddoLoadPrev(BoardCategory category) Loads the prev page for a categoryReturns a list of all workflow groups out of the current worklist.intgetNext()This method increases the search PageIndex and updates the bookmarkable search link to the worklist including the current search phrase.getPage(int index) intNavigationintintgetPrev()This method increases the search PageIndex and updates the bookmarkable search link to the worklist including the current search phrase.org.imixs.workflow.ItemCollectiongetTitle()Get the board title.getView()List<org.imixs.workflow.ItemCollection>getWorkitems(BoardCategory category) This method returns the current page of workitems for the given category.voidinit()Initialize default behavior initialize the processref, page index and phrasebooleanbooleanisEndOfList(BoardCategory category) voidrefresh()This method discards the cache.This method resets the search PageIndex to 0 and updates the bookmarkable search link to the worklist including the current search phrase.voidreset()This method discards the cache an reset the current ref.voidsetCategoryPageSize(int categoryPageSize) voidsetEndOfList(boolean endOfList) voidsetPageIndex(int pageIndex) voidsetPageSize(int pageSize) voidsetProcessRef(String processRef) voidvoid
-
Field Details
-
loginController
@Inject protected org.imixs.workflow.faces.util.LoginController loginController
-
-
Constructor Details
-
BoardController
public BoardController()
-
-
Method Details
-
init
@PostConstruct public void init()Initialize default behavior initialize the processref, page index and phrase -
getPageIndex
public int getPageIndex()Navigation -
setPageIndex
public void setPageIndex(int pageIndex) -
getPageSize
public int getPageSize() -
setPageSize
public void setPageSize(int pageSize) -
getPageMax
public int getPageMax() -
getProcessRef
-
setProcessRef
-
getView
-
setView
-
getProcess
public org.imixs.workflow.ItemCollection getProcess() -
getTitle
Get the board title. The default board title is message['worklist.owner']- Returns:
-
setTitle
-
getPhraseEncoded
-
reset
public void reset()This method discards the cache an reset the current ref. -
refresh
public void refresh()This method discards the cache. -
refreshSearch
This method resets the search PageIndex to 0 and updates the bookmarkable search link to the worklist including the current search phrase. -
getNext
This method increases the search PageIndex and updates the bookmarkable search link to the worklist including the current search phrase. -
getPrev
This method increases the search PageIndex and updates the bookmarkable search link to the worklist including the current search phrase. -
getPage
-
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
Loads the next page for a category -
doLoadPrev
Loads the prev page for a category -
isEndOfList
public boolean isEndOfList() -
setEndOfList
public void setEndOfList(boolean endOfList) -
getCategoryPageSize
public int getCategoryPageSize() -
setCategoryPageSize
public void setCategoryPageSize(int categoryPageSize) -
getWorkitems
This method returns the current page of workitems for the given category.- Parameters:
category-- Returns:
-
isEndOfList
-