com.liferay.portal.service
Class BackgroundTaskLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.BackgroundTaskLocalServiceUtil

@ProviderType
public class BackgroundTaskLocalServiceUtil
extends Object

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

See Also:

BackgroundTaskLocalService, BackgroundTaskLocalServiceBaseImpl, com.liferay.portal.service.impl.BackgroundTaskLocalServiceImpl

Constructor Summary

BackgroundTaskLocalServiceUtil()

Method Summary

static BackgroundTask	addBackgroundTask(BackgroundTask backgroundTask) Adds the background task to the database.
static BackgroundTask	addBackgroundTask(long userId, long groupId, String name, String[] servletContextNames, Class<?> taskExecutorClass, Map<String,Serializable> taskContextMap, ServiceContext serviceContext)
static void	addBackgroundTaskAttachment(long userId, long backgroundTaskId, String fileName, File file)
static void	addBackgroundTaskAttachment(long userId, long backgroundTaskId, String fileName, InputStream inputStream)
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	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 DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static BackgroundTask	fetchBackgroundTask(long backgroundTaskId)
static BackgroundTask	fetchFirstBackgroundTask(long groupId, String taskExecutorClassName, boolean completed, OrderByComparator orderByComparator)
static BackgroundTask	fetchFirstBackgroundTask(String taskExecutorClassName, int status)
static BackgroundTask	fetchFirstBackgroundTask(String taskExecutorClassName, int status, OrderByComparator orderByComparator)
static BackgroundTask	getBackgroundTask(long backgroundTaskId) Returns the background task with the primary key.
static List<BackgroundTask>	getBackgroundTasks(int start, int end) Returns a range of all the background tasks.
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 orderByComparator)
static List<BackgroundTask>	getBackgroundTasks(long groupId, String taskExecutorClassName, int status)
static List<BackgroundTask>	getBackgroundTasks(long groupId, String taskExecutorClassName, int start, int end, OrderByComparator orderByComparator)
static List<BackgroundTask>	getBackgroundTasks(long groupId, String name, String taskExecutorClassName, int start, int end, OrderByComparator orderByComparator)
static List<BackgroundTask>	getBackgroundTasks(String[] taskExecutorClassNames, int status)
static List<BackgroundTask>	getBackgroundTasks(String[] taskExecutorClassNames, int status, int start, int end, OrderByComparator orderByComparator)
static List<BackgroundTask>	getBackgroundTasks(String taskExecutorClassName, int status)
static List<BackgroundTask>	getBackgroundTasks(String taskExecutorClassName, int status, int start, int end, OrderByComparator orderByComparator)
static int	getBackgroundTasksCount() Returns the number of background tasks.
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 String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static BackgroundTaskLocalService	getService()
static void	resumeBackgroundTask(long backgroundTaskId)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(BackgroundTaskLocalService service) Deprecated. As of 6.2.0
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)
                                        throws SystemException

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

Parameters:

backgroundTask - the background task

Returns:

the background task that was added

Throws:

SystemException - if a system exception occurred

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

deleteBackgroundTask

public static BackgroundTask deleteBackgroundTask(long backgroundTaskId)
                                           throws PortalException,
                                                  SystemException

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

Parameters:

backgroundTaskId - the primary key of the background task

Returns:

the background task that was removed

Throws:

PortalException - if a background task with the primary key could not be found

SystemException - if a system exception occurred

deleteBackgroundTask

public static BackgroundTask deleteBackgroundTask(BackgroundTask backgroundTask)
                                           throws PortalException,
                                                  SystemException

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

Parameters:

backgroundTask - the background task

Returns:

the background task that was removed

Throws:

PortalException

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

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

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

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

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchBackgroundTask

public static BackgroundTask fetchBackgroundTask(long backgroundTaskId)
                                          throws SystemException

Throws:

SystemException

getBackgroundTask

public static BackgroundTask getBackgroundTask(long backgroundTaskId)
                                        throws PortalException,
                                               SystemException

