|
Liferay 6.2-ce-ga5 | |||||||||
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 BackgroundTaskLocalService
Provides 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
,
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)
|
DynamicQuery |
dynamicQuery()
|
List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
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. |
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query. |
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows that match the dynamic query. |
BackgroundTask |
fetchBackgroundTask(long backgroundTaskId)
|
BackgroundTask |
fetchFirstBackgroundTask(long groupId,
String taskExecutorClassName,
boolean completed,
OrderByComparator orderByComparator)
|
BackgroundTask |
fetchFirstBackgroundTask(String taskExecutorClassName,
int status)
|
BackgroundTask |
fetchFirstBackgroundTask(String taskExecutorClassName,
int status,
OrderByComparator orderByComparator)
|
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 orderByComparator)
|
List<BackgroundTask> |
getBackgroundTasks(long groupId,
String taskExecutorClassName,
int status)
|
List<BackgroundTask> |
getBackgroundTasks(long groupId,
String taskExecutorClassName,
int start,
int end,
OrderByComparator orderByComparator)
|
List<BackgroundTask> |
getBackgroundTasks(long groupId,
String name,
String taskExecutorClassName,
int start,
int end,
OrderByComparator orderByComparator)
|
List<BackgroundTask> |
getBackgroundTasks(String[] taskExecutorClassNames,
int status)
|
List<BackgroundTask> |
getBackgroundTasks(String[] taskExecutorClassNames,
int status,
int start,
int end,
OrderByComparator orderByComparator)
|
List<BackgroundTask> |
getBackgroundTasks(String taskExecutorClassName,
int status)
|
List<BackgroundTask> |
getBackgroundTasks(String taskExecutorClassName,
int status,
int start,
int end,
OrderByComparator 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) throws SystemException
backgroundTask
- the background task
SystemException
- if a system exception occurredBackgroundTask createBackgroundTask(long backgroundTaskId)
backgroundTaskId
- the primary key for the new background task
@Indexable(type=DELETE) BackgroundTask deleteBackgroundTask(long backgroundTaskId) throws PortalException, SystemException
backgroundTaskId
- the primary key of the background task
PortalException
- if a background task with the primary key could not be found
SystemException
- if a system exception occurred@Indexable(type=DELETE) BackgroundTask deleteBackgroundTask(BackgroundTask backgroundTask) throws PortalException, SystemException
backgroundTask
- the background task
PortalException
SystemException
- if a system exception occurredDynamicQuery dynamicQuery()
List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredList dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
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)
SystemException
- if a system exception occurredList dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
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
)
SystemException
- if a system exception occurredlong dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredlong dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) throws SystemException
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) BackgroundTask fetchBackgroundTask(long backgroundTaskId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) BackgroundTask getBackgroundTask(long backgroundTaskId) throws PortalException, SystemException
backgroundTaskId
- the primary key of the background task
PortalException
- if a background task with the primary key could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
getPersistedModel
in interface PersistedModelLocalService
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<BackgroundTask> getBackgroundTasks(int start, int end) throws SystemException
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)
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount() throws SystemException
SystemException
- if a system exception occurred@Indexable(type=REINDEX) BackgroundTask updateBackgroundTask(BackgroundTask backgroundTask) throws SystemException
backgroundTask
- the background task
SystemException
- if a system exception occurredString getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanBackgroundTask addBackgroundTask(long userId, long groupId, String name, String[] servletContextNames, Class<?> taskExecutorClass, Map<String,Serializable> taskContextMap, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
void addBackgroundTaskAttachment(long userId, long backgroundTaskId, String fileName, File file) throws PortalException, SystemException
PortalException
SystemException
void addBackgroundTaskAttachment(long userId, long backgroundTaskId, String fileName, InputStream inputStream) throws PortalException, SystemException
PortalException
SystemException
BackgroundTask amendBackgroundTask(long backgroundTaskId, Map<String,Serializable> taskContextMap, int status, ServiceContext serviceContext) throws SystemException
SystemException
BackgroundTask amendBackgroundTask(long backgroundTaskId, Map<String,Serializable> taskContextMap, int status, String statusMessage, ServiceContext serviceContext) throws SystemException
SystemException
@Clusterable(onMaster=true) void cleanUpBackgroundTask(BackgroundTask backgroundTask, int status)
@Clusterable(onMaster=true) void cleanUpBackgroundTasks() throws SystemException
SystemException
void deleteCompanyBackgroundTasks(long companyId) throws PortalException, SystemException
PortalException
SystemException
void deleteGroupBackgroundTasks(long groupId) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) BackgroundTask fetchFirstBackgroundTask(long groupId, String taskExecutorClassName, boolean completed, OrderByComparator orderByComparator) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName, int status) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName, int status, OrderByComparator orderByComparator) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<BackgroundTask> getBackgroundTasks(long groupId, int status) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<BackgroundTask> getBackgroundTasks(long groupId, String taskExecutorClassName) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<BackgroundTask> getBackgroundTasks(long groupId, String taskExecutorClassName, int status) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<BackgroundTask> getBackgroundTasks(long groupId, String taskExecutorClassName, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<BackgroundTask> getBackgroundTasks(long groupId, String name, String taskExecutorClassName, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<BackgroundTask> getBackgroundTasks(long groupId, String[] taskExecutorClassNames) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<BackgroundTask> getBackgroundTasks(long groupId, String[] taskExecutorClassNames, int status) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<BackgroundTask> getBackgroundTasks(long groupId, String[] taskExecutorClassNames, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName, int status) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName, int status, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames, int status) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames, int status, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long groupId, String taskExecutorClassName) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long groupId, String taskExecutorClassName, boolean completed) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long groupId, String name, String taskExecutorClassName) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long groupId, String name, String taskExecutorClassName, boolean completed) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long groupId, String[] taskExecutorClassNames) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getBackgroundTasksCount(long groupId, String[] taskExecutorClassNames, boolean completed) throws SystemException
SystemException
@Clusterable(onMaster=true) @Transactional(propagation=SUPPORTS, readOnly=true) String getBackgroundTaskStatusJSON(long backgroundTaskId)
@Clusterable(onMaster=true) void resumeBackgroundTask(long backgroundTaskId) throws SystemException
SystemException
@Clusterable(onMaster=true) void triggerBackgroundTask(long backgroundTaskId)
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |