org.bonitasoft.engine.page

Interface PageService

All Superinterfaces:

org.bonitasoft.engine.commons.LifecycleService, org.bonitasoft.engine.commons.TenantLifecycleService

All Known Implementing Classes:

PageServiceImpl

public interface PageService
extends org.bonitasoft.engine.commons.TenantLifecycleService

Author:

Baptiste Mesta, Laurent Leseigneur

Field Summary

Fields

Modifier and Type	Field and Description
static String	PAGE
static String	PROPERTIES_CONTENT_TYPE
static String	PROPERTIES_DESCRIPTION
static String	PROPERTIES_DISPLAY_NAME
static String	PROPERTIES_FILE_NAME
static String	PROPERTIES_NAME

Method Summary

Modifier and Type	Method and Description
SPage	addPage(byte[] content, String contentName, long userId) add a page using the zip in parameters, it get all informations from the page.properties file contain inside the zip
SPage	addPage(SPage page, byte[] content) add a page using the zip in parameters and the given properties
void	deletePage(long pageId)
long	getNumberOfPages(QueryOptions options)
SPage	getPage(long pageId)
SPage	getPageByName(String pageName)
SPage	getPageByNameAndProcessDefinitionId(String name, long processDefinitionId) get a page attached to a process
List<SPage>	getPageByProcessDefinitionId(long processDefinitionId, int fromIndex, int numberOfResults) get a list of page attached to a process
byte[]	getPageContent(long pageId)
Properties	readPageZip(byte[] content) Read the content of a page in a zip
List<SPage>	searchPages(QueryOptions options)
void	start()
SPage	updatePage(long pageId, EntityUpdateDescriptor updateDescriptor)
void	updatePageContent(long pageId, byte[] content, String contentName)

Methods inherited from interface org.bonitasoft.engine.commons.LifecycleService

pause, resume, stop

Field Detail

PROPERTIES_FILE_NAME

static final String PROPERTIES_FILE_NAME

See Also:

Constant Field Values

PROPERTIES_DISPLAY_NAME

static final String PROPERTIES_DISPLAY_NAME

See Also:

Constant Field Values

PROPERTIES_DESCRIPTION

static final String PROPERTIES_DESCRIPTION

See Also:

Constant Field Values

PROPERTIES_CONTENT_TYPE

static final String PROPERTIES_CONTENT_TYPE

See Also:

Constant Field Values

PROPERTIES_NAME

static final String PROPERTIES_NAME

See Also:

Constant Field Values

PAGE

static final String PAGE

See Also:

Constant Field Values

Method Detail

addPage

SPage addPage(SPage page,
              byte[] content)
       throws org.bonitasoft.engine.commons.exceptions.SObjectCreationException,
              org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException,
              SInvalidPageZipException,
              SInvalidPageTokenException

add a page using the zip in parameters and the given properties

Parameters:

page -

content -

Returns:

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectCreationException

org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

SInvalidPageZipException

SInvalidPageTokenException

getPage

SPage getPage(long pageId)
       throws SBonitaReadException,
              org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

Throws:

SBonitaReadException

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

getPageByName

SPage getPageByName(String pageName)
             throws SBonitaReadException

Throws:

SBonitaReadException

readPageZip

Properties readPageZip(byte[] content)
                throws SInvalidPageZipMissingIndexException,
                       SInvalidPageZipMissingAPropertyException,
                       SInvalidPageZipInconsistentException,
                       SInvalidPageZipMissingPropertiesException,
                       SInvalidPageTokenException

Read the content of a page in a zip

Parameters:

content - the page content

Returns:

the properties of the page stored in the page.properties

Throws:

SInvalidPageZipMissingIndexException - if the page is missing an index.html or Index.groovy

SInvalidPageZipMissingAPropertyException - if the page is missing mandatory field in the page.properties

SInvalidPageZipInconsistentException - if the zip is not a valid zip file or unreadable

SInvalidPageZipMissingPropertiesException

SInvalidPageTokenException

getNumberOfPages

long getNumberOfPages(QueryOptions options)
               throws SBonitaReadException

Throws:

SBonitaReadException

deletePage

void deletePage(long pageId)
         throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException,
                org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

getPageContent

byte[] getPageContent(long pageId)
               throws SBonitaReadException,
                      org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

Throws:

SBonitaReadException

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

searchPages

List<SPage> searchPages(QueryOptions options)
                 throws SBonitaReadException

Throws:

SBonitaReadException

updatePage

SPage updatePage(long pageId,
                 EntityUpdateDescriptor updateDescriptor)
          throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException,
                 org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException,
                 SInvalidPageTokenException

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

SInvalidPageTokenException

updatePageContent

void updatePageContent(long pageId,
                       byte[] content,
                       String contentName)
                throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

start

void start()
    throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Specified by:

start in interface org.bonitasoft.engine.commons.LifecycleService

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

addPage

SPage addPage(byte[] content,
              String contentName,
              long userId)
       throws org.bonitasoft.engine.commons.exceptions.SObjectCreationException,
              org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException,
              SInvalidPageZipException,
              SInvalidPageTokenException

add a page using the zip in parameters, it get all informations from the page.properties file contain inside the zip

Parameters:

content -

userId -

Returns:

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectCreationException

org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

SInvalidPageZipException

SInvalidPageTokenException

getPageByNameAndProcessDefinitionId

SPage getPageByNameAndProcessDefinitionId(String name,
                                          long processDefinitionId)
                                   throws SBonitaReadException

get a page attached to a process

Parameters:

name -

processDefinitionId -

Returns:

Throws:

SBonitaReadException

getPageByProcessDefinitionId

List<SPage> getPageByProcessDefinitionId(long processDefinitionId,
                                         int fromIndex,
                                         int numberOfResults)
                                  throws SBonitaReadException

get a list of page attached to a process

Parameters:

processDefinitionId -

fromIndex -

numberOfResults -

Returns:

Throws:

SBonitaReadException