Interface BatchEngineImportTaskLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
BatchEngineImportTaskLocalServiceWrapper

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface BatchEngineImportTaskLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for BatchEngineImportTask. 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:
Generated:
  • Method Details

    • addBatchEngineImportTask

      @Indexable(type=REINDEX) BatchEngineImportTask addBatchEngineImportTask(BatchEngineImportTask batchEngineImportTask)
      Adds the batch engine import task to the database. Also notifies the appropriate model listeners.

      Important: Inspect BatchEngineImportTaskLocalServiceImpl 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.

      Parameters:
      batchEngineImportTask - the batch engine import task
      Returns:
      the batch engine import task that was added
    • addBatchEngineImportTask

      @Transactional(propagation=REQUIRES_NEW) BatchEngineImportTask addBatchEngineImportTask(String externalReferenceCode, long companyId, long userId, long batchSize, String callbackURL, String className, byte[] content, String contentType, String executeStatus, Map<String,String> fieldNameMappingMap, int importStrategy, String operation, Map<String,Serializable> parameters, String taskItemDelegateName) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addBatchEngineImportTask

      @Transactional(propagation=REQUIRES_NEW) BatchEngineImportTask addBatchEngineImportTask(String externalReferenceCode, long companyId, long userId, long batchSize, String callbackURL, String className, byte[] content, String contentType, String executeStatus, Map<String,String> fieldNameMappingMap, int importStrategy, String operation, Map<String,Serializable> parameters, String taskItemDelegateName, BatchEngineTaskItemDelegate<?> batchEngineTaskItemDelegate) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createBatchEngineImportTask

      @Transactional(enabled=false) BatchEngineImportTask createBatchEngineImportTask(long batchEngineImportTaskId)
      Creates a new batch engine import task with the primary key. Does not add the batch engine import task to the database.
      Parameters:
      batchEngineImportTaskId - the primary key for the new batch engine import task
      Returns:
      the new batch engine import task
    • createPersistedModel

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

      @Indexable(type=DELETE) BatchEngineImportTask deleteBatchEngineImportTask(BatchEngineImportTask batchEngineImportTask)
      Deletes the batch engine import task from the database. Also notifies the appropriate model listeners.

      Important: Inspect BatchEngineImportTaskLocalServiceImpl 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.

      Parameters:
      batchEngineImportTask - the batch engine import task
      Returns:
      the batch engine import task that was removed
    • deleteBatchEngineImportTask

      @Indexable(type=DELETE) BatchEngineImportTask deleteBatchEngineImportTask(long batchEngineImportTaskId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the batch engine import task with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect BatchEngineImportTaskLocalServiceImpl 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.

      Parameters:
      batchEngineImportTaskId - the primary key of the batch engine import task
      Returns:
      the batch engine import task that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a batch engine import task with the primary key could not be found
    • deletePersistedModel

      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 com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.batch.engine.model.impl.BatchEngineImportTaskModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.batch.engine.model.impl.BatchEngineImportTaskModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) 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.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchBatchEngineImportTask

      @Transactional(propagation=SUPPORTS, readOnly=true) BatchEngineImportTask fetchBatchEngineImportTask(long batchEngineImportTaskId)
    • fetchBatchEngineImportTaskByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) BatchEngineImportTask fetchBatchEngineImportTaskByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchBatchEngineImportTaskByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) BatchEngineImportTask fetchBatchEngineImportTaskByUuidAndCompanyId(String uuid, long companyId)
      Returns the batch engine import task with the matching UUID and company.
      Parameters:
      uuid - the batch engine import task's UUID
      companyId - the primary key of the company
      Returns:
      the matching batch engine import task, or null if a matching batch engine import task could not be found
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getBatchEngineImportTask

      @Transactional(propagation=SUPPORTS, readOnly=true) BatchEngineImportTask getBatchEngineImportTask(long batchEngineImportTaskId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the batch engine import task with the primary key.
      Parameters:
      batchEngineImportTaskId - the primary key of the batch engine import task
      Returns:
      the batch engine import task
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a batch engine import task with the primary key could not be found
    • getBatchEngineImportTaskByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) BatchEngineImportTask getBatchEngineImportTaskByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getBatchEngineImportTaskByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) BatchEngineImportTask getBatchEngineImportTaskByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the batch engine import task with the matching UUID and company.
      Parameters:
      uuid - the batch engine import task's UUID
      companyId - the primary key of the company
      Returns:
      the matching batch engine import task
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching batch engine import task could not be found
    • getBatchEngineImportTasks

      @Transactional(propagation=SUPPORTS, readOnly=true) List<BatchEngineImportTask> getBatchEngineImportTasks(int start, int end)
      Returns a range of all the batch engine import 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.batch.engine.model.impl.BatchEngineImportTaskModelImpl.

      Parameters:
      start - the lower bound of the range of batch engine import tasks
      end - the upper bound of the range of batch engine import tasks (not inclusive)
      Returns:
      the range of batch engine import tasks
    • getBatchEngineImportTasks

      @Transactional(propagation=SUPPORTS, readOnly=true) List<BatchEngineImportTask> getBatchEngineImportTasks(long companyId, int start, int end)
    • getBatchEngineImportTasks

      @Transactional(propagation=SUPPORTS, readOnly=true) List<BatchEngineImportTask> getBatchEngineImportTasks(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BatchEngineImportTask> orderByComparator)
    • getBatchEngineImportTasks

      @Transactional(propagation=SUPPORTS, readOnly=true) List<BatchEngineImportTask> getBatchEngineImportTasks(String executeStatus)
    • getBatchEngineImportTasksCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getBatchEngineImportTasksCount()
      Returns the number of batch engine import tasks.
      Returns:
      the number of batch engine import tasks
    • getBatchEngineImportTasksCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getBatchEngineImportTasksCount(long companyId)
    • getContentBlobModel

      @Transactional(propagation=SUPPORTS, readOnly=true) BatchEngineImportTaskContentBlobModel getContentBlobModel(Serializable primaryKey)
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • openContentInputStream

      @Transactional(readOnly=true) InputStream openContentInputStream(long batchEngineImportTaskId)
    • updateBatchEngineImportTask

      @Indexable(type=REINDEX) BatchEngineImportTask updateBatchEngineImportTask(BatchEngineImportTask batchEngineImportTask)
      Updates the batch engine import task in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect BatchEngineImportTaskLocalServiceImpl 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.

      Parameters:
      batchEngineImportTask - the batch engine import task
      Returns:
      the batch engine import task that was updated