Returns the background task with the primary key.

Parameters:

backgroundTaskId - the primary key of the background task

Returns:

the background task

Throws:

PortalException - if a background task with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getBackgroundTasks

public static List<BackgroundTask> getBackgroundTasks(int start,
                                                      int end)
                                               throws SystemException

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

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

Throws:

SystemException - if a system exception occurred

getBackgroundTasksCount

public static int getBackgroundTasksCount()
                                   throws SystemException

Returns the number of background tasks.

Returns:

the number of background tasks

Throws:

SystemException - if a system exception occurred

updateBackgroundTask

public static BackgroundTask updateBackgroundTask(BackgroundTask backgroundTask)
                                           throws SystemException

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

Parameters:

backgroundTask - the background task

Returns:

the background task that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addBackgroundTask

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

Throws:

PortalException

SystemException

addBackgroundTaskAttachment

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

Throws:

PortalException

SystemException

addBackgroundTaskAttachment

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

Throws:

PortalException

SystemException

amendBackgroundTask

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

Throws:

SystemException

amendBackgroundTask

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

Throws:

SystemException

cleanUpBackgroundTask

public static void cleanUpBackgroundTask(BackgroundTask backgroundTask,
                                         int status)

cleanUpBackgroundTasks

public static void cleanUpBackgroundTasks()
                                   throws SystemException

Throws:

SystemException

deleteCompanyBackgroundTasks

public static void deleteCompanyBackgroundTasks(long companyId)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

deleteGroupBackgroundTasks

public static void deleteGroupBackgroundTasks(long groupId)
                                       throws PortalException,
                                              SystemException

Throws:

PortalException

SystemException

fetchFirstBackgroundTask

public static BackgroundTask fetchFirstBackgroundTask(long groupId,
                                                      String taskExecutorClassName,
                                                      boolean completed,
                                                      OrderByComparator orderByComparator)
                                               throws SystemException

Throws:

SystemException

fetchFirstBackgroundTask

public static BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName,
                                                      int status)
                                               throws SystemException

Throws:

SystemException

fetchFirstBackgroundTask

public static BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName,
                                                      int status,
                                                      OrderByComparator orderByComparator)
                                               throws SystemException

Throws:

SystemException

getBackgroundTasks

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

Throws:

SystemException

getBackgroundTasks

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

Throws:

SystemException

getBackgroundTasks

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

Throws:

SystemException

getBackgroundTasks

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

Throws:

SystemException

getBackgroundTasks

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

Throws:

SystemException

getBackgroundTasks

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

Throws:

SystemException

getBackgroundTasks

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

Throws:

SystemException

getBackgroundTasks

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

Throws:

SystemException

getBackgroundTasks

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

Throws:

SystemException

getBackgroundTasks

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

Throws:

SystemException

getBackgroundTasks

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

Throws:

SystemException

getBackgroundTasks

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

Throws:

SystemException

getBackgroundTasksCount

public static int getBackgroundTasksCount(long groupId,
                                          String taskExecutorClassName)
                                   throws SystemException

Throws:

SystemException

getBackgroundTasksCount

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

Throws:

SystemException

getBackgroundTasksCount

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

Throws:

SystemException

getBackgroundTasksCount

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

Throws:

SystemException

getBackgroundTasksCount

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

Throws:

SystemException

getBackgroundTasksCount

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

Throws:

SystemException

getBackgroundTaskStatusJSON

public static String getBackgroundTaskStatusJSON(long backgroundTaskId)

resumeBackgroundTask

public static void resumeBackgroundTask(long backgroundTaskId)
                                 throws SystemException

Throws:

SystemException

triggerBackgroundTask

public static void triggerBackgroundTask(long backgroundTaskId)

getService

public static BackgroundTaskLocalService getService()

setService

public void setService(BackgroundTaskLocalService service)

Deprecated. As of 6.2.0