001
014
015 package com.liferay.portal.service;
016
017 import aQute.bnd.annotation.ProviderType;
018
019 import com.liferay.portal.kernel.exception.PortalException;
020 import com.liferay.portal.kernel.exception.SystemException;
021 import com.liferay.portal.kernel.search.IndexableType;
022 import com.liferay.portal.kernel.transaction.Isolation;
023 import com.liferay.portal.kernel.transaction.Propagation;
024 import com.liferay.portal.kernel.transaction.Transactional;
025
026
038 @ProviderType
039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = {
040 PortalException.class, SystemException.class})
041 public interface BackgroundTaskLocalService extends BaseLocalService,
042 PersistedModelLocalService {
043
048
049
055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
056 public com.liferay.portal.model.BackgroundTask addBackgroundTask(
057 com.liferay.portal.model.BackgroundTask backgroundTask);
058
059 public com.liferay.portal.model.BackgroundTask addBackgroundTask(
060 long userId, long groupId, java.lang.String name,
061 java.lang.String[] servletContextNames,
062 java.lang.Class<?> taskExecutorClass,
063 java.util.Map<java.lang.String, java.io.Serializable> taskContextMap,
064 com.liferay.portal.service.ServiceContext serviceContext)
065 throws com.liferay.portal.kernel.exception.PortalException;
066
067 public void addBackgroundTaskAttachment(long userId, long backgroundTaskId,
068 java.lang.String fileName, java.io.File file)
069 throws com.liferay.portal.kernel.exception.PortalException;
070
071 public void addBackgroundTaskAttachment(long userId, long backgroundTaskId,
072 java.lang.String fileName, java.io.InputStream inputStream)
073 throws com.liferay.portal.kernel.exception.PortalException;
074
075 public com.liferay.portal.model.BackgroundTask amendBackgroundTask(
076 long backgroundTaskId,
077 java.util.Map<java.lang.String, java.io.Serializable> taskContextMap,
078 int status, com.liferay.portal.service.ServiceContext serviceContext);
079
080 public com.liferay.portal.model.BackgroundTask amendBackgroundTask(
081 long backgroundTaskId,
082 java.util.Map<java.lang.String, java.io.Serializable> taskContextMap,
083 int status, java.lang.String statusMessage,
084 com.liferay.portal.service.ServiceContext serviceContext);
085
086 @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
087 public void cleanUpBackgroundTask(
088 com.liferay.portal.model.BackgroundTask backgroundTask, int status);
089
090 @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
091 public void cleanUpBackgroundTasks();
092
093
099 public com.liferay.portal.model.BackgroundTask createBackgroundTask(
100 long backgroundTaskId);
101
102
109 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
110 public com.liferay.portal.model.BackgroundTask deleteBackgroundTask(
111 com.liferay.portal.model.BackgroundTask backgroundTask)
112 throws com.liferay.portal.kernel.exception.PortalException;
113
114
121 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
122 public com.liferay.portal.model.BackgroundTask deleteBackgroundTask(
123 long backgroundTaskId)
124 throws com.liferay.portal.kernel.exception.PortalException;
125
126 public void deleteCompanyBackgroundTasks(long companyId)
127 throws com.liferay.portal.kernel.exception.PortalException;
128
129 public void deleteGroupBackgroundTasks(long groupId)
130 throws com.liferay.portal.kernel.exception.PortalException;
131
132
135 @Override
136 public com.liferay.portal.model.PersistedModel deletePersistedModel(
137 com.liferay.portal.model.PersistedModel persistedModel)
138 throws com.liferay.portal.kernel.exception.PortalException;
139
140 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
141
142
148 public <T> java.util.List<T> dynamicQuery(
149 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
150
151
163 public <T> java.util.List<T> dynamicQuery(
164 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
165 int end);
166
167
180 public <T> java.util.List<T> dynamicQuery(
181 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
182 int end,
183 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
184
185
191 public long dynamicQueryCount(
192 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
193
194
201 public long dynamicQueryCount(
202 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
203 com.liferay.portal.kernel.dao.orm.Projection projection);
204
205 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206 public com.liferay.portal.model.BackgroundTask fetchBackgroundTask(
207 long backgroundTaskId);
208
209 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210 public com.liferay.portal.model.BackgroundTask fetchFirstBackgroundTask(
211 long groupId, java.lang.String taskExecutorClassName,
212 boolean completed,
213 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
214
215 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
216 public com.liferay.portal.model.BackgroundTask fetchFirstBackgroundTask(
217 java.lang.String taskExecutorClassName, int status);
218
219 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220 public com.liferay.portal.model.BackgroundTask fetchFirstBackgroundTask(
221 java.lang.String taskExecutorClassName, int status,
222 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
223
224 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
225 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
226
227
234 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235 public com.liferay.portal.model.BackgroundTask getBackgroundTask(
236 long backgroundTaskId)
237 throws com.liferay.portal.kernel.exception.PortalException;
238
239 @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
240 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241 public java.lang.String getBackgroundTaskStatusJSON(long backgroundTaskId);
242
243 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
244 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
245 long groupId, java.lang.String name,
246 java.lang.String taskExecutorClassName, int start, int end,
247 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
248
249 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
250 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
251 long groupId, int status);
252
253 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
254 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
255 long groupId, java.lang.String taskExecutorClassName);
256
257 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
258 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
259 long groupId, java.lang.String taskExecutorClassName, int start,
260 int end,
261 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
262
263 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
264 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
265 long groupId, java.lang.String taskExecutorClassName, int status);
266
267 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
268 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
269 long groupId, java.lang.String[] taskExecutorClassNames);
270
271 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
272 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
273 long groupId, java.lang.String[] taskExecutorClassNames, int start,
274 int end,
275 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
276
277 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
278 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
279 long groupId, java.lang.String[] taskExecutorClassNames, int status);
280
281
292 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
293 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
294 int start, int end);
295
296 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
297 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
298 java.lang.String taskExecutorClassName, int status);
299
300 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
301 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
302 java.lang.String taskExecutorClassName, int status, int start, int end,
303 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
304
305 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
306 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
307 java.lang.String[] taskExecutorClassNames, int status);
308
309 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
311 java.lang.String[] taskExecutorClassNames, int status, int start,
312 int end,
313 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
314
315
320 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
321 public int getBackgroundTasksCount();
322
323 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
324 public int getBackgroundTasksCount(long groupId, java.lang.String name,
325 java.lang.String taskExecutorClassName);
326
327 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
328 public int getBackgroundTasksCount(long groupId, java.lang.String name,
329 java.lang.String taskExecutorClassName, boolean completed);
330
331 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
332 public int getBackgroundTasksCount(long groupId,
333 java.lang.String taskExecutorClassName);
334
335 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
336 public int getBackgroundTasksCount(long groupId,
337 java.lang.String taskExecutorClassName, boolean completed);
338
339 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
340 public int getBackgroundTasksCount(long groupId,
341 java.lang.String[] taskExecutorClassNames);
342
343 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
344 public int getBackgroundTasksCount(long groupId,
345 java.lang.String[] taskExecutorClassNames, boolean completed);
346
347
352 public java.lang.String getBeanIdentifier();
353
354 @Override
355 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
356 public com.liferay.portal.model.PersistedModel getPersistedModel(
357 java.io.Serializable primaryKeyObj)
358 throws com.liferay.portal.kernel.exception.PortalException;
359
360 @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
361 public void resumeBackgroundTask(long backgroundTaskId);
362
363
368 public void setBeanIdentifier(java.lang.String beanIdentifier);
369
370 @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
371 public void triggerBackgroundTask(long backgroundTaskId);
372
373
379 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
380 public com.liferay.portal.model.BackgroundTask updateBackgroundTask(
381 com.liferay.portal.model.BackgroundTask backgroundTask);
382 }