Class AppLocalServiceUtil

java.lang.Object
com.liferay.marketplace.service.AppLocalServiceUtil

public class AppLocalServiceUtil extends Object
Provides the local service utility for App. This utility wraps com.liferay.marketplace.service.impl.AppLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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:
  • Constructor Details

    • AppLocalServiceUtil

      public AppLocalServiceUtil()
  • Method Details

    • addApp

      public static 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

      public static void clearInstalledAppsCache()
    • createApp

      public static 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

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteApp

      public static 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

      public static 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

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <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

      public static <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

      public static <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

      public static 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

      public static 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

      public static App fetchApp(long appId)
    • fetchAppByUuidAndCompanyId

      public static 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

      public static App fetchRemoteApp(long remoteAppId)
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getApp

      public static 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

      public static 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

      public static 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

      public static List<App> getApps(String category)
    • getAppsCount

      public static int getAppsCount()
      Returns the number of apps.
      Returns:
      the number of apps
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getInstalledApps

      public static List<App> getInstalledApps()
    • getInstalledApps

      public static List<App> getInstalledApps(String category)
    • getOSGiServiceIdentifier

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

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getPrepackagedApps

      public static Map<String,String> getPrepackagedApps()
    • installApp

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

      public static boolean isDownloaded(App app)
    • uninstallApp

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

      public static 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

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

      public static 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
    • getService

      public static AppLocalService getService()