com.liferay.dispatch.service

Interface DispatchTriggerService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseService

All Known Implementing Classes:

DispatchTriggerServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface DispatchTriggerService
extends com.liferay.portal.kernel.service.BaseService

Provides the remote service interface for DispatchTrigger. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

DispatchTriggerServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
DispatchTrigger	addDispatchTrigger(long userId, java.lang.String dispatchTaskExecutorType, com.liferay.portal.kernel.util.UnicodeProperties dispatchTaskSettingsUnicodeProperties, java.lang.String name)
void	deleteDispatchTrigger(long dispatchTriggerId)
java.util.List<DispatchTrigger>	getDispatchTriggers(int start, int end)
int	getDispatchTriggersCount()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
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 dispatchTaskSettingsUnicodeProperties, java.lang.String name)

Method Detail

addDispatchTrigger

DispatchTrigger addDispatchTrigger(long userId,
                                   java.lang.String dispatchTaskExecutorType,
                                   com.liferay.portal.kernel.util.UnicodeProperties dispatchTaskSettingsUnicodeProperties,
                                   java.lang.String name)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteDispatchTrigger

void deleteDispatchTrigger(long dispatchTriggerId)
                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getDispatchTriggers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DispatchTrigger> getDispatchTriggers(int start,
                                                                                                                       int end)
                                                                                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getDispatchTriggersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDispatchTriggersCount()
                                                                                         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

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

Throws:

com.liferay.portal.kernel.exception.PortalException