001
014
015 package com.liferay.portal.kernel.scheduler;
016
017 import aQute.bnd.annotation.ProviderType;
018
019 import com.liferay.portal.kernel.messaging.Message;
020 import com.liferay.portal.kernel.messaging.proxy.MessagingProxy;
021 import com.liferay.portal.kernel.messaging.proxy.ProxyMode;
022 import com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse;
023
024 import java.util.List;
025
026
032 @ProviderType
033 public interface SchedulerEngine {
034
035 public static final String DESCRIPTION = "DESCRIPTION";
036
037 public static final String DESTINATION_NAME = "DESTINATION_NAME";
038
039 public static final String DISABLE = "DISABLE";
040
041 public static final String END_TIME = "END_TIME";
042
043 public static final String EXCEPTIONS_MAX_SIZE = "EXCEPTIONS_MAX_SIZE";
044
045 public static final String FINAL_FIRE_TIME = "FINAL_FIRE_TIME";
046
047 public static final String GROUP_NAME = "GROUP_NAME";
048
049 public static final String JOB_NAME = "JOB_NAME";
050
051 public static final String JOB_STATE = "JOB_STATE";
052
053 public static final String LANGUAGE = "LANGUAGE";
054
055 public static final String MESSAGE = "MESSAGE";
056
057
060 @Deprecated
061 public static final String MESSAGE_LISTENER_CLASS_NAME =
062 "MESSAGE_LISTENER_CLASS_NAME";
063
064
067 @Deprecated
068 public static final String MESSAGE_LISTENER_UUID = "MESSAGE_LISTENER_UUID";
069
070 public static final String NEXT_FIRE_TIME = "NEXT_FIRE_TIME";
071
072
075 @Deprecated
076 public static final String PORTLET_ID = "PORTLET_ID";
077
078 public static final String PREVIOUS_FIRE_TIME = "PREVIOUS_FIRE_TIME";
079
080
083 @Deprecated
084 public static final String RECEIVER_KEY = "RECEIVER_KEY";
085
086 public static final String SCHEDULER = "SCHEDULER";
087
088 public static final String SCRIPT = "SCRIPT";
089
090 public static final String START_TIME = "START_TIME";
091
092 public static final String STORAGE_TYPE = "STORAGE_TYPE";
093
094 public void delete(String groupName, StorageType storageType)
095 throws SchedulerException;
096
097 public void delete(
098 String jobName, String groupName, StorageType storageType)
099 throws SchedulerException;
100
101 @MessagingProxy(mode = ProxyMode.SYNC)
102 public SchedulerResponse getScheduledJob(
103 String jobName, String groupName, StorageType storageType)
104 throws SchedulerException;
105
106 @MessagingProxy(mode = ProxyMode.SYNC)
107 public List<SchedulerResponse> getScheduledJobs() throws SchedulerException;
108
109 @MessagingProxy(mode = ProxyMode.SYNC)
110 public List<SchedulerResponse> getScheduledJobs(StorageType storageType)
111 throws SchedulerException;
112
113 @MessagingProxy(mode = ProxyMode.SYNC)
114 public List<SchedulerResponse> getScheduledJobs(
115 String groupName, StorageType storageType)
116 throws SchedulerException;
117
118 public void pause(String groupName, StorageType storageType)
119 throws SchedulerException;
120
121 public void pause(String jobName, String groupName, StorageType storageType)
122 throws SchedulerException;
123
124 public void resume(String groupName, StorageType storageType)
125 throws SchedulerException;
126
127 public void resume(
128 String jobName, String groupName, StorageType storageType)
129 throws SchedulerException;
130
131 public void schedule(
132 Trigger trigger, String description, String destinationName,
133 Message message, StorageType storageType)
134 throws SchedulerException;
135
136 @MessagingProxy(local = true, mode = ProxyMode.SYNC)
137 public void shutdown() throws SchedulerException;
138
139 @MessagingProxy(local = true, mode = ProxyMode.SYNC)
140 public void start() throws SchedulerException;
141
142 public void suppressError(
143 String jobName, String groupName, StorageType storageType)
144 throws SchedulerException;
145
146 @MessagingProxy(mode = ProxyMode.SYNC)
147 public void unschedule(String groupName, StorageType storageType)
148 throws SchedulerException;
149
150 @MessagingProxy(mode = ProxyMode.SYNC)
151 public void unschedule(
152 String jobName, String groupName, StorageType storageType)
153 throws SchedulerException;
154
155 public void update(Trigger trigger, StorageType storageType)
156 throws SchedulerException;
157
158 }