|
Liferay 7.0-ce-m6 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.BackgroundTaskLocalServiceUtil
@ProviderType public class BackgroundTaskLocalServiceUtil
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.
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 PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
static DynamicQuery |
dynamicQuery()
|
|
static
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
static
|
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. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
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 ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
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<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()
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 |
|---|
public BackgroundTaskLocalServiceUtil()
| Method Detail |
|---|
public static BackgroundTask addBackgroundTask(BackgroundTask backgroundTask)
backgroundTask - the background task
public static BackgroundTask addBackgroundTask(long userId,
long groupId,
String name,
String[] servletContextNames,
Class<?> taskExecutorClass,
Map<String,Serializable> taskContextMap,
ServiceContext serviceContext)
throws PortalException
PortalException
public static void addBackgroundTaskAttachment(long userId,
long backgroundTaskId,
String fileName,
File file)
throws PortalException
PortalException
public static void addBackgroundTaskAttachment(long userId,
long backgroundTaskId,
String fileName,
InputStream inputStream)
throws PortalException
PortalException
public static BackgroundTask amendBackgroundTask(long backgroundTaskId,
Map<String,Serializable> taskContextMap,
int status,
ServiceContext serviceContext)
public static BackgroundTask amendBackgroundTask(long backgroundTaskId,
Map<String,Serializable> taskContextMap,
int status,
String statusMessage,
ServiceContext serviceContext)
public static void cleanUpBackgroundTask(BackgroundTask backgroundTask,
int status)
public static void cleanUpBackgroundTasks()
public static BackgroundTask createBackgroundTask(long backgroundTaskId)
backgroundTaskId - the primary key for the new background task
public static BackgroundTask deleteBackgroundTask(BackgroundTask backgroundTask)
throws PortalException
backgroundTask - the background task
PortalException
public static 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
public static void deleteCompanyBackgroundTasks(long companyId)
throws PortalException
PortalException
public static void deleteGroupBackgroundTasks(long groupId)
throws PortalException
PortalException
public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
PortalExceptionpublic static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static <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)
public static <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)
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
public static BackgroundTask fetchBackgroundTask(long backgroundTaskId)
public static BackgroundTask fetchFirstBackgroundTask(long groupId,
String taskExecutorClassName,
boolean completed,
OrderByComparator<BackgroundTask> orderByComparator)
public static BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName,
int status)
public static BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName,
int status,
OrderByComparator<BackgroundTask> orderByComparator)
public static ActionableDynamicQuery getActionableDynamicQuery()
public static 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 foundpublic static String getBackgroundTaskStatusJSON(long backgroundTaskId)
public static List<BackgroundTask> getBackgroundTasks(long groupId,
String name,
String taskExecutorClassName,
int start,
int end,
OrderByComparator<BackgroundTask> orderByComparator)
public static List<BackgroundTask> getBackgroundTasks(long groupId,
int status)
public static List<BackgroundTask> getBackgroundTasks(long groupId,
String taskExecutorClassName)
public static List<BackgroundTask> getBackgroundTasks(long groupId,
String taskExecutorClassName,
int start,
int end,
OrderByComparator<BackgroundTask> orderByComparator)
public static List<BackgroundTask> getBackgroundTasks(long groupId,
String taskExecutorClassName,
int status)
public static List<BackgroundTask> getBackgroundTasks(long groupId,
String[] taskExecutorClassNames)
public static List<BackgroundTask> getBackgroundTasks(long groupId,
String[] taskExecutorClassNames,
int start,
int end,
OrderByComparator<BackgroundTask> orderByComparator)
public static List<BackgroundTask> getBackgroundTasks(long groupId,
String[] taskExecutorClassNames,
int status)
public static 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)
public static List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName,
int status)
public static List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName,
int status,
int start,
int end,
OrderByComparator<BackgroundTask> orderByComparator)
public static List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames,
int status)
public static List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames,
int status,
int start,
int end,
OrderByComparator<BackgroundTask> orderByComparator)
public static int getBackgroundTasksCount()
public static int getBackgroundTasksCount(long groupId,
String name,
String taskExecutorClassName)
public static int getBackgroundTasksCount(long groupId,
String name,
String taskExecutorClassName,
boolean completed)
public static int getBackgroundTasksCount(long groupId,
String taskExecutorClassName)
public static int getBackgroundTasksCount(long groupId,
String taskExecutorClassName,
boolean completed)
public static int getBackgroundTasksCount(long groupId,
String[] taskExecutorClassNames)
public static int getBackgroundTasksCount(long groupId,
String[] taskExecutorClassNames,
boolean completed)
public static String getBeanIdentifier()
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
PortalExceptionpublic static void resumeBackgroundTask(long backgroundTaskId)
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this beanpublic static void triggerBackgroundTask(long backgroundTaskId)
public static BackgroundTask updateBackgroundTask(BackgroundTask backgroundTask)
backgroundTask - the background task
public static BackgroundTaskLocalService getService()
@Deprecated public void setService(BackgroundTaskLocalService service)
|
Liferay 7.0-ce-m6 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||