Package org.bonitasoft.engine.page

Interface PageService

All Known Implementing Classes:

PageServiceImpl

public interface PageService

Author:

Baptiste Mesta, Laurent Leseigneur

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	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
SPage	buildPage(byte[] content, String contentName, long userId, boolean provided, boolean removable, boolean editable)
SPage	checkIfPageAlreadyExists(SPage page)
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)
SPage	insertPage(SPage page, byte[] content)
Properties	readPageZip(byte[] content)	Read the content of a page in a zip
List<SPage>	searchPages(QueryOptions options)
SPage	updatePage(long pageId, EntityUpdateDescriptor updateDescriptor)
void	updatePageContent(long pageId, byte[] content, String contentName)
void	updatePageContent(long pageId, byte[] content, String contentName, SPageUpdateBuilder pageUpdateBuilder)

Field Details

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 Details

addPage

SPage addPage(SPage page,
 byte[] content)
       throws SObjectCreationException,
SObjectAlreadyExistsException,
SInvalidPageZipException,
SInvalidPageTokenException

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

Parameters:

page -

content -

Returns:

Throws:

SObjectCreationException

SObjectAlreadyExistsException

SInvalidPageZipException

SInvalidPageTokenException

insertPage

SPage insertPage(SPage page,
 byte[] content)
          throws SObjectAlreadyExistsException,
SObjectCreationException

Throws:

SObjectAlreadyExistsException

SObjectCreationException

checkIfPageAlreadyExists

SPage checkIfPageAlreadyExists(SPage page)
                        throws SBonitaReadException

Throws:

SBonitaReadException

getPage

SPage getPage(long pageId)
       throws SBonitaReadException,
SObjectNotFoundException

Throws:

SBonitaReadException

SObjectNotFoundException

getPageByName

SPage getPageByName(String pageName)
             throws SBonitaReadException

Throws:

SBonitaReadException

buildPage

SPage buildPage(byte[] content,
 String contentName,
 long userId,
 boolean provided,
 boolean removable,
 boolean editable)
         throws SInvalidPageZipException,
SInvalidPageTokenException

Throws:

SInvalidPageZipException

SInvalidPageTokenException

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 SObjectModificationException,
SObjectNotFoundException

Throws:

SObjectModificationException

SObjectNotFoundException

getPageContent

byte[] getPageContent(long pageId)
               throws SBonitaReadException,
SObjectNotFoundException

Throws:

SBonitaReadException

SObjectNotFoundException

searchPages

List<SPage> searchPages(QueryOptions options)
                 throws SBonitaReadException

Throws:

SBonitaReadException

updatePage

SPage updatePage(long pageId,
 EntityUpdateDescriptor updateDescriptor)
          throws SObjectModificationException,
SObjectAlreadyExistsException,
SInvalidPageTokenException

Throws:

SObjectModificationException

SObjectAlreadyExistsException

SInvalidPageTokenException

updatePageContent

void updatePageContent(long pageId,
 byte[] content,
 String contentName)
                throws SBonitaException

Throws:

SBonitaException

addPage

SPage addPage(byte[] content,
 String contentName,
 long userId)
       throws SObjectCreationException,
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:

SObjectCreationException

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

updatePageContent

void updatePageContent(long pageId,
 byte[] content,
 String contentName,
 SPageUpdateBuilder pageUpdateBuilder)
                throws SObjectAlreadyExistsException,
SObjectModificationException,
SInvalidPageZipException,
SInvalidPageTokenException

Throws:

SObjectAlreadyExistsException

SObjectModificationException

SInvalidPageZipException

SInvalidPageTokenException