org.bonitasoft.engine.api

Interface ApplicationAPI

public interface ApplicationAPI

This API allows to list and manage Bonita Living Applications (Application).

Since:

6.4

Author:

Elias Ricken de Medeiros

See Also:

Application

Method Summary

Modifier and Type	Method and Description
Application	createApplication(ApplicationCreator applicationCreator) Creates a new Application based on the supplied ApplicationCreator
ApplicationMenu	createApplicationMenu(ApplicationMenuCreator applicationMenuCreator) Creates a ApplicationMenu based on the supplied ApplicationMenuCreator.
ApplicationPage	createApplicationPage(long applicationId, long pageId, String token) Creates an ApplicationPage
void	deleteApplication(long applicationId) Deletes an Application by its identifier.
void	deleteApplicationMenu(long applicationMenuId) Deletes an ApplicationMenu by its identifier.
void	deleteApplicationPage(long applicationPageId) Deletes an ApplicationPage by its identifier.
byte[]	exportApplications(long... applicationIds) Exports the Applications which identifier is in applicationIds
List<String>	getAllPagesForProfile(long profileId) Return all pages names that can be accessed by the profile through applications.
Application	getApplication(long applicationId) Retrieves an Application from its identifier.
ApplicationPage	getApplicationHomePage(long applicationId) Retrieves the ApplicationPage defined as the Application home page
ApplicationMenu	getApplicationMenu(long applicationMenuId) Retrieves the ApplicationMenu from its identifier
ApplicationPage	getApplicationPage(long applicationPageId) Retrieves the ApplicationPage from its identifier
ApplicationPage	getApplicationPage(String applicationToken, String applicationPageToken) Retrieves the ApplicationPage for the given Application token and ApplicationPage token
List<ImportStatus>	importApplications(byte[] xmlContent, ApplicationImportPolicy policy) Imports Applications based on a XML file content.
SearchResult<ApplicationMenu>	searchApplicationMenus(SearchOptions searchOptions) Searches for ApplicationMenus with specific search criteria.
SearchResult<ApplicationPage>	searchApplicationPages(SearchOptions searchOptions) Searches for ApplicationPages with specific search criteria.
SearchResult<Application>	searchApplications(SearchOptions searchOptions) Searches for Applications with specific search criteria.
void	setApplicationHomePage(long applicationId, long applicationPageId) Defines which ApplicationPage will represent the Application home page
Application	updateApplication(long applicationId, ApplicationUpdater updater) Updates an Application based on the information supplied by the ApplicationUpdater
ApplicationMenu	updateApplicationMenu(long applicationMenuId, ApplicationMenuUpdater updater) Updates an ApplicationMenu based on the information supplied by the ApplicationMenuUpdater.

Method Detail

createApplication

Application createApplication(ApplicationCreator applicationCreator)
                       throws AlreadyExistsException,
                              CreationException

Creates a new Application based on the supplied ApplicationCreator

Parameters:

applicationCreator - creator describing characteristics of application to be created

Returns:

the created Application

Throws:

AlreadyExistsException - if an application already exists with the same name

CreationException - if an error occurs during the creation

See Also:

Application, ApplicationCreator

getApplication

Application getApplication(long applicationId)
                    throws ApplicationNotFoundException

Retrieves an Application from its identifier.

Parameters:

applicationId - the application identifier

Returns:

an Application from its identifier.

Throws:

ApplicationNotFoundException - if no application is found for the given identifier

See Also:

Application

deleteApplication

void deleteApplication(long applicationId)
                throws DeletionException

Deletes an Application by its identifier. All related ApplicationPages and ApplicationMenus will be automatically deleted.

Parameters:

applicationId - the Application identifier

Throws:

DeletionException - if an error occurs during the deletion

See Also:

Application, ApplicationPage, ApplicationMenu

updateApplication

Application updateApplication(long applicationId,
                              ApplicationUpdater updater)
                       throws ApplicationNotFoundException,
                              UpdateException,
                              AlreadyExistsException

Updates an Application based on the information supplied by the ApplicationUpdater

Parameters:

applicationId - a long representing the application identifier

updater - an ApplicationUpdater describing the fields to be updated.

Returns:

the Application as it is after the update.

Throws:

ApplicationNotFoundException - if no Application is found for the given id

AlreadyExistsException - if another Application already exists with the new name value

UpdateException - if an error occurs during the update

See Also:

Application, ApplicationUpdater

searchApplications

SearchResult<Application> searchApplications(SearchOptions searchOptions)
                                      throws SearchException

