Liferay 6.2.0

com.liferay.portal.service
Interface BackgroundTaskLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
BackgroundTaskLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface BackgroundTaskLocalService
extends BaseLocalService, PersistedModelLocalService

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.

See Also:
BackgroundTaskLocalServiceUtil, BackgroundTaskLocalServiceBaseImpl, com.liferay.portal.service.impl.BackgroundTaskLocalServiceImpl

Method Summary
abstract  BackgroundTask addBackgroundTask(BackgroundTask backgroundTask)
          Adds the background task to the database.
abstract  BackgroundTask addBackgroundTask(long userId, long groupId, String name, String[] servletContextNames, Class<?> taskExecutorClass, Map<String,Serializable> taskContextMap, ServiceContext serviceContext)
           
abstract  void addBackgroundTaskAttachment(long userId, long backgroundTaskId, String fileName, File file)
           
abstract  void addBackgroundTaskAttachment(long userId, long backgroundTaskId, String fileName, InputStream inputStream)
           
abstract  BackgroundTask amendBackgroundTask(long backgroundTaskId, Map<String,Serializable> taskContextMap, int status, ServiceContext serviceContext)
           
abstract  BackgroundTask amendBackgroundTask(long backgroundTaskId, Map<String,Serializable> taskContextMap, int status, String statusMessage, ServiceContext serviceContext)
           
abstract  void cleanUpBackgroundTask(BackgroundTask backgroundTask, int status)
           
abstract  void cleanUpBackgroundTasks()
           
abstract  BackgroundTask createBackgroundTask(long backgroundTaskId)
          Creates a new background task with the primary key.
abstract  BackgroundTask deleteBackgroundTask(BackgroundTask backgroundTask)
          Deletes the background task from the database.
abstract  BackgroundTask deleteBackgroundTask(long backgroundTaskId)
          Deletes the background task with the primary key from the database.
abstract  void deleteCompanyBackgroundTasks(long companyId)
           
abstract  void deleteGroupBackgroundTasks(long groupId)
           
abstract  DynamicQuery dynamicQuery()
           
abstract  List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
abstract  List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
abstract  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.
abstract  long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
abstract  long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
abstract  BackgroundTask fetchBackgroundTask(long backgroundTaskId)
           
abstract  BackgroundTask fetchFirstBackgroundTask(long groupId, String taskExecutorClassName, boolean completed, OrderByComparator orderByComparator)
           
abstract  BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName, int status)
           
abstract  BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName, int status, OrderByComparator orderByComparator)
           
abstract  BackgroundTask getBackgroundTask(long backgroundTaskId)
          Returns the background task with the primary key.
abstract  List<BackgroundTask> getBackgroundTasks(int start, int end)
          Returns a range of all the background tasks.
abstract  List<BackgroundTask> getBackgroundTasks(long groupId, int status)
           
abstract  List<BackgroundTask> getBackgroundTasks(long groupId, String taskExecutorClassName)
           
abstract  List<BackgroundTask> getBackgroundTasks(long groupId, String[] taskExecutorClassNames)
           
abstract  List<BackgroundTask> getBackgroundTasks(long groupId, String[] taskExecutorClassNames, int status)
           
abstract  List<BackgroundTask> getBackgroundTasks(long groupId, String[] taskExecutorClassNames, int start, int end, OrderByComparator orderByComparator)
           
abstract  List<BackgroundTask> getBackgroundTasks(long groupId, String taskExecutorClassName, int status)
           
abstract  List<BackgroundTask> getBackgroundTasks(long groupId, String taskExecutorClassName, int start, int end, OrderByComparator orderByComparator)
           
abstract  List<BackgroundTask> getBackgroundTasks(long groupId, String name, String taskExecutorClassName, int start, int end, OrderByComparator orderByComparator)
           
abstract  List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames, int status)
           
abstract  List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames, int status, int start, int end, OrderByComparator orderByComparator)
           
abstract  List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName, int status)
           
abstract  List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName, int status, int start, int end, OrderByComparator orderByComparator)
           
abstract  int getBackgroundTasksCount()
          Returns the number of background tasks.
abstract  int getBackgroundTasksCount(long groupId, String taskExecutorClassName)
           
abstract  int getBackgroundTasksCount(long groupId, String[] taskExecutorClassNames)
           
abstract  int getBackgroundTasksCount(long groupId, String[] taskExecutorClassNames, boolean completed)
           
abstract  int getBackgroundTasksCount(long groupId, String taskExecutorClassName, boolean completed)
           
abstract  int getBackgroundTasksCount(long groupId, String name, String taskExecutorClassName)
           
