Class BatchEngineImportTaskLocalServiceUtil

java.lang.Object
com.liferay.batch.engine.service.BatchEngineImportTaskLocalServiceUtil

public class BatchEngineImportTaskLocalServiceUtil extends Object
Provides the local service utility for BatchEngineImportTask. This utility wraps com.liferay.batch.engine.service.impl.BatchEngineImportTaskLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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:
  • Constructor Details

    • BatchEngineImportTaskLocalServiceUtil

      public BatchEngineImportTaskLocalServiceUtil()
  • Method Details

    • addBatchEngineImportTask

      public static 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

      public static 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

      public static 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

      public static 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

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteBatchEngineImportTask

      public static 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

      public static 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

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <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

      public static <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

      public static <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

      public static 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

      public static 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

      public static BatchEngineImportTask fetchBatchEngineImportTask(long batchEngineImportTaskId)
    • fetchBatchEngineImportTaskByExternalReferenceCode

      public static BatchEngineImportTask fetchBatchEngineImportTaskByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchBatchEngineImportTaskByUuidAndCompanyId

      public static 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

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getBatchEngineImportTask

      public static 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

      public static BatchEngineImportTask getBatchEngineImportTaskByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getBatchEngineImportTaskByUuidAndCompanyId

      public static 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

      public static 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

      public static List<BatchEngineImportTask> getBatchEngineImportTasks(long companyId, int start, int end)
    • getBatchEngineImportTasks

      public static List<BatchEngineImportTask> getBatchEngineImportTasks(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BatchEngineImportTask> orderByComparator)
    • getBatchEngineImportTasks

      public static List<BatchEngineImportTask> getBatchEngineImportTasks(String executeStatus)
    • getBatchEngineImportTasksCount

      public static int getBatchEngineImportTasksCount()
      Returns the number of batch engine import tasks.
      Returns:
      the number of batch engine import tasks
    • getBatchEngineImportTasksCount

      public static int getBatchEngineImportTasksCount(long companyId)
    • getContentBlobModel

      public static BatchEngineImportTaskContentBlobModel getContentBlobModel(Serializable primaryKey)
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • openContentInputStream

      public static InputStream openContentInputStream(long batchEngineImportTaskId)
    • updateBatchEngineImportTask

      public static 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
    • getService

      public static BatchEngineImportTaskLocalService getService()