Class BackgroundTaskLocalServiceWrapper

java.lang.Object
com.liferay.portal.background.task.service.BackgroundTaskLocalServiceWrapper
All Implemented Interfaces:
BackgroundTaskLocalService, com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService, com.liferay.portal.kernel.service.ServiceWrapper<BackgroundTaskLocalService>

public class BackgroundTaskLocalServiceWrapper extends Object implements BackgroundTaskLocalService, com.liferay.portal.kernel.service.ServiceWrapper<BackgroundTaskLocalService>
Provides a wrapper for BackgroundTaskLocalService.
See Also:
Generated:
  • Constructor Details

    • BackgroundTaskLocalServiceWrapper

      public BackgroundTaskLocalServiceWrapper()
    • BackgroundTaskLocalServiceWrapper

      public BackgroundTaskLocalServiceWrapper(BackgroundTaskLocalService backgroundTaskLocalService)
  • Method Details

    • addBackgroundTask

      public BackgroundTask addBackgroundTask(BackgroundTask backgroundTask)
      Adds the background task to the database. Also notifies the appropriate model listeners.

      Important: Inspect BackgroundTaskLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Specified by:
      addBackgroundTask in interface BackgroundTaskLocalService
      Parameters:
      backgroundTask - the background task
      Returns:
      the background task that was added
    • addBackgroundTask

      public BackgroundTask addBackgroundTask(long userId, long groupId, String name, String taskExecutorClassName, Map<String,Serializable> taskContextMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      addBackgroundTask in interface BackgroundTaskLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addBackgroundTask

      public BackgroundTask addBackgroundTask(long userId, long groupId, String name, String[] servletContextNames, Class<?> taskExecutorClass, Map<String,Serializable> taskContextMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      addBackgroundTask in interface BackgroundTaskLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addBackgroundTaskAttachment

      public void addBackgroundTaskAttachment(long userId, long backgroundTaskId, String fileName, File file) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      addBackgroundTaskAttachment in interface BackgroundTaskLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addBackgroundTaskAttachment

      public void addBackgroundTaskAttachment(long userId, long backgroundTaskId, String fileName, InputStream inputStream) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      addBackgroundTaskAttachment in interface BackgroundTaskLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • amendBackgroundTask

      public BackgroundTask amendBackgroundTask(long backgroundTaskId, Map<String,Serializable> taskContextMap, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext)
      Specified by:
      amendBackgroundTask in interface BackgroundTaskLocalService
    • amendBackgroundTask

      public BackgroundTask amendBackgroundTask(long backgroundTaskId, Map<String,Serializable> taskContextMap, int status, String statusMessage, com.liferay.portal.kernel.service.ServiceContext serviceContext)
      Specified by:
      amendBackgroundTask in interface BackgroundTaskLocalService
    • cleanUpBackgroundTask

      public void cleanUpBackgroundTask(long backgroundTaskId, int status)
      Specified by:
      cleanUpBackgroundTask in interface BackgroundTaskLocalService
    • cleanUpBackgroundTasks

      public void cleanUpBackgroundTasks()
      Specified by:
      cleanUpBackgroundTasks in interface BackgroundTaskLocalService
    • createBackgroundTask

      public BackgroundTask createBackgroundTask(long backgroundTaskId)
      Creates a new background task with the primary key. Does not add the background task to the database.
      Specified by:
      createBackgroundTask in interface BackgroundTaskLocalService
      Parameters:
      backgroundTaskId - the primary key for the new background task
      Returns:
      the new background task
    • createPersistedModel

      public com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface BackgroundTaskLocalService
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      PortalException
      com.liferay.portal.kernel.exception.PortalException
    • deleteBackgroundTask

      public BackgroundTask deleteBackgroundTask(BackgroundTask backgroundTask) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the background task from the database. Also notifies the appropriate model listeners.

      Important: Inspect BackgroundTaskLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Specified by:
      deleteBackgroundTask in interface BackgroundTaskLocalService
      Parameters:
      backgroundTask - the background task
      Returns:
      the background task that was removed
      Throws:
      PortalException
      com.liferay.portal.kernel.exception.PortalException
    • deleteBackgroundTask

      public BackgroundTask deleteBackgroundTask(long backgroundTaskId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the background task with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect BackgroundTaskLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Specified by:
      deleteBackgroundTask in interface BackgroundTaskLocalService
      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
      com.liferay.portal.kernel.exception.PortalException
    • deleteCompanyBackgroundTasks

      public void deleteCompanyBackgroundTasks(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deleteCompanyBackgroundTasks in interface BackgroundTaskLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteGroupBackgroundTasks

      public void deleteGroupBackgroundTasks(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deleteGroupBackgroundTasks in interface BackgroundTaskLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteGroupBackgroundTasks

      public void deleteGroupBackgroundTasks(long groupId, String name, String taskExecutorClassName) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deleteGroupBackgroundTasks in interface BackgroundTaskLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deletePersistedModel

      public com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface BackgroundTaskLocalService
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      PortalException
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface BackgroundTaskLocalService
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface BackgroundTaskLocalService
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
      Specified by:
      dynamicQuery in interface BackgroundTaskLocalService
    • dynamicQuery

      public <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Specified by:
      dynamicQuery in interface BackgroundTaskLocalService
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      public <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.background.task.model.impl.BackgroundTaskModelImpl.

      Specified by:
      dynamicQuery in interface BackgroundTaskLocalService
      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
    • dynamicQuery

      public <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.background.task.model.impl.BackgroundTaskModelImpl.

      Specified by:
      dynamicQuery in interface BackgroundTaskLocalService
      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
    • dynamicQueryCount

      public long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Specified by:
      dynamicQueryCount in interface BackgroundTaskLocalService
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      public long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
      Returns the number of rows matching the dynamic query.
      Specified by:
      dynamicQueryCount in interface BackgroundTaskLocalService
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchBackgroundTask

      public BackgroundTask fetchBackgroundTask(long backgroundTaskId)
      Specified by:
      fetchBackgroundTask in interface BackgroundTaskLocalService
    • fetchFirstBackgroundTask

      public BackgroundTask fetchFirstBackgroundTask(long groupId, String taskExecutorClassName, boolean completed, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
      Specified by:
      fetchFirstBackgroundTask in interface BackgroundTaskLocalService
    • fetchFirstBackgroundTask

      public BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName, int status)
      Specified by:
      fetchFirstBackgroundTask in interface BackgroundTaskLocalService
    • fetchFirstBackgroundTask

      public BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName, int status, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
      Specified by:
      fetchFirstBackgroundTask in interface BackgroundTaskLocalService
    • getActionableDynamicQuery

      public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
      Specified by:
      getActionableDynamicQuery in interface BackgroundTaskLocalService
    • getBackgroundTask

      public BackgroundTask getBackgroundTask(long backgroundTaskId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the background task with the primary key.
      Specified by:
      getBackgroundTask in interface BackgroundTaskLocalService
      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
      com.liferay.portal.kernel.exception.PortalException
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(int start, int end)
      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.background.task.model.impl.BackgroundTaskModelImpl.

      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
      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
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(long groupId, int status)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(long groupId, String taskExecutorClassName)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(long groupId, String taskExecutorClassName, boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(long groupId, String taskExecutorClassName, int status)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(long groupId, String taskExecutorClassName, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(long groupId, String name, String taskExecutorClassName, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(long groupId, String[] taskExecutorClassNames, int status)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(long[] groupIds, String name, String taskExecutorClassName, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(long[] groupIds, String name, String[] taskExecutorClassNames, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(long[] groupIds, String[] taskExecutorClassNames)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(long[] groupIds, String[] taskExecutorClassNames, boolean completed)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(long[] groupIds, String[] taskExecutorClassNames, boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(long[] groupIds, String[] taskExecutorClassNames, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName, int status)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames, int status)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasks

      public List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BackgroundTask> orderByComparator)
      Specified by:
      getBackgroundTasks in interface BackgroundTaskLocalService
    • getBackgroundTasksByDuration

      public List<BackgroundTask> getBackgroundTasksByDuration(long[] groupIds, String[] taskExecutorClassNames, boolean completed, int start, int end, boolean orderByType)
      Specified by:
      getBackgroundTasksByDuration in interface BackgroundTaskLocalService
    • getBackgroundTasksByDuration

      public List<BackgroundTask> getBackgroundTasksByDuration(long[] groupIds, String[] taskExecutorClassNames, int start, int end, boolean orderByType)
      Specified by:
      getBackgroundTasksByDuration in interface BackgroundTaskLocalService
    • getBackgroundTasksCount

      public int getBackgroundTasksCount()
      Returns the number of background tasks.
      Specified by:
      getBackgroundTasksCount in interface BackgroundTaskLocalService
      Returns:
      the number of background tasks
    • getBackgroundTasksCount

      public int getBackgroundTasksCount(long groupId, String taskExecutorClassName)
      Specified by:
      getBackgroundTasksCount in interface BackgroundTaskLocalService
    • getBackgroundTasksCount

      public int getBackgroundTasksCount(long groupId, String taskExecutorClassName, boolean completed)
      Specified by:
      getBackgroundTasksCount in interface BackgroundTaskLocalService
    • getBackgroundTasksCount

      public int getBackgroundTasksCount(long groupId, String name, String taskExecutorClassName)
      Specified by:
      getBackgroundTasksCount in interface BackgroundTaskLocalService
    • getBackgroundTasksCount

      public int getBackgroundTasksCount(long groupId, String name, String taskExecutorClassName, boolean completed)
      Specified by:
      getBackgroundTasksCount in interface BackgroundTaskLocalService
    • getBackgroundTasksCount

      public int getBackgroundTasksCount(long[] groupIds, String name, String taskExecutorClassName)
      Specified by:
      getBackgroundTasksCount in interface BackgroundTaskLocalService
    • getBackgroundTasksCount

      public int getBackgroundTasksCount(long[] groupIds, String name, String taskExecutorClassName, boolean completed)
      Specified by:
      getBackgroundTasksCount in interface BackgroundTaskLocalService
    • getBackgroundTasksCount

      public int getBackgroundTasksCount(long[] groupIds, String name, String[] taskExecutorClassName)
      Specified by:
      getBackgroundTasksCount in interface BackgroundTaskLocalService
    • getBackgroundTasksCount

      public int getBackgroundTasksCount(long[] groupIds, String[] taskExecutorClassNames)
      Specified by:
      getBackgroundTasksCount in interface BackgroundTaskLocalService
    • getBackgroundTasksCount

      public int getBackgroundTasksCount(long[] groupIds, String[] taskExecutorClassNames, boolean completed)
      Specified by:
      getBackgroundTasksCount in interface BackgroundTaskLocalService
    • getBackgroundTaskStatusJSON

      public String getBackgroundTaskStatusJSON(long backgroundTaskId)
      Specified by:
      getBackgroundTaskStatusJSON in interface BackgroundTaskLocalService
    • getIndexableActionableDynamicQuery

      public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
      Specified by:
      getIndexableActionableDynamicQuery in interface BackgroundTaskLocalService
    • getOSGiServiceIdentifier

      public String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Specified by:
      getOSGiServiceIdentifier in interface BackgroundTaskLocalService
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface BackgroundTaskLocalService
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      PortalException
      com.liferay.portal.kernel.exception.PortalException
    • resumeBackgroundTask

      public void resumeBackgroundTask(long backgroundTaskId)
      Specified by:
      resumeBackgroundTask in interface BackgroundTaskLocalService
    • triggerBackgroundTask

      public void triggerBackgroundTask(long backgroundTaskId)
      Specified by:
      triggerBackgroundTask in interface BackgroundTaskLocalService
    • updateBackgroundTask

      public BackgroundTask updateBackgroundTask(BackgroundTask backgroundTask)
      Updates the background task in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect BackgroundTaskLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Specified by:
      updateBackgroundTask in interface BackgroundTaskLocalService
      Parameters:
      backgroundTask - the background task
      Returns:
      the background task that was updated
    • getBasePersistence

      public com.liferay.portal.kernel.service.persistence.BasePersistence<?> getBasePersistence()
      Specified by:
      getBasePersistence in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • getWrappedService

      public BackgroundTaskLocalService getWrappedService()
      Specified by:
      getWrappedService in interface com.liferay.portal.kernel.service.ServiceWrapper<BackgroundTaskLocalService>
    • setWrappedService

      public void setWrappedService(BackgroundTaskLocalService backgroundTaskLocalService)
      Specified by:
      setWrappedService in interface com.liferay.portal.kernel.service.ServiceWrapper<BackgroundTaskLocalService>