abstract  int getBackgroundTasksCount(long groupId, String name, String taskExecutorClassName, boolean completed)
           
abstract  String getBackgroundTaskStatusJSON(long backgroundTaskId)
           
abstract  String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
abstract  PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
abstract  void resumeBackgroundTask(long backgroundTaskId)
           
abstract  void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
abstract  void triggerBackgroundTask(long backgroundTaskId)
           
abstract  BackgroundTask updateBackgroundTask(BackgroundTask backgroundTask)
          Updates the background task in the database or adds it if it does not yet exist.
 

Method Detail

addBackgroundTask

@Indexable(type=REINDEX)
BackgroundTask addBackgroundTask(BackgroundTask backgroundTask)
                                 throws SystemException
Adds the background task to the database. Also notifies the appropriate model listeners.

Parameters:
backgroundTask - the background task
Returns:
the background task that was added
Throws:
SystemException - if a system exception occurred

createBackgroundTask

BackgroundTask createBackgroundTask(long backgroundTaskId)
Creates a new background task with the primary key. Does not add the background task to the database.

Parameters:
backgroundTaskId - the primary key for the new background task
Returns:
the new background task

deleteBackgroundTask

@Indexable(type=DELETE)
BackgroundTask deleteBackgroundTask(long backgroundTaskId)
                                    throws PortalException,
                                           SystemException
Deletes the background task with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
backgroundTaskId - the primary key of the background task
Returns:
the background task that was removed
Throws:
PortalException - if a background task with the primary key could not be found
SystemException - if a system exception occurred

deleteBackgroundTask

@Indexable(type=DELETE)
BackgroundTask deleteBackgroundTask(BackgroundTask backgroundTask)
                                    throws PortalException,
                                           SystemException
Deletes the background task from the database. Also notifies the appropriate model listeners.

Parameters:
backgroundTask - the background task
Returns:
the background task that was removed
Throws:
PortalException
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

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.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

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.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchBackgroundTask

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BackgroundTask fetchBackgroundTask(long backgroundTaskId)
                                   throws SystemException
Throws:
SystemException

getBackgroundTask

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BackgroundTask getBackgroundTask(long backgroundTaskId)
                                 throws PortalException,
                                        SystemException
Returns the background task with the primary key.

Parameters:
backgroundTaskId - the primary key of the background task
Returns:
the background task
Throws:
PortalException - if a background task with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getBackgroundTasks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BackgroundTask> getBackgroundTasks(int start,
                                                                                 int end)
                                        throws SystemException
Returns a range of all the background tasks.

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.

Parameters:
start - the lower bound of the range of background tasks
end - the upper bound of the range of background tasks (not inclusive)
Returns:
the range of background tasks
Throws:
SystemException - if a system exception occurred

getBackgroundTasksCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getBackgroundTasksCount()
                            throws SystemException
Returns the number of background tasks.

Returns:
the number of background tasks
Throws:
SystemException - if a system exception occurred

updateBackgroundTask

@Indexable(type=REINDEX)
BackgroundTask updateBackgroundTask(BackgroundTask backgroundTask)
                                    throws SystemException
Updates the background task in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
backgroundTask - the background task
Returns:
the background task that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addBackgroundTask

BackgroundTask addBackgroundTask(long userId,
                                 long groupId,
                                 String name,
                                 String[] servletContextNames,
                                 Class<?> taskExecutorClass,
                                 Map<String,Serializable> taskContextMap,
                                 ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

addBackgroundTaskAttachment

void addBackgroundTaskAttachment(long userId,
                                 long backgroundTaskId,
                                 String fileName,
                                 File file)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

addBackgroundTaskAttachment

void addBackgroundTaskAttachment(long userId,
                                 long backgroundTaskId,
                                 String fileName,
                                 InputStream inputStream)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

amendBackgroundTask

BackgroundTask amendBackgroundTask(long backgroundTaskId,
                                   Map<String,Serializable> taskContextMap,
                                   int status,
                                   ServiceContext serviceContext)
                                   throws SystemException
Throws:
SystemException

amendBackgroundTask

BackgroundTask amendBackgroundTask(long backgroundTaskId,
                                   Map<String,Serializable> taskContextMap,
                                   int status,
                                   String statusMessage,
                                   ServiceContext serviceContext)
                                   throws SystemException
Throws:
SystemException

cleanUpBackgroundTask

@Clusterable(onMaster=true)
void cleanUpBackgroundTask(BackgroundTask backgroundTask,
                                               int status)

cleanUpBackgroundTasks

@Clusterable(onMaster=true)
void cleanUpBackgroundTasks()
                            throws SystemException
Throws:
SystemException

deleteCompanyBackgroundTasks

void deleteCompanyBackgroundTasks(long companyId)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

deleteGroupBackgroundTasks

void deleteGroupBackgroundTasks(long groupId)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

fetchFirstBackgroundTask

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BackgroundTask fetchFirstBackgroundTask(long groupId,
                                                                                 String taskExecutorClassName,
                                                                                 boolean completed,
                                                                                 OrderByComparator orderByComparator)
                                        throws SystemException
Throws:
SystemException

fetchFirstBackgroundTask

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName,
                                                                                 int status)
                                        throws SystemException
