net.bluemind.scheduledjob.scheduler

Interface IScheduledJob

All Known Implementing Classes:

CalendarIndexJob, ConsolidateMailspoolIndexJob, ContactIndexJob, DataProtectJob, DomainJob, DummyJob1, DummyJob2, ExecutionsCleanerJob, FileHostingCleanUpJob, GlobalJob, HSMIndexJob, HSMJob, ImportLdapJob, LdapAddressBookSyncJob, LockingJob1, LockingJob2, LockingJob3, OutOfOfficeJob, PasswordExpireNotificationJob, QuotaGatheringJob, ReconstructMailspoolIndexJob, TodoListIndexJob

public interface IScheduledJob

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription(java.lang.String locale)
java.lang.String	getJobId()
java.util.Set<java.lang.String>	getLockedResources()
JobKind	getType()
boolean	supportsScheduling()
void	tick(IScheduler sched, boolean forced, java.lang.String domainName, java.util.Date startDate) This method is called by Blue Mind's scheduler.

Method Detail

tick

void tick(IScheduler sched,
          boolean forced,
          java.lang.String domainName,
          java.util.Date startDate)
   throws ServerFault

This method is called by Blue Mind's scheduler. When plannedExecution is true, the task must comply and run (if relevant for the given domain). When planned execution is false, the task can decide what to do.

Parameters:

sched -

forced - True when started by hand on from a scheduled plan. False when the job is in automatic mode.

domain -

startDate -

Throws:

ServerFault

getType

JobKind getType()

getDescription

java.lang.String getDescription(java.lang.String locale)

getJobId

java.lang.String getJobId()

getLockedResources

java.util.Set<java.lang.String> getLockedResources()

supportsScheduling

boolean supportsScheduling()