|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface BackgroundTaskLocalServiceProvides the local service interface for BackgroundTask. 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.
BackgroundTaskLocalServiceUtil,
BackgroundTaskLocalServiceBaseImpl,
com.liferay.portal.service.impl.BackgroundTaskLocalServiceImpl| Method Summary | ||
|---|---|---|
BackgroundTask |
addBackgroundTask(BackgroundTask backgroundTask)
Adds the background task to the database. |
|
BackgroundTask |
addBackgroundTask(long userId,
long groupId,
String name,
String[] servletContextNames,
Class<?> taskExecutorClass,
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 |
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)
|
|
PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
DynamicQuery |
dynamicQuery()
|
|
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows. |
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query. |
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
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)
|
|
ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
BackgroundTask |
getBackgroundTask(long backgroundTaskId)
Returns the background task with the primary key. |
|
List<BackgroundTask> |
getBackgroundTasks(int start,
int end)
Returns a range of all the background tasks. |
|
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,
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()
Returns the number of background tasks. |
|
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)
|
|
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
|
void |
resumeBackgroundTask(long backgroundTaskId)
|
|
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
|
void |
triggerBackgroundTask(long backgroundTaskId)
|
|
BackgroundTask |
updateBackgroundTask(BackgroundTask backgroundTask)
Updates the background task in the database or adds it if it does not yet exist. |
|
| Method Detail |
|---|
@Indexable(type=REINDEX) BackgroundTask addBackgroundTask(BackgroundTask backgroundTask)
backgroundTask - the background task
BackgroundTask addBackgroundTask(long userId,
long groupId,
String name,
String[] servletContextNames,
Class<?> taskExecutorClass,
Map<String,Serializable> taskContextMap,
ServiceContext serviceContext)
throws PortalException
PortalException
void addBackgroundTaskAttachment(long userId,
long backgroundTaskId,
String fileName,
File file)
throws PortalException
PortalException
void addBackgroundTaskAttachment(long userId,
long backgroundTaskId,
String fileName,
InputStream inputStream)
throws PortalException
PortalException
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)
@Clusterable(onMaster=true)
void cleanUpBackgroundTask(BackgroundTask backgroundTask,
int status)
@Clusterable(onMaster=true) void cleanUpBackgroundTasks()
BackgroundTask createBackgroundTask(long backgroundTaskId)
backgroundTaskId - the primary key for the new background task
@Indexable(type=DELETE)
BackgroundTask deleteBackgroundTask(BackgroundTask backgroundTask)
throws PortalException
backgroundTask - the background task
PortalException
@Indexable(type=DELETE)
BackgroundTask deleteBackgroundTask(long backgroundTaskId)
throws PortalException
backgroundTaskId - the primary key of the background task
PortalException - if a background task with the primary key could not be found
void deleteCompanyBackgroundTasks(long companyId)
throws PortalException
PortalException
void deleteGroupBackgroundTasks(long groupId)
throws PortalException
PortalException
PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
deletePersistedModel in interface PersistedModelLocalServicePortalExceptionDynamicQuery dynamicQuery()
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
<T> List<T> dynamicQuery(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 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> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
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 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)
long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
@Transactional(propagation=SUPPORTS,
readOnly=true)
BackgroundTask fetchBackgroundTask(long backgroundTaskId)
@Transactional(propagation=SUPPORTS,
readOnly=true)
BackgroundTask fetchFirstBackgroundTask(long groupId,
String taskExecutorClassName,
boolean completed,
OrderByComparator<BackgroundTask> orderByComparator)
@Transactional(propagation=SUPPORTS,
readOnly=true)
BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName,
int status)
@Transactional(propagation=SUPPORTS,
readOnly=true)
BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName,
int status,
OrderByComparator<BackgroundTask> orderByComparator)
@Transactional(propagation=SUPPORTS,
readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(propagation=SUPPORTS,
readOnly=true)
BackgroundTask getBackgroundTask(long backgroundTaskId)
throws PortalException
backgroundTaskId - the primary key of the background task
PortalException - if a background task with the primary key could not be found
@Clusterable(onMaster=true)
@Transactional(propagation=SUPPORTS,
readOnly=true)
String getBackgroundTaskStatusJSON(long backgroundTaskId)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
String name,
String taskExecutorClassName,
int start,
int end,
OrderByComparator<BackgroundTask> orderByComparator)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
int status)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
String taskExecutorClassName)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
String taskExecutorClassName,
int start,
int end,
OrderByComparator<BackgroundTask> orderByComparator)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
String taskExecutorClassName,
int status)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
String[] taskExecutorClassNames)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
String[] taskExecutorClassNames,
int start,
int end,
OrderByComparator<BackgroundTask> orderByComparator)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
String[] taskExecutorClassNames,
int status)
@Transactional(propagation=SUPPORTS,
readOnly=true)
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 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)
List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName,
int status)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName,
int status,
int start,
int end,
OrderByComparator<BackgroundTask> orderByComparator)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames,
int status)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames,
int status,
int start,
int end,
OrderByComparator<BackgroundTask> orderByComparator)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getBackgroundTasksCount()
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getBackgroundTasksCount(long groupId,
String name,
String taskExecutorClassName)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getBackgroundTasksCount(long groupId,
String name,
String taskExecutorClassName,
boolean completed)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getBackgroundTasksCount(long groupId,
String taskExecutorClassName)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getBackgroundTasksCount(long groupId,
String taskExecutorClassName,
boolean completed)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getBackgroundTasksCount(long groupId,
String[] taskExecutorClassNames)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getBackgroundTasksCount(long groupId,
String[] taskExecutorClassNames,
boolean completed)
String getBeanIdentifier()
@Transactional(propagation=SUPPORTS,
readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
getPersistedModel in interface PersistedModelLocalServicePortalException@Clusterable(onMaster=true) void resumeBackgroundTask(long backgroundTaskId)
void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean@Clusterable(onMaster=true) void triggerBackgroundTask(long backgroundTaskId)
@Indexable(type=REINDEX) BackgroundTask updateBackgroundTask(BackgroundTask backgroundTask)
backgroundTask - the background task
|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||