com.liferay.portal.kernel.backgroundtask

Interface BackgroundTaskManager

public interface BackgroundTaskManager

Author:

Michael C. Han

Method Summary

Modifier and Type	Method and Description
BackgroundTask	addBackgroundTask(long userId, long groupId, String name, String[] servletContextNames, Class<?> taskExecutorClass, Map<String,Serializable> taskContextMap, ServiceContext serviceContext)
BackgroundTask	addBackgroundTask(long userId, long groupId, String name, String taskExecutorClassName, Map<String,Serializable> taskContextMap, ServiceContext serviceContext)
void	addBackgroundTaskAttachment(long userId, long backgroundTaskId, String fileName, File file)
void	addBackgroundTaskAttachment(long userId, long backgroundTaskId, String fileName, InputStream inputStream)
BackgroundTask	amendBackgroundTask(long backgroundTaskId, Map<String,Serializable> taskContextMap, int status, ServiceContext serviceContext)
BackgroundTask	amendBackgroundTask(long backgroundTaskId, Map<String,Serializable> taskContextMap, int status, String statusMessage, ServiceContext serviceContext)
void	cleanUpBackgroundTask(BackgroundTask backgroundTask, int status)
void	cleanUpBackgroundTasks()
BackgroundTask	deleteBackgroundTask(long backgroundTaskId)
void	deleteCompanyBackgroundTasks(long companyId)
void	deleteGroupBackgroundTasks(long groupId)
void	deleteGroupBackgroundTasks(long groupId, String name, String taskExecutorClassName)
BackgroundTask	fetchBackgroundTask(long backgroundTaskId)
BackgroundTask	fetchFirstBackgroundTask(long groupId, String taskExecutorClassName, boolean completed, OrderByComparator<BackgroundTask> orderByComparator)
BackgroundTask	fetchFirstBackgroundTask(String taskExecutorClassName, int status)
BackgroundTask	fetchFirstBackgroundTask(String taskExecutorClassName, int status, OrderByComparator<BackgroundTask> orderByComparator)
BackgroundTask	getBackgroundTask(long backgroundTaskId)
List<BackgroundTask>	getBackgroundTasks(long[] groupIds, String taskExecutorClassName, boolean completed, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
List<BackgroundTask>	getBackgroundTasks(long[] groupIds, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
List<BackgroundTask>	getBackgroundTasks(long[] groupIds, String name, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
List<BackgroundTask>	getBackgroundTasks(long groupId, int status)
List<BackgroundTask>	getBackgroundTasks(long groupId, String taskExecutorClassName)
List<BackgroundTask>	getBackgroundTasks(long groupId, String[] taskExecutorClassNames)
List<BackgroundTask>	getBackgroundTasks(long groupId, String[] taskExecutorClassNames, int status)
List<BackgroundTask>	getBackgroundTasks(long groupId, String[] taskExecutorClassNames, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
List<BackgroundTask>	getBackgroundTasks(long groupId, String taskExecutorClassName, boolean completed, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
List<BackgroundTask>	getBackgroundTasks(long groupId, String taskExecutorClassName, int status)
List<BackgroundTask>	getBackgroundTasks(long groupId, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
List<BackgroundTask>	getBackgroundTasks(long groupId, String name, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
List<BackgroundTask>	getBackgroundTasks(String[] taskExecutorClassNames, int status)
List<BackgroundTask>	getBackgroundTasks(String[] taskExecutorClassNames, int status, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
List<BackgroundTask>	getBackgroundTasks(String taskExecutorClassName, int status)
List<BackgroundTask>	getBackgroundTasks(String taskExecutorClassName, int status, int start, int end, OrderByComparator<BackgroundTask> orderByComparator)
int	getBackgroundTasksCount(long[] groupIds, String taskExecutorClassName)
int	getBackgroundTasksCount(long[] groupIds, String taskExecutorClassName, boolean completed)
int	getBackgroundTasksCount(long[] groupIds, String name, String taskExecutorClassName)
int	getBackgroundTasksCount(long[] groupIds, String name, String taskExecutorClassName, boolean completed)
int	getBackgroundTasksCount(long groupId, String taskExecutorClassName)
int	getBackgroundTasksCount(long groupId, String[] taskExecutorClassNames)
int	getBackgroundTasksCount(long groupId, String[] taskExecutorClassNames, boolean completed)
int	getBackgroundTasksCount(long groupId, String taskExecutorClassName, boolean completed)
int	getBackgroundTasksCount(long groupId, String name, String taskExecutorClassName)
int	getBackgroundTasksCount(long groupId, String name, String taskExecutorClassName, boolean completed)
String	getBackgroundTaskStatusJSON(long backgroundTaskId)
void	resumeBackgroundTask(long backgroundTaskId)
void	triggerBackgroundTask(long backgroundTaskId)

Method Detail

addBackgroundTask

BackgroundTask addBackgroundTask(long userId,
                                 long groupId,
                                 String name,
                                 String taskExecutorClassName,
                                 Map<String,Serializable> taskContextMap,
                                 ServiceContext serviceContext)
                          throws PortalException

Throws:

PortalException

addBackgroundTask

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

Throws:

PortalException

addBackgroundTaskAttachment

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

Throws:

PortalException

addBackgroundTaskAttachment

void addBackgroundTaskAttachment(long userId,
                                 long backgroundTaskId,
                                 String fileName,
                                 InputStream inputStream)
                          throws PortalException

Throws:

PortalException

amendBackgroundTask

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

amendBackgroundTask

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

cleanUpBackgroundTask

void cleanUpBackgroundTask(BackgroundTask backgroundTask,
                           int status)

cleanUpBackgroundTasks

void cleanUpBackgroundTasks()

deleteBackgroundTask

BackgroundTask deleteBackgroundTask(long backgroundTaskId)
                             throws PortalException

Throws:

PortalException

deleteCompanyBackgroundTasks

void deleteCompanyBackgroundTasks(long companyId)
                           throws PortalException

Throws:

PortalException

deleteGroupBackgroundTasks

void deleteGroupBackgroundTasks(long groupId)
                         throws PortalException

Throws:

PortalException

deleteGroupBackgroundTasks

void deleteGroupBackgroundTasks(long groupId,
                                String name,
                                String taskExecutorClassName)
                         throws PortalException

Throws:

PortalException

fetchBackgroundTask

BackgroundTask fetchBackgroundTask(long backgroundTaskId)

fetchFirstBackgroundTask

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

fetchFirstBackgroundTask

BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName,
                                        int status)

fetchFirstBackgroundTask

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

getBackgroundTask

BackgroundTask getBackgroundTask(long backgroundTaskId)
                          throws PortalException

Throws:

PortalException

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasks

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

getBackgroundTasksCount

int getBackgroundTasksCount(long groupId,
                            String taskExecutorClassName)

getBackgroundTasksCount

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

getBackgroundTasksCount

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

getBackgroundTasksCount

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

getBackgroundTasksCount

int getBackgroundTasksCount(long groupId,
                            String[] taskExecutorClassNames)

getBackgroundTasksCount

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

getBackgroundTasksCount

int getBackgroundTasksCount(long[] groupIds,
                            String taskExecutorClassName)

getBackgroundTasksCount

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

getBackgroundTasksCount

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

getBackgroundTasksCount

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

getBackgroundTaskStatusJSON

String getBackgroundTaskStatusJSON(long backgroundTaskId)

resumeBackgroundTask

void resumeBackgroundTask(long backgroundTaskId)

triggerBackgroundTask

void triggerBackgroundTask(long backgroundTaskId)