Throws:
SystemException

fetchFirstBackgroundTask

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName,
                                                                                 int status,
                                                                                 OrderByComparator orderByComparator)
                                        throws SystemException
Throws:
SystemException

getBackgroundTasks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
                                                                                 int status)
                                        throws SystemException
Throws:
SystemException

getBackgroundTasks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
                                                                                 String taskExecutorClassName)
                                        throws SystemException
Throws:
SystemException

getBackgroundTasks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
                                                                                 String taskExecutorClassName,
                                                                                 int status)
                                        throws SystemException
Throws:
SystemException

getBackgroundTasks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
                                                                                 String taskExecutorClassName,
                                                                                 int start,
                                                                                 int end,
                                                                                 OrderByComparator orderByComparator)
                                        throws SystemException
Throws:
SystemException

getBackgroundTasks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
                                                                                 String name,
                                                                                 String taskExecutorClassName,
                                                                                 int start,
                                                                                 int end,
                                                                                 OrderByComparator orderByComparator)
                                        throws SystemException
Throws:
SystemException

getBackgroundTasks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
                                                                                 String[] taskExecutorClassNames)
                                        throws SystemException
Throws:
SystemException

getBackgroundTasks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
                                                                                 String[] taskExecutorClassNames,
                                                                                 int status)
                                        throws SystemException
Throws:
SystemException

getBackgroundTasks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BackgroundTask> getBackgroundTasks(long groupId,
                                                                                 String[] taskExecutorClassNames,
                                                                                 int start,
                                                                                 int end,
                                                                                 OrderByComparator orderByComparator)
                                        throws SystemException
Throws:
SystemException

getBackgroundTasks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName,
                                                                                 int status)
                                        throws SystemException
Throws:
SystemException

getBackgroundTasks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName,
                                                                                 int status,
                                                                                 int start,
                                                                                 int end,
                                                                                 OrderByComparator orderByComparator)
                                        throws SystemException
Throws:
SystemException

getBackgroundTasks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames,
                                                                                 int status)
                                        throws SystemException
Throws:
SystemException

getBackgroundTasks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames,
                                                                                 int status,
                                                                                 int start,
                                                                                 int end,
                                                                                 OrderByComparator orderByComparator)
                                        throws SystemException
Throws:
SystemException

getBackgroundTasksCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getBackgroundTasksCount(long groupId,
                                                                     String taskExecutorClassName)
                            throws SystemException
Throws:
SystemException

getBackgroundTasksCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getBackgroundTasksCount(long groupId,
                                                                     String taskExecutorClassName,
                                                                     boolean completed)
                            throws SystemException
Throws:
SystemException

getBackgroundTasksCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getBackgroundTasksCount(long groupId,
                                                                     String name,
                                                                     String taskExecutorClassName)
                            throws SystemException
Throws:
SystemException

getBackgroundTasksCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getBackgroundTasksCount(long groupId,
                                                                     String name,
                                                                     String taskExecutorClassName,
                                                                     boolean completed)
                            throws SystemException
Throws:
SystemException

getBackgroundTasksCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getBackgroundTasksCount(long groupId,
                                                                     String[] taskExecutorClassNames)
                            throws SystemException
Throws:
SystemException

getBackgroundTasksCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getBackgroundTasksCount(long groupId,
                                                                     String[] taskExecutorClassNames,
                                                                     boolean completed)
                            throws SystemException
Throws:
SystemException

getBackgroundTaskStatusJSON

@Clusterable(onMaster=true)
@Transactional(propagation=SUPPORTS,
               readOnly=true)
String getBackgroundTaskStatusJSON(long backgroundTaskId)

resumeBackgroundTask

@Clusterable(onMaster=true)
void resumeBackgroundTask(long backgroundTaskId)
                          throws SystemException
Throws:
SystemException

triggerBackgroundTask

@Clusterable(onMaster=true)
void triggerBackgroundTask(long backgroundTaskId)

Liferay 6.2.0