public class AppLocalServiceUtil
extends java.lang.Object
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.AppLocalService
Constructor and Description |
---|
AppLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static App |
addApp(App app)
Adds the app to the database.
|
static void |
clearInstalledAppsCache() |
static App |
createApp(long appId)
Creates a new app with the primary key.
|
static com.liferay.portal.kernel.model.PersistedModel |
createPersistedModel(java.io.Serializable primaryKeyObj) |
static App |
deleteApp(App app)
Deletes the app from the database.
|
static App |
deleteApp(long appId)
Deletes the app with the primary key from the database.
|
static com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static <T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <T> java.util.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.
|
static <T> java.util.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.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
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.
|
static App |
fetchApp(long appId) |
static App |
fetchAppByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the app with the matching UUID and company.
|
static App |
fetchRemoteApp(long remoteAppId) |
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static App |
getApp(long appId)
Returns the app with the primary key.
|
static App |
getAppByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the app with the matching UUID and company.
|
static java.util.List<App> |
getApps(int start,
int end)
Returns a range of all the apps.
|
static java.util.List<App> |
getApps(java.lang.String category) |
static int |
getAppsCount()
Returns the number of apps.
|
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery |
getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) |
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static java.util.List<App> |
getInstalledApps() |
static java.util.List<App> |
getInstalledApps(java.lang.String category) |
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static java.util.Map<java.lang.String,java.lang.String> |
getPrepackagedApps() |
static AppLocalService |
getService() |
static void |
installApp(long remoteAppId) |
static void |
setService(AppLocalService service) |
static void |
uninstallApp(long remoteAppId) |
static App |
updateApp(App app)
Updates the app in the database or adds it if it does not yet exist.
|
static App |
updateApp(long userId,
java.io.File file) |
static App |
updateApp(long userId,
long remoteAppId,
java.lang.String title,
java.lang.String description,
java.lang.String category,
java.lang.String iconURL,
java.lang.String version,
boolean required,
java.io.File file) |
public static App addApp(App app)
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.
app
- the apppublic static void clearInstalledAppsCache()
public static App createApp(long appId)
appId
- the primary key for the new apppublic static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static App deleteApp(App app)
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.
app
- the apppublic static App deleteApp(long appId) throws com.liferay.portal.kernel.exception.PortalException
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.
appId
- the primary key of the appcom.liferay.portal.kernel.exception.PortalException
- if a app with the primary key could not be foundpublic static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
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
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static App fetchApp(long appId)
public static App fetchAppByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid
- the app's UUIDcompanyId
- the primary key of the companynull
if a matching app could not be foundpublic static App fetchRemoteApp(long remoteAppId)
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static App getApp(long appId) throws com.liferay.portal.kernel.exception.PortalException
appId
- the primary key of the appcom.liferay.portal.kernel.exception.PortalException
- if a app with the primary key could not be foundpublic static App getAppByUuidAndCompanyId(java.lang.String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
uuid
- the app's UUIDcompanyId
- the primary key of the companycom.liferay.portal.kernel.exception.PortalException
- if a matching app could not be foundpublic static java.util.List<App> getApps(int start, int end)
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
.
start
- the lower bound of the range of appsend
- the upper bound of the range of apps (not inclusive)public static java.util.List<App> getApps(java.lang.String category)
public static int getAppsCount()
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static java.util.List<App> getInstalledApps()
public static java.util.List<App> getInstalledApps(java.lang.String category)
public static java.lang.String getOSGiServiceIdentifier()
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static java.util.Map<java.lang.String,java.lang.String> getPrepackagedApps()
public static void installApp(long remoteAppId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void uninstallApp(long remoteAppId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static App updateApp(App app)
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.
app
- the apppublic static App updateApp(long userId, java.io.File file) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static App updateApp(long userId, long remoteAppId, java.lang.String title, java.lang.String description, java.lang.String category, java.lang.String iconURL, java.lang.String version, boolean required, java.io.File file) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static AppLocalService getService()
public static void setService(AppLocalService service)