com.liferay.portal.kernel.backgroundtask

Class BackgroundTaskManagerUtil

Object

com.liferay.portal.kernel.backgroundtask.BackgroundTaskManagerUtil

public class BackgroundTaskManagerUtil
extends 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, String name, String[] servletContextNames, Class<?> taskExecutorClass, Map<String,Serializable> taskContextMap, ServiceContext serviceContext)
static BackgroundTask	addBackgroundTask(long userId, long groupId, String name, String taskExecutorClassName, Map<String,Serializable> taskContextMap, ServiceContext serviceContext)
static void	addBackgroundTaskAttachment(long userId, long backgroundTaskId, String fileName, File file)
static BackgroundTask	amendBackgroundTask(long backgroundTaskId, Map<String,Serializable> taskContextMap, int status, ServiceContext serviceContext)
static BackgroundTask	amendBackgroundTask(long backgroundTaskId, Map<String,Serializable> taskContextMap, int status, 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, String name, String taskExecutorClassName)
static BackgroundTask	fetchBackgroundTask(long backgroundTaskId)
static BackgroundTask	fetchFirstBackgroundTask(long groupId, String taskExecutorClassName, boolean completed, OrderByComparator<BackgroundTask> orderByComparator)
static BackgroundTask	fetchFirstBackgroundTask(String taskExecutorClassName, int status)
static BackgroundTask	fetchFirstBackgroundTask(String taskExecutorClassName, int status, OrderByComparator<BackgroundTask> orderByComparator)
static BackgroundTask	getBackgroundTask(long backgroundTaskId)
static List<BackgroundTask>	getBackgroundTasks(long[] groupIds, String taskExecutorClassName, boolean completed, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
static List<BackgroundTask>	getBackgroundTasks(long[] groupIds, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
static List<BackgroundTask>	getBackgroundTasks(long[] groupIds, String name, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
static List<BackgroundTask>	getBackgroundTasks(long groupId, int status)
static List<BackgroundTask>	getBackgroundTasks(long groupId, String taskExecutorClassName)
static List<BackgroundTask>	getBackgroundTasks(long groupId, String[] taskExecutorClassNames)
static List<BackgroundTask>	getBackgroundTasks(long groupId, String[] taskExecutorClassNames, int status)
static List<BackgroundTask>	getBackgroundTasks(long groupId, String[] taskExecutorClassNames, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
static List<BackgroundTask>	getBackgroundTasks(long groupId, String taskExecutorClassName, boolean completed, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
static List<BackgroundTask>	getBackgroundTasks(long groupId, String taskExecutorClassName, int status)
static List<BackgroundTask>	getBackgroundTasks(long groupId, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
static List<BackgroundTask>	getBackgroundTasks(long groupId, String name, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
static List<BackgroundTask>	getBackgroundTasks(String[] taskExecutorClassNames, int status)
static List<BackgroundTask>	getBackgroundTasks(String[] taskExecutorClassNames, int status, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
static List<BackgroundTask>	getBackgroundTasks(String taskExecutorClassName, int status)
static List<BackgroundTask>	getBackgroundTasks(String taskExecutorClassName, int status, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
static int	getBackgroundTasksCount(long[] groupIds, String taskExecutorClassName)
static int	getBackgroundTasksCount(long[] groupIds, String taskExecutorClassName, boolean completed)
static int	getBackgroundTasksCount(long[] groupIds, String name, String taskExecutorClassName)
static int	getBackgroundTasksCount(long[] groupIds, String name, String taskExecutorClassName, boolean completed)
static int	getBackgroundTasksCount(long groupId, String taskExecutorClassName)
static int	getBackgroundTasksCount(long groupId, String[] taskExecutorClassNames)
static int	getBackgroundTasksCount(long groupId, String[] taskExecutorClassNames, boolean completed)
static int	getBackgroundTasksCount(long groupId, String taskExecutorClassName, boolean completed)
static int	getBackgroundTasksCount(long groupId, String name, String taskExecutorClassName)
static int	getBackgroundTasksCount(long groupId, String name, String taskExecutorClassName, boolean completed)
static String	getBackgroundTaskStatusJSON(long backgroundTaskId)
static void	resumeBackgroundTask(long backgroundTaskId)
static void	triggerBackgroundTask(long backgroundTaskId)

Methods inherited from class 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,
                                               String name,
                                               String taskExecutorClassName,
                                               Map<String,Serializable> taskContextMap,
                                               ServiceContext serviceContext)
                                        throws PortalException

Throws:

PortalException

addBackgroundTask

public static BackgroundTask addBackgroundTask(long userId,
                                               long groupId,
                                               String name,
                                               String[] servletContextNames,
                                               Class<?> taskExecutorClass,
                                               Map<String,Serializable> taskContextMap,
                                               ServiceContext serviceContext)
                                        throws PortalException

Throws:

PortalException

addBackgroundTaskAttachment

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

Throws:

PortalException

amendBackgroundTask

public static BackgroundTask amendBackgroundTask(long backgroundTaskId,
                                                 Map<String,Serializable> taskContextMap,
                                                 int status,
                                                 ServiceContext serviceContext)

amendBackgroundTask

public static BackgroundTask amendBackgroundTask(long backgroundTaskId,
                                                 Map<String,Serializable> taskContextMap,
                                                 int status,
                                                 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,
                                              String name,
                                              String taskExecutorClassName)
                                       throws PortalException

Throws:

PortalException

fetchBackgroundTask

public static BackgroundTask fetchBackgroundTask(long backgroundTaskId)

fetchFirstBackgroundTask

public static BackgroundTask fetchFirstBackgroundTask(long groupId,
                                                      String taskExecutorClassName,
                                                      boolean completed,
                                                      OrderByComparator<BackgroundTask> orderByComparator)

fetchFirstBackgroundTask

public static BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName,
                                                      int status)

fetchFirstBackgroundTask

public static BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName,
                                                      int status,
                                                      OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTask

public static BackgroundTask getBackgroundTask(long backgroundTaskId)
                                        throws PortalException

Throws:

PortalException

getBackgroundTasks

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

getBackgroundTasks

public static List<BackgroundTask> getBackgroundTasks(long groupId,
                                                      String taskExecutorClassName)

getBackgroundTasks

public static List<BackgroundTask> getBackgroundTasks(long groupId,
                                                      String taskExecutorClassName,
                                                      boolean completed,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTasks

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

getBackgroundTasks

public static List<BackgroundTask> getBackgroundTasks(long groupId,
                                                      String taskExecutorClassName,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTasks

public static List<BackgroundTask> getBackgroundTasks(long groupId,
                                                      String name,
                                                      String taskExecutorClassName,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

public static List<BackgroundTask> getBackgroundTasks(long groupId,
                                                      String[] taskExecutorClassNames,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

public static List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName,
                                                      int status)

getBackgroundTasks

public static List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName,
                                                      int status,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTasks

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

getBackgroundTasks

public static List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames,
                                                      int status,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<BackgroundTask> orderByComparator)

getBackgroundTasksCount

public static int getBackgroundTasksCount(long groupId,
                                          String taskExecutorClassName)

getBackgroundTasksCount

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

getBackgroundTasksCount

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

getBackgroundTasksCount

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

getBackgroundTasksCount

public static int getBackgroundTasksCount(long groupId,
                                          String[] taskExecutorClassNames)

getBackgroundTasksCount

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

getBackgroundTasksCount

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

getBackgroundTasksCount

public static int getBackgroundTasksCount(long[] groupIds,
                                          String taskExecutorClassName,
                                          boolean completed)

getBackgroundTasksCount

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

getBackgroundTasksCount

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

getBackgroundTaskStatusJSON

public static String getBackgroundTaskStatusJSON(long backgroundTaskId)

resumeBackgroundTask

public static void resumeBackgroundTask(long backgroundTaskId)

triggerBackgroundTask

public static void triggerBackgroundTask(long backgroundTaskId)