Package org.imixs.workflow.office.forms

Class HistoryController

java.lang.Object
org.imixs.workflow.office.forms.HistoryController
All Implemented Interfaces:
Serializable
@Named @SessionScoped public class HistoryController extends Object implements Serializable
The HistoryController provides a history navigation over workItems the user has selected. There for the controller listens to the events of the WokflowController. The history workItems containing only the $uniqueid and a minimum of attributes to display a summary.
Author:
rsoika
See Also:

  • Field Details

    • workflowController

      @Inject protected org.imixs.workflow.faces.data.WorkflowController workflowController

    • documentService

      protected org.imixs.workflow.engine.DocumentService documentService

  • Constructor Details

    • HistoryController

      public HistoryController()

  • Method Details

    • getCurrentId

      public String getCurrentId()

    • setCurrentId

      public void setCurrentId(String currentId)

    • getWorkitems

      public List<org.imixs.workflow.ItemCollection> getWorkitems()
      retuns a list of all workites curently visited
      Returns:

    • removeWorkitem

      public String removeWorkitem(String aID)
      The action method removes a workItem from the history list. If the current workItem was removed the method switches automatically to the next workItem in the history list. If the list is empty the method returns the action 'home'. Otherwise it returns action ''.
      Parameters:
      id - - $UniqueID
      action - - default action
      Returns:
      action

    • closeCurrentWorkitem

      public void closeCurrentWorkitem(jakarta.faces.event.ActionEvent event)
      This action listener removes the current WorkItem from the history navigation and reset the workitem form the workflowcontroller.
      Parameters:
      aWorkitem -

    • onWorkflowEvent

      public void onWorkflowEvent(@Observes org.imixs.workflow.faces.data.WorkflowEvent workflowEvent)
      WorkflowEvent listener listens to WORKITEM events and adds or removes the current WorkItem from the history nav. If a WorkItem was processed (WORKITEM_AFTER_PROCESS), and the property 'action' is 'home' or 'notes' then the WorkItem will be removed from the history If a WorkItem was soft deleted (WORKITEM_AFTER_SOFTDELETE), the WorkItem will be removed from the history
      Parameters:
      workflowEvent -