net.bluemind.maintenance.job

Class MaintenanceJob

java.lang.Object

net.bluemind.maintenance.job.MaintenanceJob

All Implemented Interfaces:

IScheduledJob

public class MaintenanceJob
extends java.lang.Object
implements IScheduledJob

Constructor Summary

Constructors

Constructor and Description
MaintenanceJob()

Method Summary

Modifier and Type	Method and Description
void	cancel()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MaintenanceJob

public MaintenanceJob()

Method Detail

getDescription

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

Specified by:

getDescription in interface IScheduledJob

getJobId

public java.lang.String getJobId()

Specified by:

getJobId in interface IScheduledJob

tick

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

Description copied from interface: IScheduledJob

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.

Specified by:

tick in interface IScheduledJob

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

Throws:

ServerFault

cancel

public void cancel()

Specified by:

cancel in interface IScheduledJob

getType

public JobKind getType()

Specified by:

getType in interface IScheduledJob

getLockedResources

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

Specified by:

getLockedResources in interface IScheduledJob

supportsScheduling

public boolean supportsScheduling()

Specified by:

supportsScheduling in interface IScheduledJob