Searches for Applications with specific search criteria. Use ApplicationSearchDescriptor to know the available filters.

Parameters:

searchOptions - the search criteria. See SearchOptions for details.

Returns:

a SearchResult containing the number and the list of applications matching the search criteria.

Throws:

SearchException - if an error occurs during search

See Also:

Application, ApplicationSearchDescriptor, SearchOptions, SearchResult

createApplicationPage

ApplicationPage createApplicationPage(long applicationId,
                                      long pageId,
                                      String token)
                               throws AlreadyExistsException,
                                      CreationException,
                                      ApplicationNotFoundException

Creates an ApplicationPage

Parameters:

applicationId - the identifier of the Application to which the Page will be associated

pageId - the identifier of Page to be associated to the Application

token - the token that this Page will take in this ApplicationPage. The token must be unique for a given application and should contain only alpha numeric characters and the following special characters '-', '.', '_' or '~'. In addition, the following words are reserved key words and cannot be used as token: 'api', 'content', 'theme'.

Returns:

the created ApplicationPage

Throws:

AlreadyExistsException - if the token is already used by another ApplicationPage on this Application

CreationException - if an error occurs during the creation

ApplicationNotFoundException - if the referenced application does not exist.

See Also:

ApplicationPage, Application, Page

getApplicationPage

ApplicationPage getApplicationPage(String applicationToken,
                                   String applicationPageToken)
                            throws ApplicationPageNotFoundException

Retrieves the ApplicationPage for the given Application token and ApplicationPage token

Parameters:

applicationToken - the Application name

applicationPageToken - the ApplicationPage token

Returns:

the ApplicationPage for the given Application token and ApplicationPage token

Throws:

ApplicationPageNotFoundException - if no ApplicationPage is found for the given Application token and ApplicationPage token

See Also:

ApplicationPage

getApplicationPage

ApplicationPage getApplicationPage(long applicationPageId)
                            throws ApplicationPageNotFoundException

Retrieves the ApplicationPage from its identifier

Parameters:

applicationPageId - the ApplicationPage identifier

Returns:

the ApplicationPage from its identifier

Throws:

ApplicationPageNotFoundException - if no ApplicationPage is found for the given identifier

See Also:

ApplicationPage

deleteApplicationPage

void deleteApplicationPage(long applicationPageId)
                    throws DeletionException

Deletes an ApplicationPage by its identifier. All related ApplicationMenu will be automatically deleted.

Parameters:

applicationPageId - the ApplicationPage identifier

Throws:

DeletionException - if an error occurs during the deletion

See Also:

ApplicationPage, ApplicationMenu

searchApplicationPages

SearchResult<ApplicationPage> searchApplicationPages(SearchOptions searchOptions)
                                              throws SearchException

Searches for ApplicationPages with specific search criteria.

Parameters:

searchOptions - the search criteria. See SearchOptions for details. Use ApplicationPageSearchDescriptor to know the available filters.

Returns:

a SearchResult containing the number and the list of org.bonitasoft.engine.business.application.ApplicationPageSearchDescriptors matching the search criteria.

Throws:

SearchException - if an error occurs during the search execution

See Also:

ApplicationPage, ApplicationPageSearchDescriptor, SearchOptions, SearchResult

setApplicationHomePage

void setApplicationHomePage(long applicationId,
                            long applicationPageId)
                     throws UpdateException,
                            ApplicationNotFoundException

Defines which ApplicationPage will represent the Application home page

Parameters:

applicationId - the Application identifier

applicationPageId - the identifier of the ApplicationPage to be used as home page

Throws:

UpdateException - if an error occurs during the update

ApplicationNotFoundException - if no Application is found with the given id

See Also:

Application, ApplicationPage

getApplicationHomePage

ApplicationPage getApplicationHomePage(long applicationId)
                                throws ApplicationPageNotFoundException

Retrieves the ApplicationPage defined as the Application home page

Parameters:

applicationId - the Application identifier

Returns:

the tApplicationPage defined as Application home page

Throws:

ApplicationPageNotFoundException - if no home page is found for the given application

See Also:

Application, ApplicationPage

createApplicationMenu

ApplicationMenu createApplicationMenu(ApplicationMenuCreator applicationMenuCreator)
                               throws CreationException

Creates a ApplicationMenu based on the supplied ApplicationMenuCreator. The new created ApplicationMenu will be ordered at the last position of its level with an auto generated index.

Parameters:

applicationMenuCreator - creator describing the characteristics of the ApplicationMenu to be created

Returns:

