@ProviderType
public class BackgroundTaskLocalServiceUtil
extends java.lang.Object
com.liferay.portal.background.task.service.impl.BackgroundTaskLocalServiceImpl
and is the
primary 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.BackgroundTaskLocalService
,
com.liferay.portal.background.task.service.base.BackgroundTaskLocalServiceBaseImpl
,
com.liferay.portal.background.task.service.impl.BackgroundTaskLocalServiceImpl
Constructor and Description |
---|
BackgroundTaskLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static BackgroundTask |
addBackgroundTask(BackgroundTask backgroundTask)
Adds the background task to the database.
|
static BackgroundTask |
addBackgroundTask(long userId,
long groupId,
java.lang.String name,
java.lang.String[] servletContextNames,
java.lang.Class<?> taskExecutorClass,
java.util.Map<java.lang.String,java.io.Serializable> taskContextMap,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static BackgroundTask |
addBackgroundTask(long userId,
long groupId,
java.lang.String name,
java.lang.String taskExecutorClassName,
java.util.Map<java.lang.String,java.io.Serializable> taskContextMap,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static void |
addBackgroundTaskAttachment(long userId,
long backgroundTaskId,
java.lang.String fileName,
java.io.File file) |
static void |
addBackgroundTaskAttachment(long userId,
long backgroundTaskId,
java.lang.String fileName,
java.io.InputStream inputStream) |
static BackgroundTask |
amendBackgroundTask(long backgroundTaskId,
java.util.Map<java.lang.String,java.io.Serializable> taskContextMap,
int status,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static BackgroundTask |
amendBackgroundTask(long backgroundTaskId,
java.util.Map<java.lang.String,java.io.Serializable> taskContextMap,
int status,
java.lang.String statusMessage,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static void |
cleanUpBackgroundTask(long backgroundTaskId,
int status) |
static void |
cleanUpBackgroundTasks() |
static BackgroundTask |
createBackgroundTask(long backgroundTaskId)
Creates a new background task with the primary key.
|
static BackgroundTask |
deleteBackgroundTask(BackgroundTask backgroundTask)
Deletes the background task from the database.
|
static BackgroundTask |
deleteBackgroundTask(long backgroundTaskId)
Deletes the background task with the primary key from the database.
|
static void |
deleteCompanyBackgroundTasks(long companyId) |
static void |
deleteGroupBackgroundTasks(long groupId) |
static void |
deleteGroupBackgroundTasks(long groupId,
java.lang.String name,
java.lang.String taskExecutorClassName) |
static com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
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 BackgroundTask |
fetchBackgroundTask(long backgroundTaskId) |
static BackgroundTask |
fetchFirstBackgroundTask(long groupId,
java.lang.String taskExecutorClassName,
boolean completed,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
static BackgroundTask |
fetchFirstBackgroundTask(java.lang.String taskExecutorClassName,
int status) |
static BackgroundTask |
fetchFirstBackgroundTask(java.lang.String taskExecutorClassName,
int status,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static BackgroundTask |
getBackgroundTask(long backgroundTaskId)
Returns the background task with the primary key.
|
static java.util.List<BackgroundTask> |
getBackgroundTasks(int start,
int end)
Returns a range of all the background tasks.
|
static java.util.List<BackgroundTask> |
getBackgroundTasks(long[] groupIds,
java.lang.String[] taskExecutorClassNames) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(long[] groupIds,
java.lang.String[] taskExecutorClassNames,
boolean completed) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(long[] groupIds,
java.lang.String[] taskExecutorClassNames,
boolean completed,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(long[] groupIds,
java.lang.String[] taskExecutorClassNames,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(long[] groupIds,
java.lang.String name,
java.lang.String taskExecutorClassName,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(long groupId,
int status) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(long groupId,
java.lang.String taskExecutorClassName) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(long groupId,
java.lang.String[] taskExecutorClassNames,
int status) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(long groupId,
java.lang.String taskExecutorClassName,
boolean completed,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(long groupId,
java.lang.String taskExecutorClassName,
int status) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(long groupId,
java.lang.String taskExecutorClassName,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(long groupId,
java.lang.String name,
java.lang.String taskExecutorClassName,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(java.lang.String[] taskExecutorClassNames,
int status) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(java.lang.String[] taskExecutorClassNames,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(java.lang.String taskExecutorClassName,
int status) |
static java.util.List<BackgroundTask> |
getBackgroundTasks(java.lang.String taskExecutorClassName,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
static int |
getBackgroundTasksCount()
Returns the number of background tasks.
|
static int |
getBackgroundTasksCount(long[] groupIds,
java.lang.String[] taskExecutorClassNames) |
static int |
getBackgroundTasksCount(long[] groupIds,
java.lang.String[] taskExecutorClassNames,
boolean completed) |
static int |
getBackgroundTasksCount(long[] groupIds,
java.lang.String name,
java.lang.String taskExecutorClassName) |
static int |
getBackgroundTasksCount(long[] groupIds,
java.lang.String name,
java.lang.String taskExecutorClassName,
boolean completed) |
static int |
getBackgroundTasksCount(long groupId,
java.lang.String taskExecutorClassName) |
static int |
getBackgroundTasksCount(long groupId,
java.lang.String taskExecutorClassName,
boolean completed) |
static int |
getBackgroundTasksCount(long groupId,
java.lang.String name,
java.lang.String taskExecutorClassName) |
static int |
getBackgroundTasksCount(long groupId,
java.lang.String name,
java.lang.String taskExecutorClassName,
boolean completed) |
static java.lang.String |
getBackgroundTaskStatusJSON(long backgroundTaskId) |
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static BackgroundTaskLocalService |
getService() |
static void |
resumeBackgroundTask(long backgroundTaskId) |
static void |
triggerBackgroundTask(long backgroundTaskId) |
static BackgroundTask |
updateBackgroundTask(BackgroundTask backgroundTask)
Updates the background task in the database or adds it if it does not yet exist.
|
public static BackgroundTask addBackgroundTask(BackgroundTask backgroundTask)
backgroundTask
- the background taskpublic static BackgroundTask addBackgroundTask(long userId, long groupId, java.lang.String name, java.lang.String taskExecutorClassName, java.util.Map<java.lang.String,java.io.Serializable> taskContextMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static BackgroundTask addBackgroundTask(long userId, long groupId, java.lang.String name, java.lang.String[] servletContextNames, java.lang.Class<?> taskExecutorClass, java.util.Map<java.lang.String,java.io.Serializable> taskContextMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static BackgroundTask amendBackgroundTask(long backgroundTaskId, java.util.Map<java.lang.String,java.io.Serializable> taskContextMap, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext)
public static BackgroundTask amendBackgroundTask(long backgroundTaskId, java.util.Map<java.lang.String,java.io.Serializable> taskContextMap, int status, java.lang.String statusMessage, com.liferay.portal.kernel.service.ServiceContext serviceContext)
public static BackgroundTask createBackgroundTask(long backgroundTaskId)
backgroundTaskId
- the primary key for the new background taskpublic static BackgroundTask deleteBackgroundTask(BackgroundTask backgroundTask) throws com.liferay.portal.kernel.exception.PortalException
backgroundTask
- the background taskPortalException
public static BackgroundTask deleteBackgroundTask(long backgroundTaskId) throws com.liferay.portal.kernel.exception.PortalException
backgroundTaskId
- the primary key of the background taskPortalException
- if a background task with the primary key could not be foundpublic static BackgroundTask fetchBackgroundTask(long backgroundTaskId)
public static BackgroundTask fetchFirstBackgroundTask(java.lang.String taskExecutorClassName, int status)
public static BackgroundTask fetchFirstBackgroundTask(java.lang.String taskExecutorClassName, int status, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
public static BackgroundTask fetchFirstBackgroundTask(long groupId, java.lang.String taskExecutorClassName, boolean completed, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
public static BackgroundTask getBackgroundTask(long backgroundTaskId) throws com.liferay.portal.kernel.exception.PortalException
backgroundTaskId
- the primary key of the background taskPortalException
- if a background task with the primary key could not be foundpublic static BackgroundTask updateBackgroundTask(BackgroundTask backgroundTask)
backgroundTask
- the background taskpublic static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
PortalException
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 int getBackgroundTasksCount()
public static int getBackgroundTasksCount(long groupId, java.lang.String name, java.lang.String taskExecutorClassName)
public static int getBackgroundTasksCount(long groupId, java.lang.String name, java.lang.String taskExecutorClassName, boolean completed)
public static int getBackgroundTasksCount(long groupId, java.lang.String taskExecutorClassName)
public static int getBackgroundTasksCount(long groupId, java.lang.String taskExecutorClassName, boolean completed)
public static int getBackgroundTasksCount(long[] groupIds, java.lang.String name, java.lang.String taskExecutorClassName)
public static int getBackgroundTasksCount(long[] groupIds, java.lang.String name, java.lang.String taskExecutorClassName, boolean completed)
public static int getBackgroundTasksCount(long[] groupIds, java.lang.String[] taskExecutorClassNames)
public static int getBackgroundTasksCount(long[] groupIds, java.lang.String[] taskExecutorClassNames, boolean completed)
public static java.lang.String getBackgroundTaskStatusJSON(long backgroundTaskId)
public static java.lang.String getOSGiServiceIdentifier()
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 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 and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from com.liferay.portal.background.task.model.impl.BackgroundTaskModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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 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 and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from com.liferay.portal.background.task.model.impl.BackgroundTaskModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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 java.util.List<BackgroundTask> getBackgroundTasks(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 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 and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from com.liferay.portal.background.task.model.impl.BackgroundTaskModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
start
- the lower bound of the range of background tasksend
- the upper bound of the range of background tasks (not inclusive)public static java.util.List<BackgroundTask> getBackgroundTasks(java.lang.String taskExecutorClassName, int status)
public static java.util.List<BackgroundTask> getBackgroundTasks(java.lang.String taskExecutorClassName, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
public static java.util.List<BackgroundTask> getBackgroundTasks(java.lang.String[] taskExecutorClassNames, int status)
public static java.util.List<BackgroundTask> getBackgroundTasks(java.lang.String[] taskExecutorClassNames, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
public static java.util.List<BackgroundTask> getBackgroundTasks(long groupId, int status)
public static java.util.List<BackgroundTask> getBackgroundTasks(long groupId, java.lang.String name, java.lang.String taskExecutorClassName, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
public static java.util.List<BackgroundTask> getBackgroundTasks(long groupId, java.lang.String taskExecutorClassName)
public static java.util.List<BackgroundTask> getBackgroundTasks(long groupId, java.lang.String taskExecutorClassName, boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
public static java.util.List<BackgroundTask> getBackgroundTasks(long groupId, java.lang.String taskExecutorClassName, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
public static java.util.List<BackgroundTask> getBackgroundTasks(long groupId, java.lang.String taskExecutorClassName, int status)
public static java.util.List<BackgroundTask> getBackgroundTasks(long groupId, java.lang.String[] taskExecutorClassNames, int status)
public static java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds, java.lang.String name, java.lang.String taskExecutorClassName, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
public static java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds, java.lang.String[] taskExecutorClassNames)
public static java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds, java.lang.String[] taskExecutorClassNames, boolean completed)
public static java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds, java.lang.String[] taskExecutorClassNames, boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
public static java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds, java.lang.String[] taskExecutorClassNames, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
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 void addBackgroundTaskAttachment(long userId, long backgroundTaskId, java.lang.String fileName, java.io.File file) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void addBackgroundTaskAttachment(long userId, long backgroundTaskId, java.lang.String fileName, java.io.InputStream inputStream) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void cleanUpBackgroundTask(long backgroundTaskId, int status)
public static void cleanUpBackgroundTasks()
public static void deleteCompanyBackgroundTasks(long companyId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void deleteGroupBackgroundTasks(long groupId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void deleteGroupBackgroundTasks(long groupId, java.lang.String name, java.lang.String taskExecutorClassName) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void resumeBackgroundTask(long backgroundTaskId)
public static void triggerBackgroundTask(long backgroundTaskId)
public static BackgroundTaskLocalService getService()