Package com.flowable.workobject.engine.impl.wrapper

Interface NativeEngineWrapper

All Known Implementing Classes:
CmmnEngineWrapper, CompositeEngineWrapper, IdBasedEngineWrapper, ProcessEngineWrapper, TaskEngineWrapper, WorkObjectEngineWrapper
public interface NativeEngineWrapper
Wraps native engines like (@link ProcessEngine), CmmnEngine to provide workObjects

  • Method Summary

    Modifier and Type Method Description
    java.util.Optional<NativeEngineWrapper> accepts​(java.lang.String workObjectId)
    Flag to allow to choose the right wrapper for the given workObject
    void addIdentityLinkToWorkObject​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, java.lang.String workObjectId, java.lang.String userId, java.lang.String groupId, java.lang.String identityLinkType)
    Add identity link to the WorkObject, without params validation
    void deleteIdentityLinkForWorkObject​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, java.lang.String workObjectId, java.lang.String userId, java.lang.String groupId, java.lang.String identityLinkType)
    Delete identity link for the WorkObject
    java.util.List<org.flowable.identitylink.api.history.HistoricIdentityLink> getHistoricIdentityLinksForWorkObject​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, java.lang.String workObjectId)
    Get HistoricIdentityLink for the WorkObject
    HistoricWorkObject getHistoricWorkObjectByIdAndTenant​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, HistoricWorkObjectQuery historicWorkObjectQuery)
    Get historic workObject by given Id
    java.util.List<org.flowable.identitylink.api.IdentityLink> getIdentityLinksForWorkObject​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, java.lang.String workObjectId)
    Get identity links for the WorkObject, without params validation
    java.lang.String getParentId​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, java.lang.String workObjectId)
    Get parent WorkObject identifier
    WorkObject getWorkObject​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, WorkObjectQuery workObjectQuery)
    Get workObject by given id and tenant

  • Method Details

    • accepts

      java.util.Optional<NativeEngineWrapper> accepts​(java.lang.String workObjectId)
      Flag to allow to choose the right wrapper for the given workObject
      Parameters:
      workObjectId - workObject identifier
      Returns:
      optionally returns NativeEngineWrapper which is able to handle request.

    • getHistoricWorkObjectByIdAndTenant

      HistoricWorkObject getHistoricWorkObjectByIdAndTenant​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, HistoricWorkObjectQuery historicWorkObjectQuery)
      Get historic workObject by given Id
      Parameters:
      commandContext - command context under which query is done
      historicWorkObjectQuery - historic workObject query
      Returns:
      native historic object wrapped in the HistoricWorkObject implementation

    • getWorkObject

      WorkObject getWorkObject​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, WorkObjectQuery workObjectQuery)
      Get workObject by given id and tenant
      Parameters:
      commandContext - command context under which query is performed
      workObjectQuery - query to search for
      Returns:
      workObject according to given query.

    • addIdentityLinkToWorkObject

      void addIdentityLinkToWorkObject​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, java.lang.String workObjectId, java.lang.String userId, java.lang.String groupId, java.lang.String identityLinkType)
      Add identity link to the WorkObject, without params validation
      Parameters:
      commandContext - command context under which query is performed
      workObjectId - workObject identifier
      userId - user identifier
      groupId - group identifier
      identityLinkType - identity link type

    • deleteIdentityLinkForWorkObject

      void deleteIdentityLinkForWorkObject​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, java.lang.String workObjectId, java.lang.String userId, java.lang.String groupId, java.lang.String identityLinkType)
      Delete identity link for the WorkObject
      Parameters:
      commandContext - command context under which query is performed
      workObjectId - workObject identifier
      userId - user identifier
      groupId - group identifier
      identityLinkType - identity link type

    • getIdentityLinksForWorkObject

      java.util.List<org.flowable.identitylink.api.IdentityLink> getIdentityLinksForWorkObject​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, java.lang.String workObjectId)
      Get identity links for the WorkObject, without params validation
      Parameters:
      commandContext - command context under which query is performed
      workObjectId - workObject identifier

    • getHistoricIdentityLinksForWorkObject

      java.util.List<org.flowable.identitylink.api.history.HistoricIdentityLink> getHistoricIdentityLinksForWorkObject​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, java.lang.String workObjectId)
      Get HistoricIdentityLink for the WorkObject
      Parameters:
      commandContext - command context under which query is performed
      workObjectId - workObject identifier

    • getParentId

      java.lang.String getParentId​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, java.lang.String workObjectId)
      Get parent WorkObject identifier
      Parameters:
      commandContext - command context under which query is performed
      workObjectId - workObject identifier
      Returns:
      parent workObjectId or null in the case when workObject is null