the created ApplicationMenu

Throws:

CreationException - if an error occurs during the creation

See Also:

ApplicationMenu, ApplicationMenuCreator

updateApplicationMenu

ApplicationMenu updateApplicationMenu(long applicationMenuId,
                                      ApplicationMenuUpdater updater)
                               throws ApplicationMenuNotFoundException,
                                      UpdateException

Updates an ApplicationMenu based on the information supplied by the ApplicationMenuUpdater.

When the ApplicationMenu index is updated all other ApplicationMenus in the same level will have indexes automatically updated in order to keep indexes coherency. For instance, when an ApplicationMenu is moved from index 4 to index 2, the ApplicationMenu previously at index 2 will be moved to index 3 and the ApplicationMenu previously at index 3 will be moved to index 4.

Parameters:

applicationMenuId - the ApplicationMenu identifier

updater - the ApplicationMenuUpdater describing the fields to be updated.

Returns:

the ApplicationMenu up to date

Throws:

ApplicationMenuNotFoundException - if no ApplicationMenu is found for the given identifier

UpdateException - if an exception occurs during the update

See Also:

ApplicationMenu, ApplicationMenuUpdater

getApplicationMenu

ApplicationMenu getApplicationMenu(long applicationMenuId)
                            throws ApplicationMenuNotFoundException

Retrieves the ApplicationMenu from its identifier

Parameters:

applicationMenuId - the ApplicationMenu menu identifier

Returns:

the ApplicationMenu from its identifier

Throws:

ApplicationMenuNotFoundException - if no ApplicationMenu is found for the given identifier

See Also:

ApplicationMenu

deleteApplicationMenu

void deleteApplicationMenu(long applicationMenuId)
                    throws DeletionException

Deletes an ApplicationMenu by its identifier. All children ApplicationMenu will be automatically deleted.

When an ApplicationMenu is deleted all others ApplicationMenus having index greater than the index of deleted ApplicationMenu in the same level will be automatically updated in order to keep indexes coherency.

Parameters:

applicationMenuId - the ApplicationMenu identifier

Throws:

DeletionException - if an error occurs during the deletion

See Also:

ApplicationMenu

searchApplicationMenus

SearchResult<ApplicationMenu> searchApplicationMenus(SearchOptions searchOptions)
                                              throws SearchException

Searches for ApplicationMenus with specific search criteria.

Parameters:

searchOptions - the search criteria. See SearchOptions for details. Use ApplicationMenuSearchDescriptor to know the available filters

Returns:

a SearchResult containing the number and the list of ApplicationMenus matching the search criteria.

Throws:

SearchException - if an error occurs during search

See Also:

ApplicationMenu, SearchOptions, ApplicationMenuSearchDescriptor, SearchResult

getAllPagesForProfile

List<String> getAllPagesForProfile(long profileId)

Return all pages names that can be accessed by the profile through applications. The portal use this method to calculate all permissions for a user.

Parameters:

profileId - the id of the profile

Returns:

list of page name accessible by the profile through applications

exportApplications

byte[] exportApplications(long... applicationIds)
                   throws ExportException

Exports the Applications which identifier is in applicationIds

Parameters:

applicationIds - the identifiers of Applications to be exported

Returns:

a byte array representing the content of XML file containing the exported Applications

Throws:

ExportException - if an exception occurs during the export.

See Also:

Application

importApplications

List<ImportStatus> importApplications(byte[] xmlContent,
                                      ApplicationImportPolicy policy)
                               throws ImportException,
                                      AlreadyExistsException

Imports Applications based on a XML file content.

Before importing Applications ensure that all Profiles referenced by Applications and all Pages referenced by ApplicationPages are available.

• When the Profile does not exist the Application will be imported, but no Profile will be associated to it. An ImportError will be added to the ImportStatus related to this Application.
• When a Page does not exist the related ApplicationPage and ApplicationMenus pointing to this ApplicationPage will not be created. An ImportError will be added to the ImportStatus related to the Application containing this ApplicationPage.

Parameters:

xmlContent - a byte array representing the content of XML file containing the applications to be imported.

policy - the ApplicationImportPolicy used to execute the import

Returns:

a List of ImportStatus representing the ImportStatus for each imported Application

Throws:

ImportException - if an error occurs during the import

AlreadyExistsException - if one of applications being imported already exists and the policy ApplicationImportPolicy.FAIL_ON_DUPLICATES is used

See Also:

Application, ApplicationImportPolicy, ImportStatus, ImportError, ApplicationPage, ApplicationMenu, Profile, Page