Package org.craftercms.studio.api.v2.dal

Interface SiteDAO

public interface SiteDAO

  • Method Details

    • deleteSiteRelatedItems

      void deleteSiteRelatedItems(@Param("siteId") String siteId)
      Delete site
      Parameters:
      siteId - site identifier

    • startSiteDelete

      void startSiteDelete(@Param("siteId") String siteId)
      Mark the site as DELETING
      Parameters:
      siteId - the site id

    • completeSiteDelete

      void completeSiteDelete(@Param("siteId") String siteId)
      Marks the site as DELETED
      Parameters:
      siteId - the site id

    • exists

      boolean exists(@Param("siteId") String siteId)
      Checks if a non-deleted site exists with the given site id
      Parameters:
      siteId - the site id
      Returns:
      true if the site exists, false otherwise

    • enablePublishing

      void enablePublishing(@Param("siteId") String siteId, @Param("enabled") boolean enabled)
      Enables/disables publishing for the given site
      Parameters:
      siteId - the site id
      enabled - true to enable publishing, false to disable

    • getSite

      Site getSite(@Param("siteId") String siteId)
      Gets the site with the given site id
      Parameters:
      siteId - the site id
      Returns:
      the Site object

    • getLastCommitId

      String getLastCommitId(@Param("siteId") String siteId)
      Get the last commit id for the given site
      Parameters:
      siteId - site id
      Returns:
      the last commit id

    • updateLastCommitId

      void updateLastCommitId(@Param("siteId") String siteId, @Param("commitId") String commitId)
      Update a site's last commit id
      Parameters:
      siteId - site id
      commitId - commit id

    • getSitesByState

      List<Site> getSitesByState(@Param("state") String state)
      Get the sites matching the given state
      Parameters:
      state - the state
      Returns:
      the list of sites