Package com.logicaldoc.workflow.history

Interface WorkflowHistoryDAO

All Superinterfaces:
com.logicaldoc.core.PersistentObjectDAO<WorkflowHistory>
All Known Implementing Classes:
HibernateWorkflowHistoryDAO
public interface WorkflowHistoryDAO extends com.logicaldoc.core.PersistentObjectDAO<WorkflowHistory>

  • Field Summary

    Fields inherited from interface com.logicaldoc.core.PersistentObjectDAO

    ENTITY

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cleanOldHistories(int ttl)
    This method deletes all the workflow history entries oldest than the given days from now.
    void
    deleteByInstanceid(String instanceId)
    Deletes the histories of the specified instance.
    List<WorkflowHistory>
    findByInstanceId(String instanceId, String event)
    This method selects all histories of a given instanceId.
    List<WorkflowHistory>
    findByTemplateIdAndInstanceId(Long templateId, String instanceId, String event)
    This method selects all histories of a template with the given templateId and of a instance with the given instanceId.
    List<WorkflowHistory>
    findByUserIdAndInstanceId(Long userId, String instanceId, String event)
    This method selects all histories of a template with the given templateId and of a instance with the given instanceId.
    List<String>
    findInstanceIds()
    Get all instances identifiers
    List<Long>
    findTemplateIds()
    Get all template identifiers

    Methods inherited from interface com.logicaldoc.core.PersistentObjectDAO

    bulkUpdate, delete, delete, deleteAll, deleteAll, findAll, findAll, findAllIds, findAllIds, findById, findById, findByObjectQuery, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDatabaseMetadata, getDbms, initialize, isOracle, jdbcUpdate, jdbcUpdate, query, query, queryForDouble, queryForDouble, queryForInt, queryForList, queryForList, queryForList, queryForLong, queryForLong, queryForObject, queryForRowSet, queryForRowSet, queryForString, store

  • Method Details

    • findByTemplateIdAndInstanceId

      List<WorkflowHistory> findByTemplateIdAndInstanceId(Long templateId, String instanceId, String event) throws com.logicaldoc.core.PersistenceException
      This method selects all histories of a template with the given templateId and of a instance with the given instanceId.
      Parameters:
      templateId - The Workflow Persistence Template Id
      instanceId - The Workflow Instance Id
      event - Optional selector of the event
      Returns:
      list of histories ordered by last modified date
      Throws:
      com.logicaldoc.core.PersistenceException - Error in the database

    • findByUserIdAndInstanceId

      List<WorkflowHistory> findByUserIdAndInstanceId(Long userId, String instanceId, String event) throws com.logicaldoc.core.PersistenceException
      This method selects all histories of a template with the given templateId and of a instance with the given instanceId.
      Parameters:
      userId - The user that interacted with the WF
      instanceId - The Workflow Instance Id
      event - Optional selector of the event
      Returns:
      list of histories ordered by last modified date
      Throws:
      com.logicaldoc.core.PersistenceException - Error in the database

    • findByInstanceId

      List<WorkflowHistory> findByInstanceId(String instanceId, String event) throws com.logicaldoc.core.PersistenceException
      This method selects all histories of a given instanceId.
      Parameters:
      instanceId - The Workflow Instance Id
      event - Optional selector of the event
      Returns:
      list of histories ordered by last modified date
      Throws:
      com.logicaldoc.core.PersistenceException - Error in the database

    • deleteByInstanceid

      void deleteByInstanceid(String instanceId) throws com.logicaldoc.core.PersistenceException
      Deletes the histories of the specified instance.
      Parameters:
      instanceId - identifier of the workflow instance
      Throws:
      com.logicaldoc.core.PersistenceException - Error in the database

    • findInstanceIds

      List<String> findInstanceIds() throws com.logicaldoc.core.PersistenceException
      Get all instances identifiers
      Returns:
      list of identifiers
      Throws:
      com.logicaldoc.core.PersistenceException - Error in the database

    • findTemplateIds

      List<Long> findTemplateIds() throws com.logicaldoc.core.PersistenceException
      Get all template identifiers
      Returns:
      list of identifiers
      Throws:
      com.logicaldoc.core.PersistenceException - Error in the database

    • cleanOldHistories

      void cleanOldHistories(int ttl) throws com.logicaldoc.core.PersistenceException
      This method deletes all the workflow history entries oldest than the given days from now. If ttl is 0 or -1, the cancellation is not made.
      Parameters:
      ttl - The maximum number of days over which the history is considered old
      Throws:
      com.logicaldoc.core.PersistenceException - Error in the database