Package org.craftercms.studio.api.v2.service.workflow.internal

Interface WorkflowServiceInternal

All Known Implementing Classes:
WorkflowServiceInternalImpl
public interface WorkflowServiceInternal

  • Method Details

    • getWorkflowItem

      WorkflowItem getWorkflowItem(String siteId, String path, String state)

    • getWorkflowEntry

      WorkflowItem getWorkflowEntry(String siteId, String path)
      Get workflow entry
      Parameters:
      siteId -
      path -
      Returns:

    • getWorkflowEntryForApproval

      Workflow getWorkflowEntryForApproval(Long itemId)
      Get workflow entry for approval
      Parameters:
      itemId - item identifier
      Returns:

    • getWorkflowEntry

      Workflow getWorkflowEntry(String siteId, String path, String publishingPackageId)
      Get workflow entry
      Parameters:
      siteId -
      path -
      publishingPackageId -
      Returns:

    • insertWorkflow

      void insertWorkflow(Workflow workflow)
      insert new workflow entry
      Parameters:
      workflow - workflow entry

    • insertWorkflowEntries

      void insertWorkflowEntries(List<Workflow> workflowEntries)
      insert new workflow entries
      Parameters:
      workflowEntries - list of workflow entries

    • updateWorkflow

      void updateWorkflow(Workflow workflow)
      Update new workflow entry
      Parameters:
      workflow - workflow entry

    • getSubmittedItems

      List<WorkflowItem> getSubmittedItems(String site)
      Get submitted items for site
      Parameters:
      site - site identifier
      Returns:

    • deleteWorkflowEntries

      void deleteWorkflowEntries(String site, Collection<String> paths)
      Delete workflow entries for given site and paths
      Parameters:
      site - site identifier
      paths - list of paths to delete workflow

    • deleteWorkflowEntries

      void deleteWorkflowEntries(String site, Collection<String> paths, String workflowState)
      Delete workflow entries for given site and paths matching the workflow state
      Parameters:
      site - site identifier
      paths - list of paths to delete workflow
      workflowState - workflow state to match

    • deleteWorkflowEntry

      void deleteWorkflowEntry(String site, String path)
      Delete workflow entry for given site and path
      Parameters:
      site - site identifier
      path - path to delete workflow

    • deleteWorkflowEntriesForSite

      void deleteWorkflowEntriesForSite(long siteId)
      Delete workflow entries for given site
      Parameters:
      siteId - site id

    • getContentPendingApprovalTotal

      int getContentPendingApprovalTotal(String siteId)
      Get total number of workflow packages pending approval
      Parameters:
      siteId - site identifier
      Returns:
      total number of workflow packages

    • getContentPendingApproval

      List<DashboardPublishingPackage> getContentPendingApproval(String siteId, int offset, int limit)
      Get workflow packages pending approval
      Parameters:
      siteId - site identifier
      offset - offset of the first record in the result
      limit - limit number of records in the result
      Returns:
      list of workflow packages

    • getContentPendingApprovalDetail

      List<Workflow> getContentPendingApprovalDetail(String siteId, String packageId)
      Get items from workflow package pending approval
      Parameters:
      siteId - site identifier
      packageId - workflow package identifier
      Returns:
      list of workflow entries

    • getWorkflowAffectedPaths

      Collection<String> getWorkflowAffectedPaths(String siteId, String path) throws ServiceLayerException
      Get workflow affected paths if content is edited
      Parameters:
      siteId - site identifier
      path - path of the content to be edited
      Returns:
      List of sandbox items that will be taken out of workflow after edit
      Throws:
      ServiceLayerException

    • getWorkflowHardDeps

      Collection<String> getWorkflowHardDeps(String siteId, String path) throws ServiceLayerException
      Get the path hard dependencies that are currently in workflow
      Parameters:
      siteId - the site identifier
      path - the path to get hard dependencies for
      Returns:
      collection of paths that are hard dependencies of path and are in workflow
      Throws:
      ServiceLayerException - if an error occurs while getting the hard dependencies

    • deleteWorkflowPackages

      void deleteWorkflowPackages(String siteId, Collection<String> affectedPackages)
      Delete workflow packages matching the affected package ids
      Parameters:
      siteId - the site identifier
      affectedPackages - the affected package ids to delete