Interface BatchPlannerMappingLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
BatchPlannerMappingLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddBatchPlannerMapping(long userId, long batchPlannerPlanId, String externalFieldName, String externalFieldType, String internalFieldName, String internalFieldType, String script) addBatchPlannerMapping(BatchPlannerMapping batchPlannerMapping) Adds the batch planner mapping to the database.createBatchPlannerMapping(long batchPlannerMappingId) Creates a new batch planner mapping with the primary key.com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) deleteBatchPlannerMapping(long batchPlannerMappingId) Deletes the batch planner mapping with the primary key from the database.deleteBatchPlannerMapping(long batchPlannerPlanId, String externalFieldName, String internalFieldName) deleteBatchPlannerMapping(BatchPlannerMapping batchPlannerMapping) Deletes the batch planner mapping from the database.voiddeleteBatchPlannerMappings(long batchPlannerPlanId) 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.fetchBatchPlannerMapping(long batchPlannerMappingId) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerygetBatchPlannerMapping(long batchPlannerMappingId) Returns the batch planner mapping with the primary key.getBatchPlannerMappings(int start, int end) Returns a range of all the batch planner mappings.getBatchPlannerMappings(long batchPlannerPlanId) intReturns the number of batch planner mappings.com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQueryReturns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) updateBatchPlannerMapping(long batchPlannerMappingId, String externalFieldName, String externalFieldType, String script) updateBatchPlannerMapping(BatchPlannerMapping batchPlannerMapping) Updates the batch planner mapping in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addBatchPlannerMapping
@Indexable(type=REINDEX) BatchPlannerMapping addBatchPlannerMapping(BatchPlannerMapping batchPlannerMapping) Adds the batch planner mapping to the database. Also notifies the appropriate model listeners.Important: Inspect BatchPlannerMappingLocalServiceImpl 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:
batchPlannerMapping- the batch planner mapping- Returns:
- the batch planner mapping that was added
-
addBatchPlannerMapping
BatchPlannerMapping addBatchPlannerMapping(long userId, long batchPlannerPlanId, String externalFieldName, String externalFieldType, String internalFieldName, String internalFieldType, String script) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createBatchPlannerMapping
@Transactional(enabled=false) BatchPlannerMapping createBatchPlannerMapping(long batchPlannerMappingId) Creates a new batch planner mapping with the primary key. Does not add the batch planner mapping to the database.- Parameters:
batchPlannerMappingId- the primary key for the new batch planner mapping- Returns:
- the new batch planner mapping
-
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
-
deleteBatchPlannerMapping
@Indexable(type=DELETE) BatchPlannerMapping deleteBatchPlannerMapping(BatchPlannerMapping batchPlannerMapping) Deletes the batch planner mapping from the database. Also notifies the appropriate model listeners.Important: Inspect BatchPlannerMappingLocalServiceImpl 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:
batchPlannerMapping- the batch planner mapping- Returns:
- the batch planner mapping that was removed
-
deleteBatchPlannerMapping
@Indexable(type=DELETE) BatchPlannerMapping deleteBatchPlannerMapping(long batchPlannerMappingId) throws com.liferay.portal.kernel.exception.PortalException Deletes the batch planner mapping with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect BatchPlannerMappingLocalServiceImpl 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:
batchPlannerMappingId- the primary key of the batch planner mapping- Returns:
- the batch planner mapping that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a batch planner mapping with the primary key could not be found
-
deleteBatchPlannerMapping
BatchPlannerMapping deleteBatchPlannerMapping(long batchPlannerPlanId, String externalFieldName, String internalFieldName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteBatchPlannerMappings
void deleteBatchPlannerMappings(long batchPlannerPlanId) -
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.BatchPlannerMappingModelImpl.- 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.BatchPlannerMappingModelImpl.- 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
-
fetchBatchPlannerMapping
@Transactional(propagation=SUPPORTS, readOnly=true) BatchPlannerMapping fetchBatchPlannerMapping(long batchPlannerMappingId) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getBatchPlannerMapping
@Transactional(propagation=SUPPORTS, readOnly=true) BatchPlannerMapping getBatchPlannerMapping(long batchPlannerMappingId) throws com.liferay.portal.kernel.exception.PortalException Returns the batch planner mapping with the primary key.- Parameters:
batchPlannerMappingId- the primary key of the batch planner mapping- Returns:
- the batch planner mapping
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a batch planner mapping with the primary key could not be found
-
getBatchPlannerMappings
@Transactional(propagation=SUPPORTS, readOnly=true) List<BatchPlannerMapping> getBatchPlannerMappings(int start, int end) Returns a range of all the batch planner mappings.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.BatchPlannerMappingModelImpl.- Parameters:
start- the lower bound of the range of batch planner mappingsend- the upper bound of the range of batch planner mappings (not inclusive)- Returns:
- the range of batch planner mappings
-
getBatchPlannerMappings
@Transactional(propagation=SUPPORTS, readOnly=true) List<BatchPlannerMapping> getBatchPlannerMappings(long batchPlannerPlanId) -
getBatchPlannerMappingsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getBatchPlannerMappingsCount()Returns the number of batch planner mappings.- Returns:
- the number of batch planner mappings
-
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
-
updateBatchPlannerMapping
@Indexable(type=REINDEX) BatchPlannerMapping updateBatchPlannerMapping(BatchPlannerMapping batchPlannerMapping) Updates the batch planner mapping in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect BatchPlannerMappingLocalServiceImpl 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:
batchPlannerMapping- the batch planner mapping- Returns:
- the batch planner mapping that was updated
-
updateBatchPlannerMapping
BatchPlannerMapping updateBatchPlannerMapping(long batchPlannerMappingId, String externalFieldName, String externalFieldType, String script) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-