Class BatchEngineExportTaskLocalServiceUtil
com.liferay.batch.engine.service.impl.BatchEngineExportTaskLocalServiceImpl
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic BatchEngineExportTask
addBatchEngineExportTask
(BatchEngineExportTask batchEngineExportTask) Adds the batch engine export task to the database.static BatchEngineExportTask
addBatchEngineExportTask
(String externalReferenceCode, long companyId, long userId, String callbackURL, String className, String contentType, String executeStatus, List<String> fieldNamesList, Map<String, Serializable> parameters, String taskItemDelegateName) static BatchEngineExportTask
createBatchEngineExportTask
(long batchEngineExportTaskId) Creates a new batch engine export task with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static BatchEngineExportTask
deleteBatchEngineExportTask
(long batchEngineExportTaskId) Deletes the batch engine export task with the primary key from the database.static BatchEngineExportTask
deleteBatchEngineExportTask
(BatchEngineExportTask batchEngineExportTask) Deletes the batch engine export task from the database.static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
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.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.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.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.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.static BatchEngineExportTask
fetchBatchEngineExportTask
(long batchEngineExportTaskId) static BatchEngineExportTask
fetchBatchEngineExportTaskByExternalReferenceCode
(String externalReferenceCode, long companyId) static BatchEngineExportTask
fetchBatchEngineExportTaskByUuidAndCompanyId
(String uuid, long companyId) Returns the batch engine export task with the matching UUID and company.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static BatchEngineExportTask
getBatchEngineExportTask
(long batchEngineExportTaskId) Returns the batch engine export task with the primary key.static BatchEngineExportTask
getBatchEngineExportTaskByExternalReferenceCode
(String externalReferenceCode, long companyId) static BatchEngineExportTask
getBatchEngineExportTaskByUuidAndCompanyId
(String uuid, long companyId) Returns the batch engine export task with the matching UUID and company.static List<BatchEngineExportTask>
getBatchEngineExportTasks
(int start, int end) Returns a range of all the batch engine export tasks.static List<BatchEngineExportTask>
getBatchEngineExportTasks
(long companyId, int start, int end) static List<BatchEngineExportTask>
getBatchEngineExportTasks
(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BatchEngineExportTask> orderByComparator) static List<BatchEngineExportTask>
getBatchEngineExportTasks
(String executeStatus) static int
Returns the number of batch engine export tasks.static int
getBatchEngineExportTasksCount
(long companyId) getContentBlobModel
(Serializable primaryKey) static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static InputStream
openContentInputStream
(long batchEngineExportTaskId) static BatchEngineExportTask
updateBatchEngineExportTask
(BatchEngineExportTask batchEngineExportTask) Updates the batch engine export task in the database or adds it if it does not yet exist.
-
Constructor Details
-
BatchEngineExportTaskLocalServiceUtil
public BatchEngineExportTaskLocalServiceUtil()
-
-
Method Details
-
addBatchEngineExportTask
public static BatchEngineExportTask addBatchEngineExportTask(BatchEngineExportTask batchEngineExportTask) Adds the batch engine export task to the database. Also notifies the appropriate model listeners.Important: Inspect BatchEngineExportTaskLocalServiceImpl 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:
batchEngineExportTask
- the batch engine export task- Returns:
- the batch engine export task that was added
-
addBatchEngineExportTask
-
createBatchEngineExportTask
Creates a new batch engine export task with the primary key. Does not add the batch engine export task to the database.- Parameters:
batchEngineExportTaskId
- the primary key for the new batch engine export task- Returns:
- the new batch engine export 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
-
deleteBatchEngineExportTask
public static BatchEngineExportTask deleteBatchEngineExportTask(BatchEngineExportTask batchEngineExportTask) Deletes the batch engine export task from the database. Also notifies the appropriate model listeners.Important: Inspect BatchEngineExportTaskLocalServiceImpl 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:
batchEngineExportTask
- the batch engine export task- Returns:
- the batch engine export task that was removed
-
deleteBatchEngineExportTask
public static BatchEngineExportTask deleteBatchEngineExportTask(long batchEngineExportTaskId) throws com.liferay.portal.kernel.exception.PortalException Deletes the batch engine export task with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect BatchEngineExportTaskLocalServiceImpl 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:
batchEngineExportTaskId
- the primary key of the batch engine export task- Returns:
- the batch engine export task that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a batch engine export 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
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.batch.engine.model.impl.BatchEngineExportTaskModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.batch.engine.model.impl.BatchEngineExportTaskModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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 queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchBatchEngineExportTask
-
fetchBatchEngineExportTaskByExternalReferenceCode
public static BatchEngineExportTask fetchBatchEngineExportTaskByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchBatchEngineExportTaskByUuidAndCompanyId
public static BatchEngineExportTask fetchBatchEngineExportTaskByUuidAndCompanyId(String uuid, long companyId) Returns the batch engine export task with the matching UUID and company.- Parameters:
uuid
- the batch engine export task's UUIDcompanyId
- the primary key of the company- Returns:
- the matching batch engine export task, or
null
if a matching batch engine export task could not be found
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getBatchEngineExportTask
public static BatchEngineExportTask getBatchEngineExportTask(long batchEngineExportTaskId) throws com.liferay.portal.kernel.exception.PortalException Returns the batch engine export task with the primary key.- Parameters:
batchEngineExportTaskId
- the primary key of the batch engine export task- Returns:
- the batch engine export task
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a batch engine export task with the primary key could not be found
-
getBatchEngineExportTaskByExternalReferenceCode
public static BatchEngineExportTask getBatchEngineExportTaskByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getBatchEngineExportTaskByUuidAndCompanyId
public static BatchEngineExportTask getBatchEngineExportTaskByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException Returns the batch engine export task with the matching UUID and company.- Parameters:
uuid
- the batch engine export task's UUIDcompanyId
- the primary key of the company- Returns:
- the matching batch engine export task
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a matching batch engine export task could not be found
-
getBatchEngineExportTasks
Returns a range of all the batch engine export tasks.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.batch.engine.model.impl.BatchEngineExportTaskModelImpl
.- Parameters:
start
- the lower bound of the range of batch engine export tasksend
- the upper bound of the range of batch engine export tasks (not inclusive)- Returns:
- the range of batch engine export tasks
-
getBatchEngineExportTasks
public static List<BatchEngineExportTask> getBatchEngineExportTasks(long companyId, int start, int end) -
getBatchEngineExportTasks
public static List<BatchEngineExportTask> getBatchEngineExportTasks(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BatchEngineExportTask> orderByComparator) -
getBatchEngineExportTasks
-
getBatchEngineExportTasksCount
public static int getBatchEngineExportTasksCount()Returns the number of batch engine export tasks.- Returns:
- the number of batch engine export tasks
-
getBatchEngineExportTasksCount
public static int getBatchEngineExportTasksCount(long companyId) -
getContentBlobModel
-
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
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
-
updateBatchEngineExportTask
public static BatchEngineExportTask updateBatchEngineExportTask(BatchEngineExportTask batchEngineExportTask) Updates the batch engine export task in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect BatchEngineExportTaskLocalServiceImpl 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:
batchEngineExportTask
- the batch engine export task- Returns:
- the batch engine export task that was updated
-
getService
-