com.liferay.portal.background.task.service

Class BackgroundTaskLocalServiceUtil

java.lang.Object

com.liferay.portal.background.task.service.BackgroundTaskLocalServiceUtil

public class BackgroundTaskLocalServiceUtil
extends java.lang.Object

Provides the local service utility for BackgroundTask. This utility wraps com.liferay.portal.background.task.service.impl.BackgroundTaskLocalServiceImpl 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:

BackgroundTaskLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
BackgroundTaskLocalServiceUtil()

Method Summary

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 com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
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 <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 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[] 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 java.util.List<BackgroundTask>	getBackgroundTasksByDuration(long[] groupIds, java.lang.String[] taskExecutorClassNames, boolean completed, int start, int end, boolean orderByType)
static java.util.List<BackgroundTask>	getBackgroundTasksByDuration(long[] groupIds, java.lang.String[] taskExecutorClassNames, int start, int end, boolean orderByType)
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)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BackgroundTaskLocalServiceUtil

public BackgroundTaskLocalServiceUtil()

Method Detail

addBackgroundTask

public static BackgroundTask addBackgroundTask(BackgroundTask backgroundTask)

Adds the background task to the database. Also notifies the appropriate model listeners.

Important: Inspect BackgroundTaskLocalServiceImpl 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:

backgroundTask - the background task

Returns:

the background task that was added

addBackgroundTask

public 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

Throws:

com.liferay.portal.kernel.exception.PortalException

addBackgroundTask

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

Throws:

com.liferay.portal.kernel.exception.PortalException

addBackgroundTaskAttachment

public static void addBackgroundTaskAttachment(long userId,
                                               long backgroundTaskId,
                                               java.lang.String fileName,
                                               java.io.File file)
                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addBackgroundTaskAttachment

public static void addBackgroundTaskAttachment(long userId,
                                               long backgroundTaskId,
                                               java.lang.String fileName,
                                               java.io.InputStream inputStream)
                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

amendBackgroundTask

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)

amendBackgroundTask

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)

cleanUpBackgroundTask

public static void cleanUpBackgroundTask(long backgroundTaskId,
                                         int status)

cleanUpBackgroundTasks

public static void cleanUpBackgroundTasks()

createBackgroundTask

public static BackgroundTask createBackgroundTask(long backgroundTaskId)

Creates a new background task with the primary key. Does not add the background task to the database.

Parameters:

backgroundTaskId - the primary key for the new background task

Returns:

the new background task

createPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteBackgroundTask

public static BackgroundTask deleteBackgroundTask(BackgroundTask backgroundTask)
                                           throws com.liferay.portal.kernel.exception.PortalException

Deletes the background task from the database. Also notifies the appropriate model listeners.

Important: Inspect BackgroundTaskLocalServiceImpl 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:

backgroundTask - the background task

Returns:

the background task that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteBackgroundTask

public static BackgroundTask deleteBackgroundTask(long backgroundTaskId)
                                           throws com.liferay.portal.kernel.exception.PortalException

Deletes the background task with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect BackgroundTaskLocalServiceImpl 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:

backgroundTaskId - the primary key of the background task

Returns:

the background task that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a background task with the primary key could not be found

deleteCompanyBackgroundTasks

public static void deleteCompanyBackgroundTasks(long companyId)
                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteGroupBackgroundTasks

public static void deleteGroupBackgroundTasks(long groupId)
                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteGroupBackgroundTasks

public static void deleteGroupBackgroundTasks(long groupId,
                                              java.lang.String name,
                                              java.lang.String taskExecutorClassName)
                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

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> 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.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

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

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.portal.background.task.model.impl.BackgroundTaskModelImpl.

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> 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.

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.portal.background.task.model.impl.BackgroundTaskModelImpl.

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

fetchBackgroundTask

public static BackgroundTask fetchBackgroundTask(long backgroundTaskId)

fetchFirstBackgroundTask

public static BackgroundTask fetchFirstBackgroundTask(long groupId,
                                                      java.lang.String taskExecutorClassName,
                                                      boolean completed,
                                                      com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)

fetchFirstBackgroundTask

public static BackgroundTask fetchFirstBackgroundTask(java.lang.String taskExecutorClassName,
                                                      int status)

fetchFirstBackgroundTask

public static BackgroundTask fetchFirstBackgroundTask(java.lang.String taskExecutorClassName,
                                                      int status,
                                                      com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)

getActionableDynamicQuery

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

getBackgroundTask

public static BackgroundTask getBackgroundTask(long backgroundTaskId)
                                        throws com.liferay.portal.kernel.exception.PortalException

Returns the background task with the primary key.

Parameters:

backgroundTaskId - the primary key of the background task

Returns:

the background task

Throws:

com.liferay.portal.kernel.exception.PortalException - if a background task with the primary key could not be found

getBackgroundTasks

