com.liferay.dispatch.service

Interface DispatchTriggerLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

DispatchTriggerLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface DispatchTriggerLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for DispatchTrigger. 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:

DispatchTriggerLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
DispatchTrigger	addDispatchTrigger(DispatchTrigger dispatchTrigger) Adds the dispatch trigger to the database.
DispatchTrigger	addDispatchTrigger(long userId, java.lang.String dispatchTaskExecutorType, com.liferay.portal.kernel.util.UnicodeProperties dispatchTaskSettingsUnicodeProperties, java.lang.String name, boolean system)
DispatchTrigger	createDispatchTrigger(long dispatchTriggerId) Creates a new dispatch trigger with the primary key.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
DispatchTrigger	deleteDispatchTrigger(DispatchTrigger dispatchTrigger) Deletes the dispatch trigger from the database.
DispatchTrigger	deleteDispatchTrigger(long dispatchTriggerId) Deletes the dispatch trigger with the primary key from the database.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.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> java.util.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.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
DispatchTrigger	fetchDispatchTrigger(long dispatchTriggerId)
DispatchTrigger	fetchDispatchTrigger(long companyId, java.lang.String name)
java.util.Date	fetchNextFireDate(long dispatchTriggerId)
java.util.Date	fetchPreviousFireDate(long dispatchTriggerId)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
DispatchTrigger	getDispatchTrigger(long dispatchTriggerId) Returns the dispatch trigger with the primary key.
java.util.List<DispatchTrigger>	getDispatchTriggers(boolean active, DispatchTaskClusterMode dispatchTaskClusterMode)
java.util.List<DispatchTrigger>	getDispatchTriggers(int start, int end) Returns a range of all the dispatch triggers.
java.util.List<DispatchTrigger>	getDispatchTriggers(long companyId, int start, int end)
int	getDispatchTriggersCount() Returns the number of dispatch triggers.
int	getDispatchTriggersCount(long companyId)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.util.Date	getNextFireDate(long dispatchTriggerId)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.Date	getPreviousFireDate(long dispatchTriggerId)
java.util.List<DispatchTrigger>	getUserDispatchTriggers(long companyId, long userId, int start, int end)
int	getUserDispatchTriggersCount(long companyId, long userId)
DispatchTrigger	updateDispatchTrigger(DispatchTrigger dispatchTrigger) Updates the dispatch trigger in the database or adds it if it does not yet exist.
DispatchTrigger	updateDispatchTrigger(long dispatchTriggerId, boolean active, java.lang.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)
DispatchTrigger	updateDispatchTrigger(long dispatchTriggerId, com.liferay.portal.kernel.util.UnicodeProperties taskSettingsUnicodeProperties, java.lang.String name)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addDispatchTrigger

@Indexable(type=REINDEX)
DispatchTrigger addDispatchTrigger(DispatchTrigger dispatchTrigger)

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(long userId,
                                   java.lang.String dispatchTaskExecutorType,
                                   com.liferay.portal.kernel.util.UnicodeProperties dispatchTaskSettingsUnicodeProperties,
                                   java.lang.String name,
                                   boolean system)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createDispatchTrigger

@Transactional(enabled=false)
DispatchTrigger createDispatchTrigger(long dispatchTriggerId)

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(java.io.Serializable primaryKeyObj)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

createPersistedModel in interface com.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:

deletePersistedModel in interface com.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)

dslQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.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> java.util.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.dispatch.model.impl.DispatchTriggerModelImpl.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.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.dispatch.model.impl.DispatchTriggerModelImpl.

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

@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 query

projection - 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,
                                                                                                        java.lang.String name)

fetchNextFireDate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.Date fetchNextFireDate(long dispatchTriggerId)

fetchPreviousFireDate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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

getDispatchTriggers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DispatchTrigger> getDispatchTriggers(boolean active,
                                                                                                                       DispatchTaskClusterMode dispatchTaskClusterMode)

getDispatchTriggers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DispatchTrigger> getDispatchTriggers(int start,
                                                                                                                       int end)

Returns a range of all the dispatch triggers.

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.dispatch.model.impl.DispatchTriggerModelImpl.

Parameters:

start - the lower bound of the range of dispatch triggers

end - the upper bound of the range of dispatch triggers (not inclusive)

Returns:

the range of dispatch triggers

getDispatchTriggers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getNextFireDate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.Date getNextFireDate(long dispatchTriggerId)
                                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getOSGiServiceIdentifier

java.lang.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(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

getPreviousFireDate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.Date getPreviousFireDate(long dispatchTriggerId)
                                                                                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getUserDispatchTriggers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DispatchTrigger> getUserDispatchTriggers(long companyId,
                                                                                                                           long userId,
                                                                                                                           int start,
                                                                                                                           int end)

getUserDispatchTriggersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserDispatchTriggersCount(long companyId,
                                                                                                    long userId)

updateDispatchTrigger

@Indexable(type=REINDEX)
DispatchTrigger updateDispatchTrigger(DispatchTrigger dispatchTrigger)

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,
                                      java.lang.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)
                               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,
                                      java.lang.String name)
                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException