Package org.bonitasoft.engine.api.impl

Class PageAPIImpl

  • All Implemented Interfaces:
    org.bonitasoft.engine.api.PageAPI
    public class PageAPIImpl
extends java.lang.Object
implements org.bonitasoft.engine.api.PageAPI

    • Constructor Summary

      Constructors 
      Constructor Description
      PageAPIImpl()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.bonitasoft.engine.page.Page createPage​(java.lang.String contentName, byte[] content)  
      org.bonitasoft.engine.page.Page createPage​(org.bonitasoft.engine.page.PageCreator pageCreator, byte[] content)  
      void deletePage​(long pageId)  
      void deletePages​(java.util.List<java.lang.Long> pageIds)  
      org.bonitasoft.engine.page.Page getPage​(long pageId)  
      protected PageAPIDelegate getPageAPIDelegate()  
      org.bonitasoft.engine.page.Page getPageByName​(java.lang.String name)  
      org.bonitasoft.engine.page.Page getPageByNameAndProcessDefinitionId​(java.lang.String name, long processDefinitionId)  
      byte[] getPageContent​(long pageId)  
      java.util.Properties getPageProperties​(byte[] content, boolean checkIfItAlreadyExists)  
      protected TenantServiceAccessor getTenantAccessor()  
      org.bonitasoft.engine.page.PageURL resolvePageOrURL​(java.lang.String key, java.util.Map<java.lang.String,​java.io.Serializable> context, boolean executeAuthorizationRules)  
      org.bonitasoft.engine.search.SearchResult<org.bonitasoft.engine.page.Page> searchPages​(org.bonitasoft.engine.search.SearchOptions searchOptions)  
      org.bonitasoft.engine.page.Page updatePage​(long pageId, org.bonitasoft.engine.page.PageUpdater pageUpdater)  
      void updatePageContent​(long pageId, byte[] content)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PageAPIImpl

        public PageAPIImpl()

    • Method Detail

      • getPage

        public org.bonitasoft.engine.page.Page getPage​(long pageId)
                                        throws org.bonitasoft.engine.page.PageNotFoundException
        Specified by:
        getPage in interface org.bonitasoft.engine.api.PageAPI
        Throws:
        org.bonitasoft.engine.page.PageNotFoundException

      • getPageContent

        public byte[] getPageContent​(long pageId)
                      throws org.bonitasoft.engine.page.PageNotFoundException
        Specified by:
        getPageContent in interface org.bonitasoft.engine.api.PageAPI
        Throws:
        org.bonitasoft.engine.page.PageNotFoundException

      • searchPages

        public org.bonitasoft.engine.search.SearchResult<org.bonitasoft.engine.page.Page> searchPages​(org.bonitasoft.engine.search.SearchOptions searchOptions)
                                                                                       throws org.bonitasoft.engine.exception.SearchException
        Specified by:
        searchPages in interface org.bonitasoft.engine.api.PageAPI
        Throws:
        org.bonitasoft.engine.exception.SearchException

      • createPage

        public org.bonitasoft.engine.page.Page createPage​(org.bonitasoft.engine.page.PageCreator pageCreator,
                                                  byte[] content)
                                           throws org.bonitasoft.engine.exception.CreationException
        Specified by:
        createPage in interface org.bonitasoft.engine.api.PageAPI
        Throws:
        org.bonitasoft.engine.exception.CreationException

      • createPage

        public org.bonitasoft.engine.page.Page createPage​(java.lang.String contentName,
                                                  byte[] content)
                                           throws org.bonitasoft.engine.exception.CreationException
        Specified by:
        createPage in interface org.bonitasoft.engine.api.PageAPI
        Throws:
        org.bonitasoft.engine.exception.CreationException

      • deletePage

        public void deletePage​(long pageId)
                throws org.bonitasoft.engine.exception.DeletionException
        Specified by:
        deletePage in interface org.bonitasoft.engine.api.PageAPI
        Throws:
        org.bonitasoft.engine.exception.DeletionException

      • deletePages

        public void deletePages​(java.util.List<java.lang.Long> pageIds)
                 throws org.bonitasoft.engine.exception.DeletionException
        Specified by:
        deletePages in interface org.bonitasoft.engine.api.PageAPI
        Throws:
        org.bonitasoft.engine.exception.DeletionException

      • getPageByName

        public org.bonitasoft.engine.page.Page getPageByName​(java.lang.String name)
                                              throws org.bonitasoft.engine.page.PageNotFoundException
        Specified by:
        getPageByName in interface org.bonitasoft.engine.api.PageAPI
        Throws:
        org.bonitasoft.engine.page.PageNotFoundException

      • getPageByNameAndProcessDefinitionId

        public org.bonitasoft.engine.page.Page getPageByNameAndProcessDefinitionId​(java.lang.String name,
                                                                           long processDefinitionId)
                                                                    throws org.bonitasoft.engine.page.PageNotFoundException
        Specified by:
        getPageByNameAndProcessDefinitionId in interface org.bonitasoft.engine.api.PageAPI
        Throws:
        org.bonitasoft.engine.page.PageNotFoundException

      • updatePage

        public org.bonitasoft.engine.page.Page updatePage​(long pageId,
                                                  org.bonitasoft.engine.page.PageUpdater pageUpdater)
                                           throws org.bonitasoft.engine.exception.UpdateException,
                                                  org.bonitasoft.engine.exception.AlreadyExistsException
        Specified by:
        updatePage in interface org.bonitasoft.engine.api.PageAPI
        Throws:
        org.bonitasoft.engine.exception.UpdateException
        org.bonitasoft.engine.exception.AlreadyExistsException

      • updatePageContent

        public void updatePageContent​(long pageId,
                              byte[] content)
                       throws org.bonitasoft.engine.exception.UpdateException
        Specified by:
        updatePageContent in interface org.bonitasoft.engine.api.PageAPI
        Throws:
        org.bonitasoft.engine.exception.UpdateException

      • getPageProperties

        public java.util.Properties getPageProperties​(byte[] content,
                                              boolean checkIfItAlreadyExists)
                                       throws org.bonitasoft.engine.exception.InvalidPageTokenException,
                                              org.bonitasoft.engine.exception.AlreadyExistsException,
                                              org.bonitasoft.engine.exception.InvalidPageZipMissingPropertiesException,
                                              org.bonitasoft.engine.exception.InvalidPageZipMissingIndexException,
                                              org.bonitasoft.engine.exception.InvalidPageZipInconsistentException,
                                              org.bonitasoft.engine.exception.InvalidPageZipMissingAPropertyException
        Specified by:
        getPageProperties in interface org.bonitasoft.engine.api.PageAPI
        Throws:
        org.bonitasoft.engine.exception.InvalidPageTokenException
        org.bonitasoft.engine.exception.AlreadyExistsException
        org.bonitasoft.engine.exception.InvalidPageZipMissingPropertiesException
        org.bonitasoft.engine.exception.InvalidPageZipMissingIndexException
        org.bonitasoft.engine.exception.InvalidPageZipInconsistentException
        org.bonitasoft.engine.exception.InvalidPageZipMissingAPropertyException

      • resolvePageOrURL

        public org.bonitasoft.engine.page.PageURL resolvePageOrURL​(java.lang.String key,
                                                           java.util.Map<java.lang.String,​java.io.Serializable> context,
                                                           boolean executeAuthorizationRules)
                                                    throws org.bonitasoft.engine.exception.NotFoundException,
                                                           org.bonitasoft.engine.exception.ExecutionException,
                                                           org.bonitasoft.engine.exception.UnauthorizedAccessException
        Specified by:
        resolvePageOrURL in interface org.bonitasoft.engine.api.PageAPI
        Throws:
        org.bonitasoft.engine.exception.NotFoundException
        org.bonitasoft.engine.exception.ExecutionException
        org.bonitasoft.engine.exception.UnauthorizedAccessException