Interface BatchPlannerPlanLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
BatchPlannerPlanLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddBatchPlannerPlan(long userId, boolean export, String externalType, String externalURL, String internalClassName, String name, int size, String taskItemDelegateName, boolean template) addBatchPlannerPlan(BatchPlannerPlan batchPlannerPlan) Adds the batch planner plan to the database.createBatchPlannerPlan(long batchPlannerPlanId) Creates a new batch planner plan with the primary key.com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) voiddeactivateBatchPlannerPlan(String batchEngineTaskERC) deleteBatchPlannerPlan(long batchPlannerPlanId) Deletes the batch planner plan with the primary key from the database.deleteBatchPlannerPlan(BatchPlannerPlan batchPlannerPlan) Deletes the batch planner plan from the database.com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery<T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(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.fetchBatchPlannerPlan(long batchPlannerPlanId) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerygetBatchPlannerPlan(long batchPlannerPlanId) Returns the batch planner plan with the primary key.getBatchPlannerPlans(int start, int end) Returns a range of all the batch planner plans.intReturns the number of batch planner plans.com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQueryReturns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) updateBatchPlannerPlan(long batchPlannerPlanId, String externalType, String internalClassName, String name) updateBatchPlannerPlan(BatchPlannerPlan batchPlannerPlan) Updates the batch planner plan in the database or adds it if it does not yet exist.updateStatus(long batchPlannerPlanId, int status) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addBatchPlannerPlan
Adds the batch planner plan to the database. Also notifies the appropriate model listeners.Important: Inspect BatchPlannerPlanLocalServiceImpl 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:
batchPlannerPlan- the batch planner plan- Returns:
- the batch planner plan that was added
-
addBatchPlannerPlan
BatchPlannerPlan addBatchPlannerPlan(long userId, boolean export, String externalType, String externalURL, String internalClassName, String name, int size, String taskItemDelegateName, boolean template) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createBatchPlannerPlan
Creates a new batch planner plan with the primary key. Does not add the batch planner plan to the database.- Parameters:
batchPlannerPlanId- the primary key for the new batch planner plan- Returns:
- the new batch planner plan
-
createPersistedModel
com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deactivateBatchPlannerPlan
-
deleteBatchPlannerPlan
@Indexable(type=DELETE) BatchPlannerPlan deleteBatchPlannerPlan(BatchPlannerPlan batchPlannerPlan) throws com.liferay.portal.kernel.exception.PortalException Deletes the batch planner plan from the database. Also notifies the appropriate model listeners.Important: Inspect BatchPlannerPlanLocalServiceImpl 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:
batchPlannerPlan- the batch planner plan- Returns:
- the batch planner plan that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteBatchPlannerPlan
@Indexable(type=DELETE) BatchPlannerPlan deleteBatchPlannerPlan(long batchPlannerPlanId) throws com.liferay.portal.kernel.exception.PortalException Deletes the batch planner plan with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect BatchPlannerPlanLocalServiceImpl 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:
batchPlannerPlanId- the primary key of the batch planner plan- Returns:
- the batch planner plan that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a batch planner plan 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:
deletePersistedModelin interfacecom.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:
dslQueryin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacecom.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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.batch.planner.model.impl.BatchPlannerPlanModelImpl.- 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
@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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.batch.planner.model.impl.BatchPlannerPlanModelImpl.- 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
@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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchBatchPlannerPlan
@Transactional(propagation=SUPPORTS, readOnly=true) BatchPlannerPlan fetchBatchPlannerPlan(long batchPlannerPlanId) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getBatchPlannerPlan
@Transactional(propagation=SUPPORTS, readOnly=true) BatchPlannerPlan getBatchPlannerPlan(long batchPlannerPlanId) throws com.liferay.portal.kernel.exception.PortalException Returns the batch planner plan with the primary key.- Parameters:
batchPlannerPlanId- the primary key of the batch planner plan- Returns:
- the batch planner plan
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a batch planner plan with the primary key could not be found
-
getBatchPlannerPlans
@Transactional(propagation=SUPPORTS, readOnly=true) List<BatchPlannerPlan> getBatchPlannerPlans(int start, int end) Returns a range of all the batch planner plans.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.batch.planner.model.impl.BatchPlannerPlanModelImpl.- Parameters:
start- the lower bound of the range of batch planner plansend- the upper bound of the range of batch planner plans (not inclusive)- Returns:
- the range of batch planner plans
-
getBatchPlannerPlansCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getBatchPlannerPlansCount()Returns the number of batch planner plans.- Returns:
- the number of batch planner plans
-
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:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateBatchPlannerPlan
Updates the batch planner plan in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect BatchPlannerPlanLocalServiceImpl 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:
batchPlannerPlan- the batch planner plan- Returns:
- the batch planner plan that was updated
-
updateBatchPlannerPlan
BatchPlannerPlan updateBatchPlannerPlan(long batchPlannerPlanId, String externalType, String internalClassName, String name) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateStatus
BatchPlannerPlan updateStatus(long batchPlannerPlanId, int status) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-