Package org.exoplatform.portal.mop.page

Interface PageService

All Known Subinterfaces:
PageStorage
@Deprecated(forRemoval=true, since="6.5") public interface PageService
Deprecated, for removal: This API element is subject to removal in a future version.
use PageStorage instead since this is a storage layer and the name is ambiguous

The page service manages the page objects in GateIn, it focus on the page entities and does not provide access to the underlying page layout associated with the page.

Author:
Julien Viet

  • Method Summary

    Modifier and Type
    Method
    Description
    PageContext
    clone(PageKey src, PageKey dst)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Clone a page.
    boolean
    destroyPage(PageKey key)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Destroy a page.
    boolean
    destroyPages(SiteKey siteKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Deletes Pages of a given site
    QueryResult<PageContext>
    findPages(int offset, int limit, SiteType siteType, String siteName, String pageName, String pageTitle)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Query the page service to find pages that match the siteType, siteName, pageName and title criterions.
    Page
    getPage(String pageKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Page
    getPage(PageKey pageKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    PageData
    getPage(PageKey key)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Retrieves page data switch given key
    PageContext
    loadPage(PageKey key)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Find and returns a page, if no such page exist, null is returned.
    List<PageContext>
    loadPages(SiteKey siteKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    save(PageData page)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Saves a page.
    boolean
    savePage(PageContext page)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create, update a page.

  • Method Details

    • loadPage

      PageContext loadPage(PageKey key) throws NullPointerException, PageServiceException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find and returns a page, if no such page exist, null is returned.
      Parameters:
      key - the page key
      Returns:
      the matching page
      Throws:
      NullPointerException - if the key is null
      PageServiceException - anything that would prevent the operation to succeed

    • loadPages

      List<PageContext> loadPages(SiteKey siteKey) throws NullPointerException, PageServiceException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      NullPointerException
      PageServiceException

    • savePage

      boolean savePage(PageContext page) throws NullPointerException, PageServiceException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create, update a page. When the page state is not null, the page will be created or updated depending on whether or not the page already exists.
      Parameters:
      page - the page
      Returns:
      true if the page is not already existed, otherwise return false.
      Throws:
      NullPointerException - if the key is null
      PageServiceException - anything that would prevent the operation to succeed

    • destroyPage

      boolean destroyPage(PageKey key) throws PageServiceException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Destroy a page.
      Parameters:
      key - the page key
      Returns:
      true when the page was destroyed
      Throws:
      PageServiceException - anything that would prevent the operation to succeed

    • destroyPages

      boolean destroyPages(SiteKey siteKey)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deletes Pages of a given site
      Parameters:
      siteKey - SiteKey
      Returns:
      true if deleted, else false

    • clone

      PageContext clone(PageKey src, PageKey dst) throws PageServiceException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Clone a page.
      Parameters:
      src - the source key
      dst - the destination key
      Returns:
      the cloned page
      Throws:
      PageServiceException - anything that would prevent the operation to succeed

    • findPages

      QueryResult<PageContext> findPages(int offset, int limit, SiteType siteType, String siteName, String pageName, String pageTitle) throws PageServiceException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Query the page service to find pages that match the siteType, siteName, pageName and title criterions.
      Parameters:
      offset - the query offset
      limit - the query limit
      siteType - the site type
      siteName - the site name
      pageName - the page name
      pageTitle - the page title
      Returns:
      the query result
      Throws:
      PageServiceException - anything that would prevent the operation to succeed

    • save

      void save(PageData page)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Saves a page. If a page with the same id already exists then a merge operation will occur, otherwise it throws IllegalStateException From PLF 5.3.x (RDBMS implementation) we drop support return the change list as it's not used any where. So the method always return the empty list.
      Parameters:
      page - the page to save

    • getPage

      PageData getPage(PageKey key)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves page data switch given key
      Parameters:
      key - PageKey
      Returns:
      PageData

    • getPage

      Page getPage(String pageKey)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getPage

      Page getPage(PageKey pageKey)
      Deprecated, for removal: This API element is subject to removal in a future version.