Interface DispatchTriggerLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
DispatchTriggerLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddDispatchTrigger(DispatchTrigger dispatchTrigger) Adds the dispatch trigger to the database.addDispatchTrigger(String externalReferenceCode, long userId, DispatchTaskExecutor dispatchTaskExecutor, String dispatchTaskExecutorType, com.liferay.portal.kernel.util.UnicodeProperties dispatchTaskSettingsUnicodeProperties, String name, boolean system) addDispatchTrigger(String externalReferenceCode, long userId, String dispatchTaskExecutorType, com.liferay.portal.kernel.util.UnicodeProperties dispatchTaskSettingsUnicodeProperties, String name, boolean system) createDispatchTrigger(long dispatchTriggerId) Creates a new dispatch trigger with the primary key.com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) deleteDispatchTrigger(long dispatchTriggerId) Deletes the dispatch trigger with the primary key from the database.deleteDispatchTrigger(DispatchTrigger dispatchTrigger) Deletes the dispatch trigger 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.fetchDispatchTrigger(long dispatchTriggerId) fetchDispatchTrigger(long companyId, String name) fetchDispatchTriggerByExternalReferenceCode(String externalReferenceCode, long companyId) fetchDispatchTriggerByUuidAndCompanyId(String uuid, long companyId) Returns the dispatch trigger with the matching UUID and company.fetchNextFireDate(long dispatchTriggerId) fetchPreviousFireDate(long dispatchTriggerId) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerygetDispatchTrigger(long dispatchTriggerId) Returns the dispatch trigger with the primary key.getDispatchTriggerByExternalReferenceCode(String externalReferenceCode, long companyId) getDispatchTriggerByUuidAndCompanyId(String uuid, long companyId) Returns the dispatch trigger with the matching UUID and company.getDispatchTriggers(boolean active) getDispatchTriggers(boolean active, DispatchTaskClusterMode dispatchTaskClusterMode) getDispatchTriggers(int start, int end) Returns a range of all the dispatch triggers.getDispatchTriggers(long companyId, int start, int end) intReturns the number of dispatch triggers.intgetDispatchTriggersCount(long companyId) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerygetNextFireDate(long dispatchTriggerId) Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) getPreviousFireDate(long dispatchTriggerId) getUserDispatchTriggers(long companyId, long userId, int start, int end) intgetUserDispatchTriggersCount(long companyId, long userId) updateDispatchTrigger(long dispatchTriggerId, boolean active, String cronExpression, DispatchTaskClusterMode dispatchTaskClusterMode, int endDateMonth, int endDateDay, int endDateYear, int endDateHour, int endDateMinute, boolean neverEnd, boolean overlapAllowed, int startDateMonth, int startDateDay, int startDateYear, int startDateHour, int startDateMinute, String timeZoneId) updateDispatchTrigger(long dispatchTriggerId, com.liferay.portal.kernel.util.UnicodeProperties taskSettingsUnicodeProperties, String name) updateDispatchTrigger(DispatchTrigger dispatchTrigger) Updates the dispatch trigger 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
-
addDispatchTrigger
Adds the dispatch trigger to the database. Also notifies the appropriate model listeners.Important: Inspect DispatchTriggerLocalServiceImpl 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:
dispatchTrigger- the dispatch trigger- Returns:
- the dispatch trigger that was added
-
addDispatchTrigger
DispatchTrigger addDispatchTrigger(String externalReferenceCode, long userId, DispatchTaskExecutor dispatchTaskExecutor, String dispatchTaskExecutorType, com.liferay.portal.kernel.util.UnicodeProperties dispatchTaskSettingsUnicodeProperties, String name, boolean system) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addDispatchTrigger
DispatchTrigger addDispatchTrigger(String externalReferenceCode, long userId, String dispatchTaskExecutorType, com.liferay.portal.kernel.util.UnicodeProperties dispatchTaskSettingsUnicodeProperties, String name, boolean system) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createDispatchTrigger
Creates a new dispatch trigger with the primary key. Does not add the dispatch trigger to the database.- Parameters:
dispatchTriggerId- the primary key for the new dispatch trigger- Returns:
- the new dispatch trigger
-
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
-
deleteDispatchTrigger
@Indexable(type=DELETE) @SystemEvent(type=1) DispatchTrigger deleteDispatchTrigger(DispatchTrigger dispatchTrigger) throws com.liferay.portal.kernel.exception.PortalException Deletes the dispatch trigger from the database. Also notifies the appropriate model listeners.Important: Inspect DispatchTriggerLocalServiceImpl 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:
dispatchTrigger- the dispatch trigger- Returns:
- the dispatch trigger that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteDispatchTrigger
@Indexable(type=DELETE) DispatchTrigger deleteDispatchTrigger(long dispatchTriggerId) throws com.liferay.portal.kernel.exception.PortalException Deletes the dispatch trigger with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect DispatchTriggerLocalServiceImpl 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:
dispatchTriggerId- the primary key of the dispatch trigger- Returns:
- the dispatch trigger that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a dispatch trigger 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.dispatch.model.impl.DispatchTriggerModelImpl.- 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.dispatch.model.impl.DispatchTriggerModelImpl.- 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
-
fetchDispatchTrigger
@Transactional(propagation=SUPPORTS, readOnly=true) DispatchTrigger fetchDispatchTrigger(long dispatchTriggerId) -
fetchDispatchTrigger
@Transactional(propagation=SUPPORTS, readOnly=true) DispatchTrigger fetchDispatchTrigger(long companyId, String name) -
fetchDispatchTriggerByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) DispatchTrigger fetchDispatchTriggerByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchDispatchTriggerByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) DispatchTrigger fetchDispatchTriggerByUuidAndCompanyId(String uuid, long companyId) Returns the dispatch trigger with the matching UUID and company.- Parameters:
uuid- the dispatch trigger's UUIDcompanyId- the primary key of the company- Returns:
- the matching dispatch trigger, or
nullif a matching dispatch trigger could not be found
-
fetchNextFireDate
-
fetchPreviousFireDate
@Transactional(propagation=SUPPORTS, readOnly=true) Date fetchPreviousFireDate(long dispatchTriggerId) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getDispatchTrigger
@Transactional(propagation=SUPPORTS, readOnly=true) DispatchTrigger getDispatchTrigger(long dispatchTriggerId) throws com.liferay.portal.kernel.exception.PortalException Returns the dispatch trigger with the primary key.- Parameters:
dispatchTriggerId- the primary key of the dispatch trigger- Returns:
- the dispatch trigger
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a dispatch trigger with the primary key could not be found
-
getDispatchTriggerByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) DispatchTrigger getDispatchTriggerByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getDispatchTriggerByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) DispatchTrigger getDispatchTriggerByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException Returns the dispatch trigger with the matching UUID and company.- Parameters:
uuid- the dispatch trigger's UUIDcompanyId- the primary key of the company- Returns:
- the matching dispatch trigger
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a matching dispatch trigger could not be found
-
getDispatchTriggers
@Transactional(propagation=SUPPORTS, readOnly=true) List<DispatchTrigger> getDispatchTriggers(boolean active) -
getDispatchTriggers
@Transactional(propagation=SUPPORTS, readOnly=true) List<DispatchTrigger> getDispatchTriggers(boolean active, DispatchTaskClusterMode dispatchTaskClusterMode) -
getDispatchTriggers
@Transactional(propagation=SUPPORTS, readOnly=true) List<DispatchTrigger> getDispatchTriggers(int start, int end) Returns a range of all the dispatch triggers.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.dispatch.model.impl.DispatchTriggerModelImpl.- Parameters:
start- the lower bound of the range of dispatch triggersend- the upper bound of the range of dispatch triggers (not inclusive)- Returns:
- the range of dispatch triggers
-
getDispatchTriggers
@Transactional(propagation=SUPPORTS, readOnly=true) List<DispatchTrigger> getDispatchTriggers(long companyId, int start, int end) -
getDispatchTriggersCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getDispatchTriggersCount()Returns the number of dispatch triggers.- Returns:
- the number of dispatch triggers
-
getDispatchTriggersCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getDispatchTriggersCount(long companyId) -
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() -
getNextFireDate
@Transactional(propagation=SUPPORTS, readOnly=true) Date getNextFireDate(long dispatchTriggerId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
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
-
getPreviousFireDate
@Transactional(propagation=SUPPORTS, readOnly=true) Date getPreviousFireDate(long dispatchTriggerId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getUserDispatchTriggers
@Transactional(propagation=SUPPORTS, readOnly=true) List<DispatchTrigger> getUserDispatchTriggers(long companyId, long userId, int start, int end) -
getUserDispatchTriggersCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getUserDispatchTriggersCount(long companyId, long userId) -
updateDispatchTrigger
Updates the dispatch trigger in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect DispatchTriggerLocalServiceImpl 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:
dispatchTrigger- the dispatch trigger- Returns:
- the dispatch trigger that was updated
-
updateDispatchTrigger
DispatchTrigger updateDispatchTrigger(long dispatchTriggerId, boolean active, String cronExpression, DispatchTaskClusterMode dispatchTaskClusterMode, int endDateMonth, int endDateDay, int endDateYear, int endDateHour, int endDateMinute, boolean neverEnd, boolean overlapAllowed, int startDateMonth, int startDateDay, int startDateYear, int startDateHour, int startDateMinute, String timeZoneId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateDispatchTrigger
DispatchTrigger updateDispatchTrigger(long dispatchTriggerId, com.liferay.portal.kernel.util.UnicodeProperties taskSettingsUnicodeProperties, String name) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-