Package 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

Method Summary

Modifier and Type	Method	Description
protected SPage	constructPage(org.bonitasoft.engine.page.PageCreator pageCreator, long userId)
protected SPage	constructPage(org.bonitasoft.engine.page.PageUpdater pageUpdater, long userId)
protected org.bonitasoft.engine.page.Page	convertToPage(SPage addPage)
org.bonitasoft.engine.page.Page	createPage(String contentName, byte[] content, long userIdFromSession)
org.bonitasoft.engine.page.Page	createPage(org.bonitasoft.engine.page.PageCreator pageCreator, byte[] content, long userIdFromSession)
void	deletePage(long pageId)
void	deletePages(List<Long> pageIds)
static PageAPIDelegate	getInstance()
org.bonitasoft.engine.page.Page	getPage(long pageId)
org.bonitasoft.engine.page.Page	getPageByName(String name)
org.bonitasoft.engine.page.Page	getPageByNameAndProcessDefinition(String name, long processDefinitionId)
byte[]	getPageContent(long pageId)
Properties	getPageProperties(byte[] content, boolean checkIfItAlreadyExists)
protected SPageUpdateBuilder	getPageUpdateBuilder()
protected SearchPages	getSearchPages(org.bonitasoft.engine.search.SearchOptions searchOptions)
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, long userIdFromSession)
void	updatePageContent(long pageId, byte[] content, long userIdFromSession)

Methods inherited from class java.lang.Object

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

Method Details

getInstance

public static PageAPIDelegate getInstance()

getPage

public org.bonitasoft.engine.page.Page getPage(long pageId)
                                        throws org.bonitasoft.engine.page.PageNotFoundException

Throws:

org.bonitasoft.engine.page.PageNotFoundException

getPageContent

public byte[] getPageContent(long pageId)
                      throws org.bonitasoft.engine.page.PageNotFoundException

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

Throws:

org.bonitasoft.engine.exception.SearchException

getSearchPages

protected SearchPages getSearchPages(org.bonitasoft.engine.search.SearchOptions searchOptions)

createPage

public org.bonitasoft.engine.page.Page createPage(org.bonitasoft.engine.page.PageCreator pageCreator,
 byte[] content,
 long userIdFromSession)
                                           throws org.bonitasoft.engine.exception.AlreadyExistsException,
org.bonitasoft.engine.exception.CreationException,
org.bonitasoft.engine.exception.InvalidPageTokenException,
org.bonitasoft.engine.exception.InvalidPageZipContentException

Throws:

org.bonitasoft.engine.exception.AlreadyExistsException

org.bonitasoft.engine.exception.CreationException

org.bonitasoft.engine.exception.InvalidPageTokenException

org.bonitasoft.engine.exception.InvalidPageZipContentException

createPage

public org.bonitasoft.engine.page.Page createPage(String contentName,
 byte[] content,
 long userIdFromSession)
                                           throws org.bonitasoft.engine.exception.AlreadyExistsException,
org.bonitasoft.engine.exception.CreationException,
org.bonitasoft.engine.exception.InvalidPageTokenException,
org.bonitasoft.engine.exception.InvalidPageZipContentException

Throws:

org.bonitasoft.engine.exception.AlreadyExistsException

org.bonitasoft.engine.exception.CreationException

org.bonitasoft.engine.exception.InvalidPageTokenException

org.bonitasoft.engine.exception.InvalidPageZipContentException

deletePage

public void deletePage(long pageId)
                throws org.bonitasoft.engine.exception.DeletionException

Throws:

org.bonitasoft.engine.exception.DeletionException

deletePages

public void deletePages(List<Long> pageIds)
                 throws org.bonitasoft.engine.exception.DeletionException

Throws:

org.bonitasoft.engine.exception.DeletionException

getPageByName

public org.bonitasoft.engine.page.Page getPageByName(String name)
                                              throws org.bonitasoft.engine.page.PageNotFoundException

Throws:

org.bonitasoft.engine.page.PageNotFoundException

updatePage

public org.bonitasoft.engine.page.Page updatePage(long pageId,
 org.bonitasoft.engine.page.PageUpdater pageUpdater,
 long userIdFromSession)
                                           throws org.bonitasoft.engine.exception.UpdateException,
org.bonitasoft.engine.exception.AlreadyExistsException

Throws:

org.bonitasoft.engine.exception.UpdateException

org.bonitasoft.engine.exception.AlreadyExistsException

updatePageContent

public void updatePageContent(long pageId,
 byte[] content,
 long userIdFromSession)
                       throws org.bonitasoft.engine.exception.UpdateException,
org.bonitasoft.engine.exception.UpdatingWithInvalidPageTokenException,
org.bonitasoft.engine.exception.UpdatingWithInvalidPageZipContentException

Throws:

org.bonitasoft.engine.exception.UpdateException

org.bonitasoft.engine.exception.UpdatingWithInvalidPageTokenException

org.bonitasoft.engine.exception.UpdatingWithInvalidPageZipContentException

getPageProperties

public 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

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

getPageUpdateBuilder

protected SPageUpdateBuilder getPageUpdateBuilder()

convertToPage

protected org.bonitasoft.engine.page.Page convertToPage(SPage addPage)

constructPage

protected SPage constructPage(org.bonitasoft.engine.page.PageCreator pageCreator,
 long userId)

constructPage

protected SPage constructPage(org.bonitasoft.engine.page.PageUpdater pageUpdater,
 long userId)

getPageByNameAndProcessDefinition

public org.bonitasoft.engine.page.Page getPageByNameAndProcessDefinition(String name,
 long processDefinitionId)
                                                                  throws org.bonitasoft.engine.page.PageNotFoundException

Throws:

org.bonitasoft.engine.page.PageNotFoundException