com.liferay.dispatch.service

Class DispatchTriggerLocalServiceUtil

java.lang.Object

com.liferay.dispatch.service.DispatchTriggerLocalServiceUtil

public class DispatchTriggerLocalServiceUtil
extends java.lang.Object

Provides the local service utility for DispatchTrigger. This utility wraps com.liferay.dispatch.service.impl.DispatchTriggerLocalServiceImpl 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:

DispatchTriggerLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
DispatchTriggerLocalServiceUtil()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DispatchTriggerLocalServiceUtil

public DispatchTriggerLocalServiceUtil()

Method Detail

addDispatchTrigger

public static 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

public static 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

public static 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

public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteDispatchTrigger

public static 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

public static 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

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

public static <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

public static <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

public static <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

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 query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchDispatchTrigger

public static DispatchTrigger fetchDispatchTrigger(long dispatchTriggerId)

fetchDispatchTrigger

public static DispatchTrigger fetchDispatchTrigger(long companyId,
                                                   java.lang.String name)

fetchNextFireDate

public static java.util.Date fetchNextFireDate(long dispatchTriggerId)

fetchPreviousFireDate

public static java.util.Date fetchPreviousFireDate(long dispatchTriggerId)

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getDispatchTrigger

public static 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

public static java.util.List<DispatchTrigger> getDispatchTriggers(boolean active,
                                                                  DispatchTaskClusterMode dispatchTaskClusterMode)

getDispatchTriggers

public static 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

public static java.util.List<DispatchTrigger> getDispatchTriggers(long companyId,
                                                                  int start,
                                                                  int end)

getDispatchTriggersCount

public static int getDispatchTriggersCount()

Returns the number of dispatch triggers.

Returns:

the number of dispatch triggers

getDispatchTriggersCount

public static int getDispatchTriggersCount(long companyId)

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getNextFireDate

public static java.util.Date getNextFireDate(long dispatchTriggerId)
                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPreviousFireDate

public static java.util.Date getPreviousFireDate(long dispatchTriggerId)
                                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getUserDispatchTriggers

public static java.util.List<DispatchTrigger> getUserDispatchTriggers(long companyId,
                                                                      long userId,
                                                                      int start,
                                                                      int end)

getUserDispatchTriggersCount

public static int getUserDispatchTriggersCount(long companyId,
                                               long userId)

updateDispatchTrigger

public static 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

public static 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

public static 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

getService

public static DispatchTriggerLocalService getService()