PageAPI
instead.@Deprecated public interface PageAPI
Also allows to manipulate Page
s, through creation, deletion, search.
Page
Modifier and Type | Method and Description |
---|---|
Page |
createPage(PageCreator pageCreator,
byte[] content)
Deprecated.
Creates a custom page.
|
Page |
createPage(String contentName,
byte[] content)
Deprecated.
create a page using the given content
the content must contain a page.properties file that contains informations on the page:
name, displayName and description
|
void |
deletePage(long pageId)
Deprecated.
Deletes a page identified by its ID.
|
void |
deletePages(List<Long> pageIds)
Deprecated.
Deletes a list of pages, given by their IDs.
|
Page |
getPage(long pageId)
Deprecated.
Retrieves a page from its ID.
|
Page |
getPageByName(String name)
Deprecated.
Retrieves a page from its name.
|
byte[] |
getPageContent(long pageId)
Deprecated.
Retrieves the binary content of a page.
|
Properties |
getPageProperties(byte[] content,
boolean checkIfItAlreadyExists)
Deprecated.
Read the content of the page zip file check it is consistent and return it's properties
|
SearchResult<Page> |
searchPages(SearchOptions searchOptions)
Deprecated.
Searches for pages with specific search criteria.
|
Page |
updatePage(long pageId,
PageUpdater pageUpdater)
Deprecated.
Updates a custom page.
|
void |
updatePageContent(long pageId,
byte[] content)
Deprecated.
Updates a custom page content.
|
Page getPage(long pageId) throws PageNotFoundException
pageId
- the Identifier of the page to retrievePageNotFoundException
- if no page can be found with the provided ID.Page getPageByName(String name) throws PageNotFoundException
name
- the name of the page to retrievePageNotFoundException
- if no page can be found with the provided ID.byte[] getPageContent(long pageId) throws PageNotFoundException
pageId
- the ID of the page to extract the content for.PageNotFoundException
- if no page can be found with the provided ID.SearchResult<Page> searchPages(SearchOptions searchOptions) throws SearchException
searchOptions
- the search options for the search. See SearchOptions
for search option details.SearchResult
containingSearchException
- if a problem occurs during the search.Page createPage(PageCreator pageCreator, byte[] content) throws AlreadyExistsException, CreationException, InvalidPageTokenException, InvalidPageZipContentException
pageCreator
- the creator object to instantiate the new page.content
- the binary content of the page.AlreadyExistsException
- if a page with this name already exists.CreationException
- if an error occurs during the creation.InvalidPageTokenException
InvalidPageZipContentException
Page updatePage(long pageId, PageUpdater pageUpdater) throws UpdateException, AlreadyExistsException, UpdatingWithInvalidPageTokenException, UpdatingWithInvalidPageZipContentException
pageId
- the Identifier of the page to updatepageUpdater
- the creator object to instantiate the new page.UpdateException
- if an error occurs during the update.AlreadyExistsException
- if a page with this name already exists.UpdatingWithInvalidPageTokenException
UpdatingWithInvalidPageZipContentException
void updatePageContent(long pageId, byte[] content) throws UpdateException, UpdatingWithInvalidPageTokenException, UpdatingWithInvalidPageZipContentException
pageId
- the Identifier of the page to updatecontent
- the binary content of the page.UpdateException
- if an error occurs during the update.UpdatingWithInvalidPageTokenException
UpdatingWithInvalidPageZipContentException
void deletePage(long pageId) throws DeletionException
pageId
- the page identifier to delete.DeletionException
- if a problem occurs during deletion.void deletePages(List<Long> pageIds) throws DeletionException
pageIds
- a list of page identifiers to delete.DeletionException
- if a problem occurs during deletion.Page createPage(String contentName, byte[] content) throws AlreadyExistsException, CreationException, InvalidPageTokenException, InvalidPageZipContentException
contentName
- name of the zip file containing the pagecontent
- content of the zip file containing the pageAlreadyExistsException
- if a page with the same name already existsCreationException
InvalidPageTokenException
InvalidPageZipContentException
Properties getPageProperties(byte[] content, boolean checkIfItAlreadyExists) throws InvalidPageTokenException, AlreadyExistsException, InvalidPageZipMissingPropertiesException, InvalidPageZipMissingIndexException, InvalidPageZipInconsistentException, InvalidPageZipMissingAPropertyException
content
- content of the zip file containing the pageInvalidPageTokenException
AlreadyExistsException
InvalidPageZipMissingPropertiesException
InvalidPageZipMissingIndexException
InvalidPageZipInconsistentException
InvalidPageZipMissingAPropertyException
Copyright © 2016 Bonitasoft S.A.. All rights reserved.