com.liferay.portal.kernel.backgroundtask

Class BackgroundTaskManagerUtil

java.lang.Object

com.liferay.portal.kernel.backgroundtask.BackgroundTaskManagerUtil

public class BackgroundTaskManagerUtil
extends java.lang.Object

Author:

Michael C. Han

Constructor Summary

Constructors

Constructor and Description
BackgroundTaskManagerUtil()

Method Summary

Modifier and Type	Method and Description
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, 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, ServiceContext serviceContext)
static void	addBackgroundTaskAttachment(long userId, long backgroundTaskId, java.lang.String fileName, java.io.File file)
static BackgroundTask	amendBackgroundTask(long backgroundTaskId, java.util.Map<java.lang.String,java.io.Serializable> taskContextMap, int status, ServiceContext serviceContext)
static BackgroundTask	amendBackgroundTask(long backgroundTaskId, java.util.Map<java.lang.String,java.io.Serializable> taskContextMap, int status, java.lang.String statusMessage, ServiceContext serviceContext)
static void	cleanUpBackgroundTask(BackgroundTask backgroundTask, int status)
static void	cleanUpBackgroundTasks()
static BackgroundTask	deleteBackgroundTask(long backgroundTaskId)
static void	deleteCompanyBackgroundTasks(long companyId)
static void	deleteGroupBackgroundTasks(long groupId)
static void	deleteGroupBackgroundTasks(long groupId, java.lang.String name, java.lang.String taskExecutorClassName)
static BackgroundTask	fetchBackgroundTask(long backgroundTaskId)
static BackgroundTask	fetchFirstBackgroundTask(long groupId, java.lang.String taskExecutorClassName, boolean completed, OrderByComparator<BackgroundTask> orderByComparator)
static BackgroundTask	fetchFirstBackgroundTask(java.lang.String taskExecutorClassName, int status)
static BackgroundTask	fetchFirstBackgroundTask(java.lang.String taskExecutorClassName, int status, OrderByComparator<BackgroundTask> orderByComparator)
static BackgroundTask	getBackgroundTask(long backgroundTaskId)
static java.util.List<BackgroundTask>	getBackgroundTasks(long[] groupIds, java.lang.String taskExecutorClassName, boolean completed, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
static java.util.List<BackgroundTask>	getBackgroundTasks(long[] groupIds, java.lang.String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
static java.util.List<BackgroundTask>	getBackgroundTasks(long[] groupIds, java.lang.String name, java.lang.String[] taskExecutorClassNames, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
static java.util.List<BackgroundTask>	getBackgroundTasks(long[] groupIds, java.lang.String name, java.lang.String taskExecutorClassName, int start, int end, 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)
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[] taskExecutorClassNames, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
static java.util.List<BackgroundTask>	getBackgroundTasks(long groupId, java.lang.String taskExecutorClassName, boolean completed, int start, int end, 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, OrderByComparator<BackgroundTask> orderByComparator)
static java.util.List<BackgroundTask>	getBackgroundTasks(long groupId, java.lang.String name, java.lang.String taskExecutorClassName, int start, int end, 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, 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, OrderByComparator<BackgroundTask> orderByComparator)
static java.util.List<BackgroundTask>	getBackgroundTasksByDuration(long[] groupIds, java.lang.String[] taskExecutorClassName, boolean completed, int start, int end, boolean orderByType)
static java.util.List<BackgroundTask>	getBackgroundTasksByDuration(long[] groupIds, java.lang.String[] taskExecutorClassName, int start, int end, boolean orderByType)
static int	getBackgroundTasksCount(long[] groupIds, java.lang.String taskExecutorClassName)
static int	getBackgroundTasksCount(long[] groupIds, java.lang.String taskExecutorClassName, 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[] taskExecutorClassNames)
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[] taskExecutorClassNames)
static int	getBackgroundTasksCount(long groupId, java.lang.String[] taskExecutorClassNames, boolean completed)
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 void	resumeBackgroundTask(long backgroundTaskId)
static void	triggerBackgroundTask(long backgroundTaskId)

Methods inherited from class java.lang.Object

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

Constructor Detail

BackgroundTaskManagerUtil

public BackgroundTaskManagerUtil()

Method Detail

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,
                                               ServiceContext serviceContext)
                                        throws PortalException

Throws:

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,
                                               ServiceContext serviceContext)
                                        throws PortalException

Throws:

PortalException

addBackgroundTaskAttachment

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

Throws:

PortalException

amendBackgroundTask

public static BackgroundTask amendBackgroundTask(long backgroundTaskId,
                                                 java.util.Map<java.lang.String,java.io.Serializable> taskContextMap,
                                                 int status,
                                                 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,
                                                 ServiceContext serviceContext)

cleanUpBackgroundTask

public static void cleanUpBackgroundTask(BackgroundTask backgroundTask,
                                         int status)

cleanUpBackgroundTasks

public static void cleanUpBackgroundTasks()

deleteBackgroundTask

public static BackgroundTask deleteBackgroundTask(long backgroundTaskId)
                                           throws PortalException

Throws:

PortalException

deleteCompanyBackgroundTasks

public static void deleteCompanyBackgroundTasks(long companyId)
                                         throws PortalException

Throws:

PortalException

deleteGroupBackgroundTasks

public static void deleteGroupBackgroundTasks(long groupId)
                                       throws PortalException

Throws:

PortalException

deleteGroupBackgroundTasks

public static void deleteGroupBackgroundTasks(long groupId,
                                              java.lang.String name,
                                              java.lang.String taskExecutorClassName)
                                       throws PortalException

Throws:

PortalException

fetchBackgroundTask

public static BackgroundTask fetchBackgroundTask(long backgroundTaskId)

fetchFirstBackgroundTask

public static BackgroundTask fetchFirstBackgroundTask(long groupId,
                                                      java.lang.String taskExecutorClassName,
                                                      boolean completed,
                                                      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,
                                                      OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTask

public static BackgroundTask getBackgroundTask(long backgroundTaskId)
                                        throws PortalException

Throws:

PortalException

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,
                                                                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,
                                                                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,
                                                                OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTasks

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

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 groupId,
                                                                java.lang.String[] taskExecutorClassNames,
                                                                int start,
                                                                int end,
                                                                OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTasks

public static java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds,
                                                                java.lang.String taskExecutorClassName,
                                                                boolean completed,
                                                                int start,
                                                                int end,
                                                                OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTasks

public static java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds,
                                                                java.lang.String taskExecutorClassName,
                                                                int start,
                                                                int end,
                                                                OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTasks

public static java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds,
                                                                java.lang.String name,
                                                                java.lang.String taskExecutorClassName,
                                                                int start,
                                                                int end,
                                                                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,
                                                                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,
                                                                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,
                                                                OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTasksByDuration

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

getBackgroundTasksByDuration

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

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 groupId,
                                          java.lang.String[] taskExecutorClassNames)

getBackgroundTasksCount

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

getBackgroundTasksCount

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

getBackgroundTasksCount

public static int getBackgroundTasksCount(long[] groupIds,
                                          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[] taskExecutorClassNames)

getBackgroundTaskStatusJSON

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

resumeBackgroundTask

public static void resumeBackgroundTask(long backgroundTaskId)

triggerBackgroundTask

public static void triggerBackgroundTask(long backgroundTaskId)