Package 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 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:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected org.imixs.workflow.faces.util.LoginControllerloginController
-
Constructor Summary
Constructors Constructor Description BoardController()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddoLoadNext(BoardCategory category)Loads the next page for a categoryvoiddoLoadPrev(BoardCategory category)Loads the prev page for a categoryList<BoardCategory>getCategories()Returns a list of all workflow groups out of the current worklist.intgetCategoryPageSize()StringgetNext()This method increases the search PageIndex and updates the bookmarkable search link to the worklist including the current search phrase.StringgetPage(int index)intgetPageIndex()NavigationintgetPageMax()intgetPageSize()StringgetPhraseEncoded()StringgetPrev()This method increases the search PageIndex and updates the bookmarkable search link to the worklist including the current search phrase.org.imixs.workflow.ItemCollectiongetProcess()StringgetProcessRef()StringgetTitle()Get the board title.StringgetView()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 phrasebooleanisEndOfList()booleanisEndOfList(BoardCategory category)voidrefresh()This method discards the cache.StringrefreshSearch()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)voidsetTitle(String title)voidsetView(String view)
-
-
-
Method Detail
-
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
public String getProcessRef()
-
setProcessRef
public void setProcessRef(String processRef)
-
getView
public String getView()
-
setView
public void setView(String view)
-
getProcess
public org.imixs.workflow.ItemCollection getProcess()
-
getTitle
public String getTitle()
Get the board title. The default board title is message['worklist.owner']- Returns:
-
setTitle
public void setTitle(String title)
-
getPhraseEncoded
public String 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
public String refreshSearch()
This method resets the search PageIndex to 0 and updates the bookmarkable search link to the worklist including the current search phrase.
-
getNext
public String getNext()
This method increases the search PageIndex and updates the bookmarkable search link to the worklist including the current search phrase.
-
getPrev
public String getPrev()
This method increases the search PageIndex and updates the bookmarkable search link to the worklist including the current search phrase.
-
getPage
public String getPage(int index)
-
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(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()
-
setEndOfList
public void setEndOfList(boolean endOfList)
-
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:
-
isEndOfList
public boolean isEndOfList(BoardCategory category)
-
-