Liferay 6.2-ce-ga5

com.liferay.portal.kernel.scheduler
Interface SchedulerEngine


public interface SchedulerEngine


Field Summary
static String AUDIT_ACTION
           
static String DESCRIPTION
           
static int DESCRIPTION_MAX_LENGTH
           
static String DESTINATION_NAME
           
static String DISABLE
           
static String END_TIME
           
static String EXCEPTIONS_MAX_SIZE
           
static String FINAL_FIRE_TIME
           
static String GROUP_NAME
           
static int GROUP_NAME_MAX_LENGTH
           
static String JOB_NAME
           
static int JOB_NAME_MAX_LENGTH
           
static String JOB_STATE
           
static String LANGUAGE
           
static String MESSAGE
           
static String MESSAGE_LISTENER_CLASS_NAME
           
static String MESSAGE_LISTENER_UUID
           
static String NEXT_FIRE_TIME
           
static String PORTLET_ID
           
static String PREVIOUS_FIRE_TIME
           
static String RECEIVER_KEY
           
static String SCRIPT
           
static String START_TIME
           
static String STORAGE_TYPE
           
 
Method Summary
 void delete(String groupName)
           
 void delete(String jobName, String groupName)
           
 SchedulerResponse getScheduledJob(String jobName, String groupName)
           
 List<SchedulerResponse> getScheduledJobs()
           
 List<SchedulerResponse> getScheduledJobs(String groupName)
           
 void pause(String groupName)
           
 void pause(String jobName, String groupName)
           
 void resume(String groupName)
           
 void resume(String jobName, String groupName)
           
 void schedule(Trigger trigger, String description, String destinationName, Message message)
           
 void shutdown()
           
 void start()
           
 void suppressError(String jobName, String groupName)
           
 void unschedule(String groupName)
           
 void unschedule(String jobName, String groupName)
           
 void update(Trigger trigger)
           
 

Field Detail

AUDIT_ACTION

static final String AUDIT_ACTION
See Also:
Constant Field Values

DESCRIPTION

static final String DESCRIPTION
See Also:
Constant Field Values

DESCRIPTION_MAX_LENGTH

static final int DESCRIPTION_MAX_LENGTH

DESTINATION_NAME

static final String DESTINATION_NAME
See Also:
Constant Field Values

DISABLE

static final String DISABLE
See Also:
Constant Field Values

END_TIME

static final String END_TIME
See Also:
Constant Field Values

EXCEPTIONS_MAX_SIZE

static final String EXCEPTIONS_MAX_SIZE
See Also:
Constant Field Values

FINAL_FIRE_TIME

static final String FINAL_FIRE_TIME
See Also:
Constant Field Values

GROUP_NAME

static final String GROUP_NAME
See Also:
Constant Field Values

GROUP_NAME_MAX_LENGTH

static final int GROUP_NAME_MAX_LENGTH

JOB_NAME

static final String JOB_NAME
See Also:
Constant Field Values

JOB_NAME_MAX_LENGTH

static final int JOB_NAME_MAX_LENGTH

JOB_STATE

static final String JOB_STATE
See Also:
Constant Field Values

LANGUAGE

static final String LANGUAGE
See Also:
Constant Field Values

MESSAGE

static final String MESSAGE
See Also:
Constant Field Values

MESSAGE_LISTENER_CLASS_NAME

static final String MESSAGE_LISTENER_CLASS_NAME
See Also:
Constant Field Values

MESSAGE_LISTENER_UUID

static final String MESSAGE_LISTENER_UUID
See Also:
Constant Field Values

NEXT_FIRE_TIME

static final String NEXT_FIRE_TIME
See Also:
Constant Field Values

PORTLET_ID

static final String PORTLET_ID
See Also:
Constant Field Values

PREVIOUS_FIRE_TIME

static final String PREVIOUS_FIRE_TIME
See Also:
Constant Field Values

RECEIVER_KEY

static final String RECEIVER_KEY
See Also:
Constant Field Values

SCRIPT

static final String SCRIPT
See Also:
Constant Field Values

START_TIME

static final String START_TIME
See Also:
Constant Field Values

STORAGE_TYPE

static final String STORAGE_TYPE
See Also:
Constant Field Values
Method Detail

delete

void delete(String groupName)
            throws SchedulerException
Throws:
SchedulerException

delete

void delete(String jobName,
            String groupName)
            throws SchedulerException
Throws:
SchedulerException

getScheduledJob

@MessagingProxy(mode=SYNC)
SchedulerResponse getScheduledJob(String jobName,
                                                         String groupName)
                                  throws SchedulerException
Throws:
SchedulerException

getScheduledJobs

@MessagingProxy(mode=SYNC)
List<SchedulerResponse> getScheduledJobs()
                                         throws SchedulerException
Throws:
SchedulerException

getScheduledJobs

@MessagingProxy(mode=SYNC)
List<SchedulerResponse> getScheduledJobs(String groupName)
                                         throws SchedulerException
Throws:
SchedulerException

pause

void pause(String groupName)
           throws SchedulerException
Throws:
SchedulerException

pause

void pause(String jobName,
           String groupName)
           throws SchedulerException
Throws:
SchedulerException

resume

void resume(String groupName)
            throws SchedulerException
Throws:
SchedulerException

resume

void resume(String jobName,
            String groupName)
            throws SchedulerException
Throws:
SchedulerException

schedule

void schedule(Trigger trigger,
              String description,
              String destinationName,
              Message message)
              throws SchedulerException
Throws:
SchedulerException

shutdown

@MessagingProxy(local=true,
                mode=SYNC)
void shutdown()
              throws SchedulerException
Throws:
SchedulerException

start

@MessagingProxy(local=true,
                mode=SYNC)
void start()
           throws SchedulerException
Throws:
SchedulerException

suppressError

void suppressError(String jobName,
                   String groupName)
                   throws SchedulerException
Throws:
SchedulerException

unschedule

@MessagingProxy(mode=SYNC)
void unschedule(String groupName)
                throws SchedulerException
Throws:
SchedulerException

unschedule

@MessagingProxy(mode=SYNC)
void unschedule(String jobName,
                                       String groupName)
                throws SchedulerException
Throws:
SchedulerException

update

void update(Trigger trigger)
            throws SchedulerException
Throws:
SchedulerException

Liferay 6.2-ce-ga5