public static java.util.List<BackgroundTask> getBackgroundTasks(int start,
                                                                int end)

Returns a range of all the background tasks.

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.portal.background.task.model.impl.BackgroundTaskModelImpl.

Parameters:

start - the lower bound of the range of background tasks

end - the upper bound of the range of background tasks (not inclusive)

Returns:

the range of background tasks

getBackgroundTasks

public static java.util.List<BackgroundTask> getBackgroundTasks(long groupId,
                                                                int status)

getBackgroundTasks

public static java.util.List<BackgroundTask> getBackgroundTasks(long groupId,
                                                                java.lang.String taskExecutorClassName)

getBackgroundTasks

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)

getBackgroundTasks

public static java.util.List<BackgroundTask> getBackgroundTasks(long groupId,
                                                                java.lang.String taskExecutorClassName,
                                                                int status)

getBackgroundTasks

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)

getBackgroundTasks

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)

getBackgroundTasks

public static java.util.List<BackgroundTask> getBackgroundTasks(long groupId,
                                                                java.lang.String[] taskExecutorClassNames,
                                                                int status)

getBackgroundTasks

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)

getBackgroundTasks

public static java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds,
                                                                java.lang.String name,
                                                                java.lang.String[] taskExecutorClassNames,
                                                                int start,
                                                                int end,
                                                                com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTasks

public static java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds,
                                                                java.lang.String[] taskExecutorClassNames)

getBackgroundTasks

public static java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds,
                                                                java.lang.String[] taskExecutorClassNames,
                                                                boolean completed)

getBackgroundTasks

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)

getBackgroundTasks

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)

getBackgroundTasks

public static java.util.List<BackgroundTask> getBackgroundTasks(java.lang.String taskExecutorClassName,
                                                                int status)

getBackgroundTasks

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)

getBackgroundTasks

public static java.util.List<BackgroundTask> getBackgroundTasks(java.lang.String[] taskExecutorClassNames,
                                                                int status)

getBackgroundTasks

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)

getBackgroundTasksByDuration

public static java.util.List<BackgroundTask> getBackgroundTasksByDuration(long[] groupIds,
                                                                          java.lang.String[] taskExecutorClassNames,
                                                                          boolean completed,
                                                                          int start,
                                                                          int end,
                                                                          boolean orderByType)

getBackgroundTasksByDuration

public static java.util.List<BackgroundTask> getBackgroundTasksByDuration(long[] groupIds,
                                                                          java.lang.String[] taskExecutorClassNames,
                                                                          int start,
                                                                          int end,
                                                                          boolean orderByType)

getBackgroundTasksCount

public static int getBackgroundTasksCount()

Returns the number of background tasks.

Returns:

the number of background tasks

getBackgroundTasksCount

public static int getBackgroundTasksCount(long groupId,
                                          java.lang.String taskExecutorClassName)

getBackgroundTasksCount

public static int getBackgroundTasksCount(long groupId,
                                          java.lang.String taskExecutorClassName,
                                          boolean completed)

getBackgroundTasksCount

public static int getBackgroundTasksCount(long groupId,
                                          java.lang.String name,
                                          java.lang.String taskExecutorClassName)

getBackgroundTasksCount

public static int getBackgroundTasksCount(long groupId,
                                          java.lang.String name,
                                          java.lang.String taskExecutorClassName,
                                          boolean completed)

getBackgroundTasksCount

public static int getBackgroundTasksCount(long[] groupIds,
                                          java.lang.String name,
                                          java.lang.String taskExecutorClassName)

getBackgroundTasksCount

public static int getBackgroundTasksCount(long[] groupIds,
                                          java.lang.String name,
                                          java.lang.String taskExecutorClassName,
                                          boolean completed)

getBackgroundTasksCount

public static int getBackgroundTasksCount(long[] groupIds,
                                          java.lang.String name,
                                          java.lang.String[] taskExecutorClassName)

getBackgroundTasksCount

public static int getBackgroundTasksCount(long[] groupIds,
                                          java.lang.String[] taskExecutorClassNames)

getBackgroundTasksCount

public static int getBackgroundTasksCount(long[] groupIds,
                                          java.lang.String[] taskExecutorClassNames,
                                          boolean completed)

getBackgroundTaskStatusJSON

public static java.lang.String getBackgroundTaskStatusJSON(long backgroundTaskId)

getIndexableActionableDynamicQuery

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

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

resumeBackgroundTask

public static void resumeBackgroundTask(long backgroundTaskId)

triggerBackgroundTask

public static void triggerBackgroundTask(long backgroundTaskId)

updateBackgroundTask

public static BackgroundTask updateBackgroundTask(BackgroundTask backgroundTask)

Updates the background task in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect BackgroundTaskLocalServiceImpl 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:

backgroundTask - the background task

Returns:

the background task that was updated

getService

public static BackgroundTaskLocalService getService()