Class ApplicationAPIImpl

  • All Implemented Interfaces:
    org.bonitasoft.engine.api.ApplicationAPI

    public class ApplicationAPIImpl
    extends java.lang.Object
    implements org.bonitasoft.engine.api.ApplicationAPI
    Author:
    Elias Ricken de Medeiros
    • Constructor Detail

      • ApplicationAPIImpl

        public ApplicationAPIImpl()
    • Method Detail

      • createApplication

        public org.bonitasoft.engine.business.application.Application createApplication​(org.bonitasoft.engine.business.application.ApplicationCreator applicationCreator)
                                                                                 throws org.bonitasoft.engine.exception.CreationException
        Specified by:
        createApplication in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.exception.CreationException
      • getApplication

        public org.bonitasoft.engine.business.application.Application getApplication​(long applicationId)
                                                                              throws org.bonitasoft.engine.business.application.ApplicationNotFoundException
        Specified by:
        getApplication in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.business.application.ApplicationNotFoundException
      • getApplicationByToken

        public org.bonitasoft.engine.business.application.Application getApplicationByToken​(java.lang.String applicationToken)
                                                                                     throws org.bonitasoft.engine.business.application.ApplicationNotFoundException
        Specified by:
        getApplicationByToken in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.business.application.ApplicationNotFoundException
      • deleteApplication

        public void deleteApplication​(long applicationId)
                               throws org.bonitasoft.engine.exception.DeletionException
        Specified by:
        deleteApplication in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.exception.DeletionException
      • updateApplication

        public org.bonitasoft.engine.business.application.Application updateApplication​(long applicationId,
                                                                                        org.bonitasoft.engine.business.application.ApplicationUpdater updater)
                                                                                 throws org.bonitasoft.engine.business.application.ApplicationNotFoundException,
                                                                                        org.bonitasoft.engine.exception.UpdateException,
                                                                                        org.bonitasoft.engine.exception.AlreadyExistsException
        Specified by:
        updateApplication in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.business.application.ApplicationNotFoundException
        org.bonitasoft.engine.exception.UpdateException
        org.bonitasoft.engine.exception.AlreadyExistsException
      • searchApplications

        public org.bonitasoft.engine.search.SearchResult<org.bonitasoft.engine.business.application.Application> searchApplications​(org.bonitasoft.engine.search.SearchOptions searchOptions)
                                                                                                                             throws org.bonitasoft.engine.exception.SearchException
        Specified by:
        searchApplications in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.exception.SearchException
      • createApplicationPage

        public org.bonitasoft.engine.business.application.ApplicationPage createApplicationPage​(long applicationId,
                                                                                                long pageId,
                                                                                                java.lang.String token)
                                                                                         throws org.bonitasoft.engine.exception.CreationException
        Specified by:
        createApplicationPage in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.exception.CreationException
      • getApplicationPage

        public org.bonitasoft.engine.business.application.ApplicationPage getApplicationPage​(java.lang.String applicationName,
                                                                                             java.lang.String applicationPageToken)
                                                                                      throws org.bonitasoft.engine.business.application.ApplicationPageNotFoundException
        Specified by:
        getApplicationPage in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.business.application.ApplicationPageNotFoundException
      • searchApplicationPages

        public org.bonitasoft.engine.search.SearchResult<org.bonitasoft.engine.business.application.ApplicationPage> searchApplicationPages​(org.bonitasoft.engine.search.SearchOptions searchOptions)
                                                                                                                                     throws org.bonitasoft.engine.exception.SearchException
        Specified by:
        searchApplicationPages in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.exception.SearchException
      • getApplicationPage

        public org.bonitasoft.engine.business.application.ApplicationPage getApplicationPage​(long applicationPageId)
                                                                                      throws org.bonitasoft.engine.business.application.ApplicationPageNotFoundException
        Specified by:
        getApplicationPage in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.business.application.ApplicationPageNotFoundException
      • deleteApplicationPage

        public void deleteApplicationPage​(long applicationPageId)
                                   throws org.bonitasoft.engine.exception.DeletionException
        Specified by:
        deleteApplicationPage in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.exception.DeletionException
      • setApplicationHomePage

        public void setApplicationHomePage​(long applicationId,
                                           long applicationPageId)
                                    throws org.bonitasoft.engine.exception.UpdateException,
                                           org.bonitasoft.engine.business.application.ApplicationNotFoundException
        Specified by:
        setApplicationHomePage in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.exception.UpdateException
        org.bonitasoft.engine.business.application.ApplicationNotFoundException
      • getApplicationHomePage

        public org.bonitasoft.engine.business.application.ApplicationPage getApplicationHomePage​(long applicationId)
                                                                                          throws org.bonitasoft.engine.business.application.ApplicationPageNotFoundException
        Specified by:
        getApplicationHomePage in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.business.application.ApplicationPageNotFoundException
      • createApplicationMenu

        public org.bonitasoft.engine.business.application.ApplicationMenu createApplicationMenu​(org.bonitasoft.engine.business.application.ApplicationMenuCreator applicationMenuCreator)
                                                                                         throws org.bonitasoft.engine.exception.CreationException
        Specified by:
        createApplicationMenu in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.exception.CreationException
      • updateApplicationMenu

        public org.bonitasoft.engine.business.application.ApplicationMenu updateApplicationMenu​(long applicationMenuId,
                                                                                                org.bonitasoft.engine.business.application.ApplicationMenuUpdater updater)
                                                                                         throws org.bonitasoft.engine.business.application.ApplicationMenuNotFoundException,
                                                                                                org.bonitasoft.engine.exception.UpdateException
        Specified by:
        updateApplicationMenu in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.business.application.ApplicationMenuNotFoundException
        org.bonitasoft.engine.exception.UpdateException
      • getApplicationMenu

        public org.bonitasoft.engine.business.application.ApplicationMenu getApplicationMenu​(long applicationMenuId)
                                                                                      throws org.bonitasoft.engine.business.application.ApplicationMenuNotFoundException
        Specified by:
        getApplicationMenu in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.business.application.ApplicationMenuNotFoundException
      • deleteApplicationMenu

        public void deleteApplicationMenu​(long applicationMenuId)
                                   throws org.bonitasoft.engine.exception.DeletionException
        Specified by:
        deleteApplicationMenu in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.exception.DeletionException
      • searchApplicationMenus

        public org.bonitasoft.engine.search.SearchResult<org.bonitasoft.engine.business.application.ApplicationMenu> searchApplicationMenus​(org.bonitasoft.engine.search.SearchOptions searchOptions)
                                                                                                                                     throws org.bonitasoft.engine.exception.SearchException
        Specified by:
        searchApplicationMenus in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.exception.SearchException
      • getAllPagesForProfile

        public java.util.List<java.lang.String> getAllPagesForProfile​(long profileId)
        Specified by:
        getAllPagesForProfile in interface org.bonitasoft.engine.api.ApplicationAPI
      • getAllPagesForProfile

        public java.util.List<java.lang.String> getAllPagesForProfile​(java.lang.String profile)
        Specified by:
        getAllPagesForProfile in interface org.bonitasoft.engine.api.ApplicationAPI
      • exportApplications

        public byte[] exportApplications​(long... applicationIds)
                                  throws org.bonitasoft.engine.exception.ExportException
        Specified by:
        exportApplications in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.exception.ExportException
      • importApplications

        public java.util.List<org.bonitasoft.engine.api.ImportStatus> importApplications​(byte[] xmlContent,
                                                                                         org.bonitasoft.engine.business.application.ApplicationImportPolicy policy)
                                                                                  throws org.bonitasoft.engine.exception.ImportException,
                                                                                         org.bonitasoft.engine.exception.AlreadyExistsException
        Specified by:
        importApplications in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.exception.ImportException
        org.bonitasoft.engine.exception.AlreadyExistsException
      • getIconOfApplication

        public org.bonitasoft.engine.business.application.Icon getIconOfApplication​(long applicationId)
                                                                             throws org.bonitasoft.engine.business.application.ApplicationNotFoundException
        Specified by:
        getIconOfApplication in interface org.bonitasoft.engine.api.ApplicationAPI
        Throws:
        org.bonitasoft.engine.business.application.ApplicationNotFoundException