Class DispatchTriggerLocalServiceUtil
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:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic DispatchTriggeraddDispatchTrigger(DispatchTrigger dispatchTrigger) Adds the dispatch trigger to the database.static DispatchTriggeraddDispatchTrigger(String externalReferenceCode, long userId, DispatchTaskExecutor dispatchTaskExecutor, String dispatchTaskExecutorType, com.liferay.portal.kernel.util.UnicodeProperties dispatchTaskSettingsUnicodeProperties, String name, boolean system) static DispatchTriggeraddDispatchTrigger(String externalReferenceCode, long userId, String dispatchTaskExecutorType, com.liferay.portal.kernel.util.UnicodeProperties dispatchTaskSettingsUnicodeProperties, String name, boolean system) static DispatchTriggercreateDispatchTrigger(long dispatchTriggerId) Creates a new dispatch trigger with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static DispatchTriggerdeleteDispatchTrigger(long dispatchTriggerId) Deletes the dispatch trigger with the primary key from the database.static DispatchTriggerdeleteDispatchTrigger(DispatchTrigger dispatchTrigger) Deletes the dispatch trigger from the database.static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> 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> 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> 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 longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static 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.static DispatchTriggerfetchDispatchTrigger(long dispatchTriggerId) static DispatchTriggerfetchDispatchTrigger(long companyId, String name) static DispatchTriggerfetchDispatchTriggerByExternalReferenceCode(String externalReferenceCode, long companyId) static DispatchTriggerfetchDispatchTriggerByUuidAndCompanyId(String uuid, long companyId) Returns the dispatch trigger with the matching UUID and company.static DatefetchNextFireDate(long dispatchTriggerId) static DatefetchPreviousFireDate(long dispatchTriggerId) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic DispatchTriggergetDispatchTrigger(long dispatchTriggerId) Returns the dispatch trigger with the primary key.static DispatchTriggergetDispatchTriggerByExternalReferenceCode(String externalReferenceCode, long companyId) static DispatchTriggergetDispatchTriggerByUuidAndCompanyId(String uuid, long companyId) Returns the dispatch trigger with the matching UUID and company.static List<DispatchTrigger> getDispatchTriggers(boolean active) static List<DispatchTrigger> getDispatchTriggers(boolean active, DispatchTaskClusterMode dispatchTaskClusterMode) static List<DispatchTrigger> getDispatchTriggers(int start, int end) Returns a range of all the dispatch triggers.static List<DispatchTrigger> getDispatchTriggers(long companyId, int start, int end) static intReturns the number of dispatch triggers.static intgetDispatchTriggersCount(long companyId) static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic DategetNextFireDate(long dispatchTriggerId) static StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static DategetPreviousFireDate(long dispatchTriggerId) static DispatchTriggerLocalServicestatic List<DispatchTrigger> getUserDispatchTriggers(long companyId, long userId, int start, int end) static intgetUserDispatchTriggersCount(long companyId, long userId) static DispatchTriggerupdateDispatchTrigger(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) static DispatchTriggerupdateDispatchTrigger(long dispatchTriggerId, com.liferay.portal.kernel.util.UnicodeProperties taskSettingsUnicodeProperties, String name) static DispatchTriggerupdateDispatchTrigger(DispatchTrigger dispatchTrigger) Updates the dispatch trigger in the database or adds it if it does not yet exist.
-
Constructor Details
-
DispatchTriggerLocalServiceUtil
public DispatchTriggerLocalServiceUtil()
-
-
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
public static 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
public static 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
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(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
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> 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
public static <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
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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchDispatchTrigger
-
fetchDispatchTrigger
-
fetchDispatchTriggerByExternalReferenceCode
public static DispatchTrigger fetchDispatchTriggerByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchDispatchTriggerByUuidAndCompanyId
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
-
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
-
getDispatchTriggerByExternalReferenceCode
public static DispatchTrigger getDispatchTriggerByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getDispatchTriggerByUuidAndCompanyId
public static 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
-
getDispatchTriggers
public static List<DispatchTrigger> getDispatchTriggers(boolean active, DispatchTaskClusterMode dispatchTaskClusterMode) -
getDispatchTriggers
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
-
getDispatchTriggersCount
public static int getDispatchTriggersCount()Returns the number of dispatch triggers.- Returns:
- the number of dispatch triggers
-
getDispatchTriggersCount
public static int getDispatchTriggersCount(long companyId) -
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getNextFireDate
public static Date getNextFireDate(long dispatchTriggerId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getPreviousFireDate
public static Date getPreviousFireDate(long dispatchTriggerId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getUserDispatchTriggers
public static List<DispatchTrigger> getUserDispatchTriggers(long companyId, long userId, int start, int end) -
getUserDispatchTriggersCount
public static 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
public static 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
public static 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
-
getService
-