@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface BackgroundTaskLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
BackgroundTaskLocalServiceUtil
,
com.liferay.portal.background.task.service.base.BackgroundTaskLocalServiceBaseImpl
,
com.liferay.portal.background.task.service.impl.BackgroundTaskLocalServiceImpl
Modifier and Type | Method and Description |
---|---|
BackgroundTask |
addBackgroundTask(BackgroundTask backgroundTask)
Adds the background task to the database.
|
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) |
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) |
void |
addBackgroundTaskAttachment(long userId,
long backgroundTaskId,
java.lang.String fileName,
java.io.File file) |
void |
addBackgroundTaskAttachment(long userId,
long backgroundTaskId,
java.lang.String fileName,
java.io.InputStream inputStream) |
BackgroundTask |
amendBackgroundTask(long backgroundTaskId,
java.util.Map<java.lang.String,java.io.Serializable> taskContextMap,
int status,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
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) |
void |
cleanUpBackgroundTask(long backgroundTaskId,
int status) |
void |
cleanUpBackgroundTasks() |
BackgroundTask |
createBackgroundTask(long backgroundTaskId)
Creates a new background task with the primary key.
|
BackgroundTask |
deleteBackgroundTask(BackgroundTask backgroundTask)
Deletes the background task from the database.
|
BackgroundTask |
deleteBackgroundTask(long backgroundTaskId)
Deletes the background task with the primary key from the database.
|
void |
deleteCompanyBackgroundTasks(long companyId) |
void |
deleteGroupBackgroundTasks(long groupId) |
void |
deleteGroupBackgroundTasks(long groupId,
java.lang.String name,
java.lang.String taskExecutorClassName) |
com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
<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.
|
<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.
|
<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.
|
long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
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.
|
BackgroundTask |
fetchBackgroundTask(long backgroundTaskId) |
BackgroundTask |
fetchFirstBackgroundTask(long groupId,
java.lang.String taskExecutorClassName,
boolean completed,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
BackgroundTask |
fetchFirstBackgroundTask(java.lang.String taskExecutorClassName,
int status) |
BackgroundTask |
fetchFirstBackgroundTask(java.lang.String taskExecutorClassName,
int status,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
BackgroundTask |
getBackgroundTask(long backgroundTaskId)
Returns the background task with the primary key.
|
java.util.List<BackgroundTask> |
getBackgroundTasks(int start,
int end)
Returns a range of all the background tasks.
|
java.util.List<BackgroundTask> |
getBackgroundTasks(long[] groupIds,
java.lang.String[] taskExecutorClassNames) |
java.util.List<BackgroundTask> |
getBackgroundTasks(long[] groupIds,
java.lang.String[] taskExecutorClassNames,
boolean completed) |
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) |
java.util.List<BackgroundTask> |
getBackgroundTasks(long[] groupIds,
java.lang.String[] taskExecutorClassNames,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
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) |
java.util.List<BackgroundTask> |
getBackgroundTasks(long groupId,
int status) |
java.util.List<BackgroundTask> |
getBackgroundTasks(long groupId,
java.lang.String taskExecutorClassName) |
java.util.List<BackgroundTask> |
getBackgroundTasks(long groupId,
java.lang.String[] taskExecutorClassNames,
int status) |
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) |
java.util.List<BackgroundTask> |
getBackgroundTasks(long groupId,
java.lang.String taskExecutorClassName,
int status) |
java.util.List<BackgroundTask> |
getBackgroundTasks(long groupId,
java.lang.String taskExecutorClassName,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
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) |
java.util.List<BackgroundTask> |
getBackgroundTasks(java.lang.String[] taskExecutorClassNames,
int status) |
java.util.List<BackgroundTask> |
getBackgroundTasks(java.lang.String[] taskExecutorClassNames,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
java.util.List<BackgroundTask> |
getBackgroundTasks(java.lang.String taskExecutorClassName,
int status) |
java.util.List<BackgroundTask> |
getBackgroundTasks(java.lang.String taskExecutorClassName,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator) |
int |
getBackgroundTasksCount()
Returns the number of background tasks.
|
int |
getBackgroundTasksCount(long[] groupIds,
java.lang.String[] taskExecutorClassNames) |
int |
getBackgroundTasksCount(long[] groupIds,
java.lang.String[] taskExecutorClassNames,
boolean completed) |
int |
getBackgroundTasksCount(long[] groupIds,
java.lang.String name,
java.lang.String taskExecutorClassName) |
int |
getBackgroundTasksCount(long[] groupIds,
java.lang.String name,
java.lang.String taskExecutorClassName,
boolean completed) |
int |
getBackgroundTasksCount(long groupId,
java.lang.String taskExecutorClassName) |
int |
getBackgroundTasksCount(long groupId,
java.lang.String taskExecutorClassName,
boolean completed) |
int |
getBackgroundTasksCount(long groupId,
java.lang.String name,
java.lang.String taskExecutorClassName) |
int |
getBackgroundTasksCount(long groupId,
java.lang.String name,
java.lang.String taskExecutorClassName,
boolean completed) |
java.lang.String |
getBackgroundTaskStatusJSON(long backgroundTaskId) |
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
void |
resumeBackgroundTask(long backgroundTaskId) |
void |
triggerBackgroundTask(long backgroundTaskId) |
BackgroundTask |
updateBackgroundTask(BackgroundTask backgroundTask)
Updates the background task in the database or adds it if it does not yet exist.
|
@Indexable(type=REINDEX) BackgroundTask addBackgroundTask(BackgroundTask backgroundTask)
backgroundTask
- the background taskBackgroundTask 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
com.liferay.portal.kernel.exception.PortalException
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
com.liferay.portal.kernel.exception.PortalException
BackgroundTask amendBackgroundTask(long backgroundTaskId, java.util.Map<java.lang.String,java.io.Serializable> taskContextMap, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext)
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)
BackgroundTask createBackgroundTask(long backgroundTaskId)
backgroundTaskId
- the primary key for the new background task@Indexable(type=DELETE) BackgroundTask deleteBackgroundTask(BackgroundTask backgroundTask) throws com.liferay.portal.kernel.exception.PortalException
backgroundTask
- the background taskcom.liferay.portal.kernel.exception.PortalException
@Indexable(type=DELETE) BackgroundTask deleteBackgroundTask(long backgroundTaskId) throws com.liferay.portal.kernel.exception.PortalException
backgroundTaskId
- the primary key of the background taskcom.liferay.portal.kernel.exception.PortalException
- if a background task with the primary key could not be found@Transactional(propagation=SUPPORTS, readOnly=true) BackgroundTask fetchBackgroundTask(long backgroundTaskId)
@Transactional(propagation=SUPPORTS, readOnly=true) BackgroundTask fetchFirstBackgroundTask(java.lang.String taskExecutorClassName, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) BackgroundTask fetchFirstBackgroundTask(java.lang.String taskExecutorClassName, int status, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
@Transactional(propagation=SUPPORTS, readOnly=true) BackgroundTask fetchFirstBackgroundTask(long groupId, java.lang.String taskExecutorClassName, boolean completed, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
@Transactional(propagation=SUPPORTS, readOnly=true) BackgroundTask getBackgroundTask(long backgroundTaskId) throws com.liferay.portal.kernel.exception.PortalException
backgroundTaskId
- the primary key of the background taskcom.liferay.portal.kernel.exception.PortalException
- if a background task with the primary key could not be found@Indexable(type=REINDEX) BackgroundTask updateBackgroundTask(BackgroundTask backgroundTask)
backgroundTask
- the background task@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
deletePersistedModel
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
com.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
getPersistedModel
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
com.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount()
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long groupId, java.lang.String name, java.lang.String taskExecutorClassName)
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long groupId, java.lang.String name, java.lang.String taskExecutorClassName, boolean completed)
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long groupId, java.lang.String taskExecutorClassName)
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long groupId, java.lang.String taskExecutorClassName, boolean completed)
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long[] groupIds, java.lang.String name, java.lang.String taskExecutorClassName)
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long[] groupIds, java.lang.String name, java.lang.String taskExecutorClassName, boolean completed)
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long[] groupIds, java.lang.String[] taskExecutorClassNames)
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long[] groupIds, java.lang.String[] taskExecutorClassNames, boolean completed)
@Clusterable(onMaster=true) @Transactional(propagation=SUPPORTS, readOnly=true) java.lang.String getBackgroundTaskStatusJSON(long backgroundTaskId)
java.lang.String getOSGiServiceIdentifier()
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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 com.liferay.portal.background.task.model.impl.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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)<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)
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 com.liferay.portal.background.task.model.impl.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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<BackgroundTask> getBackgroundTasks(int start, int end)
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 com.liferay.portal.background.task.model.impl.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.
start
- the lower bound of the range of background tasksend
- the upper bound of the range of background tasks (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<BackgroundTask> getBackgroundTasks(java.lang.String taskExecutorClassName, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<BackgroundTask> getBackgroundTasks(java.lang.String taskExecutorClassName, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<BackgroundTask> getBackgroundTasks(java.lang.String[] taskExecutorClassNames, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<BackgroundTask> getBackgroundTasks(java.lang.String[] taskExecutorClassNames, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<BackgroundTask> getBackgroundTasks(long groupId, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) 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)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<BackgroundTask> getBackgroundTasks(long groupId, java.lang.String taskExecutorClassName)
@Transactional(propagation=SUPPORTS, readOnly=true) 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)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<BackgroundTask> getBackgroundTasks(long groupId, java.lang.String taskExecutorClassName, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<BackgroundTask> getBackgroundTasks(long groupId, java.lang.String taskExecutorClassName, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<BackgroundTask> getBackgroundTasks(long groupId, java.lang.String[] taskExecutorClassNames, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) 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)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds, java.lang.String[] taskExecutorClassNames)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds, java.lang.String[] taskExecutorClassNames, boolean completed)
@Transactional(propagation=SUPPORTS, readOnly=true) 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)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<BackgroundTask> getBackgroundTasks(long[] groupIds, java.lang.String[] taskExecutorClassNames, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querylong dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the queryvoid addBackgroundTaskAttachment(long userId, long backgroundTaskId, java.lang.String fileName, java.io.File file) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
void addBackgroundTaskAttachment(long userId, long backgroundTaskId, java.lang.String fileName, java.io.InputStream inputStream) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Clusterable(onMaster=true) void cleanUpBackgroundTask(long backgroundTaskId, int status)
@Clusterable(onMaster=true) void cleanUpBackgroundTasks()
void deleteCompanyBackgroundTasks(long companyId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
void deleteGroupBackgroundTasks(long groupId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
void deleteGroupBackgroundTasks(long groupId, java.lang.String name, java.lang.String taskExecutorClassName) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Clusterable(onMaster=true) void resumeBackgroundTask(long backgroundTaskId)
@Clusterable(onMaster=true) void triggerBackgroundTask(long backgroundTaskId)