Interface AppLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
AppLocalServiceWrapper

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface AppLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for App. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
See Also:
Generated:
  • Method Details

    • addApp

      @Indexable(type=REINDEX) App addApp(App app)
      Adds the app to the database. Also notifies the appropriate model listeners.

      Important: Inspect AppLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      app - the app
      Returns:
      the app that was added
    • clearInstalledAppsCache

      void clearInstalledAppsCache()
    • createApp

      @Transactional(enabled=false) App createApp(long appId)
      Creates a new app with the primary key. Does not add the app to the database.
      Parameters:
      appId - the primary key for the new app
      Returns:
      the new app
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteApp

      @Indexable(type=DELETE) @SystemEvent(type=1) App deleteApp(App app)
      Deletes the app from the database. Also notifies the appropriate model listeners.

      Important: Inspect AppLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      app - the app
      Returns:
      the app that was removed
    • deleteApp

      @Indexable(type=DELETE) App deleteApp(long appId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the app with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect AppLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      appId - the primary key of the app
      Returns:
      the app that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a app with the primary key could not be found
    • deletePersistedModel

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
      Performs a dynamic query on the database and returns a range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.marketplace.model.impl.AppModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      Returns:
      the range of matching rows
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
      Performs a dynamic query on the database and returns an ordered range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.marketplace.model.impl.AppModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching rows
    • dynamicQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchApp

      @Transactional(propagation=SUPPORTS, readOnly=true) App fetchApp(long appId)
    • fetchAppByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) App fetchAppByUuidAndCompanyId(String uuid, long companyId)
      Returns the app with the matching UUID and company.
      Parameters:
      uuid - the app's UUID
      companyId - the primary key of the company
      Returns:
      the matching app, or null if a matching app could not be found
    • fetchRemoteApp

      @Transactional(propagation=SUPPORTS, readOnly=true) App fetchRemoteApp(long remoteAppId)
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getApp

      @Transactional(propagation=SUPPORTS, readOnly=true) App getApp(long appId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the app with the primary key.
      Parameters:
      appId - the primary key of the app
      Returns:
      the app
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a app with the primary key could not be found
    • getAppByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) App getAppByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the app with the matching UUID and company.
      Parameters:
      uuid - the app's UUID
      companyId - the primary key of the company
      Returns:
      the matching app
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching app could not be found
    • getApps

      @Transactional(propagation=SUPPORTS, readOnly=true) List<App> getApps(int start, int end)
      Returns a range of all the apps.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.marketplace.model.impl.AppModelImpl.

      Parameters:
      start - the lower bound of the range of apps
      end - the upper bound of the range of apps (not inclusive)
      Returns:
      the range of apps
    • getApps

      @Transactional(propagation=SUPPORTS, readOnly=true) List<App> getApps(String category)
    • getAppsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getAppsCount()
      Returns the number of apps.
      Returns:
      the number of apps
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getInstalledApps

      @Transactional(propagation=SUPPORTS, readOnly=true) List<App> getInstalledApps()
    • getInstalledApps

      @Transactional(propagation=SUPPORTS, readOnly=true) List<App> getInstalledApps(String category)
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getPrepackagedApps

      @Transactional(propagation=SUPPORTS, readOnly=true) Map<String,String> getPrepackagedApps()
    • installApp

      void installApp(long remoteAppId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • isDownloaded

      @Transactional(propagation=SUPPORTS, readOnly=true) boolean isDownloaded(App app)
    • uninstallApp

      void uninstallApp(long remoteAppId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateApp

      @Indexable(type=REINDEX) App updateApp(App app)
      Updates the app in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect AppLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      app - the app
      Returns:
      the app that was updated
    • updateApp

      App updateApp(long userId, File file) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateApp

      App updateApp(long userId, long remoteAppId, String title, String description, String category, String iconURL, String version, boolean required, File file) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException