org.bonitasoft.engine.api.impl.page

Class PageAPIDelegate

java.lang.Object

org.bonitasoft.engine.api.impl.page.PageAPIDelegate

public class PageAPIDelegate
extends Object

Author:

Emmanuel Duchastenier

Constructor Summary

Constructors

Constructor and Description
PageAPIDelegate(TenantServiceAccessor tenantAccessor, long userIdFromSession)

Method Summary

Modifier and Type	Method and Description
protected SPage	constructPage(PageCreator pageCreator, long userId)
protected SPage	constructPage(PageUpdater pageUpdater, long userId)
protected Page	convertToPage(SPage addPage)
Page	createPage(PageCreator pageCreator, byte[] content)
Page	createPage(String contentName, byte[] content)
void	deletePage(long pageId)
void	deletePages(List<Long> pageIds)
Page	getPage(long pageId)
Page	getPageByName(String name)
Page	getPageByNameAndProcessDefinition(String name, long processDefinitionId)
byte[]	getPageContent(long pageId)
Properties	getPageProperties(byte[] content, boolean checkIfItAlreadyExists)
protected SPageUpdateBuilder	getPageUpdateBuilder()
protected SPageUpdateContentBuilder	getPageUpdateContentBuilder()
protected SearchPages	getSearchPages(SearchOptions searchOptions)
SearchResult<Page>	searchPages(SearchOptions searchOptions)
Page	updatePage(long pageId, 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

PageAPIDelegate

public PageAPIDelegate(TenantServiceAccessor tenantAccessor,
                       long userIdFromSession)

Method Detail

getPage

public Page getPage(long pageId)
             throws PageNotFoundException

Throws:

PageNotFoundException

getPageContent

public byte[] getPageContent(long pageId)
                      throws PageNotFoundException

Throws:

PageNotFoundException

searchPages

public SearchResult<Page> searchPages(SearchOptions searchOptions)
                               throws SearchException

Throws:

SearchException

getSearchPages

protected SearchPages getSearchPages(SearchOptions searchOptions)

createPage

public Page createPage(PageCreator pageCreator,
                       byte[] content)
                throws AlreadyExistsException,
                       CreationException,
                       InvalidPageTokenException,
                       InvalidPageZipContentException

Throws:

AlreadyExistsException

CreationException

InvalidPageTokenException

InvalidPageZipContentException

createPage

public Page createPage(String contentName,
                       byte[] content)
                throws AlreadyExistsException,
                       CreationException,
                       InvalidPageTokenException,
                       InvalidPageZipContentException

Throws:

AlreadyExistsException

CreationException

InvalidPageTokenException

InvalidPageZipContentException

deletePage

public void deletePage(long pageId)
                throws DeletionException

Throws:

DeletionException

deletePages

public void deletePages(List<Long> pageIds)
                 throws DeletionException

Throws:

DeletionException

getPageByName

public Page getPageByName(String name)
                   throws PageNotFoundException

Throws:

PageNotFoundException

updatePage

public Page updatePage(long pageId,
                       PageUpdater pageUpdater)
                throws UpdateException,
                       AlreadyExistsException,
                       UpdatingWithInvalidPageTokenException,
                       UpdatingWithInvalidPageZipContentException

Throws:

UpdateException

AlreadyExistsException

UpdatingWithInvalidPageTokenException

UpdatingWithInvalidPageZipContentException

updatePageContent

public void updatePageContent(long pageId,
                              byte[] content)
                       throws UpdateException,
                              UpdatingWithInvalidPageTokenException,
                              UpdatingWithInvalidPageZipContentException

Throws:

UpdateException

UpdatingWithInvalidPageTokenException

UpdatingWithInvalidPageZipContentException

getPageProperties

public Properties getPageProperties(byte[] content,
                                    boolean checkIfItAlreadyExists)
                             throws InvalidPageTokenException,
                                    AlreadyExistsException,
                                    InvalidPageZipMissingPropertiesException,
                                    InvalidPageZipMissingIndexException,
                                    InvalidPageZipInconsistentException,
                                    InvalidPageZipMissingAPropertyException

Throws:

InvalidPageTokenException

AlreadyExistsException

InvalidPageZipMissingPropertiesException

InvalidPageZipMissingIndexException

InvalidPageZipInconsistentException

InvalidPageZipMissingAPropertyException

getPageUpdateBuilder

protected SPageUpdateBuilder getPageUpdateBuilder()

convertToPage

protected Page convertToPage(SPage addPage)

constructPage

protected SPage constructPage(PageCreator pageCreator,
                              long userId)

getPageUpdateContentBuilder

protected SPageUpdateContentBuilder getPageUpdateContentBuilder()

constructPage

protected SPage constructPage(PageUpdater pageUpdater,
                              long userId)

getPageByNameAndProcessDefinition

public Page getPageByNameAndProcessDefinition(String name,
                                              long processDefinitionId)
                                       throws PageNotFoundException

Throws:

PageNotFoundException