com.highdeal.bart.hci
Class SchedulableJobModel

java.lang.Object
  com.highdeal.bart.hci.SchedulableJobModel

All Implemented Interfaces:

XMLMarshallable, java.lang.Comparable<SchedulableJobModel>

Direct Known Subclasses:

CleanDatabaseJobModel, RunRatingSessionJobModel

public abstract class SchedulableJobModel
extends java.lang.Object
implements XMLMarshallable, java.lang.Comparable<SchedulableJobModel>

This abstract Java class represents a job for BART Server as it is presented on client side and in the BART Tool user interface.

A schedulable job for BART is defined by three parameters:

• Its polling period or its recurrence
• Its status (active of inactive)
• Its description

The known Java implementations of this class are:

• CleanDatabaseJobModel
• RunRatingSessionJobModel

Field Summary

static int	STATUS_ACTIVE This status indicates that the job is active
static int	STATUS_INACTIVE This status indicates that the job is inactive

Constructor Summary

SchedulableJobModel()

Method Summary

java.lang.Long	_getJobID() Returns The unique job identifier
java.util.Date	_getLastActivationDate() FOR INTERNAL USE ONLY - Returns the last activation date.
void	_setJobID(java.lang.Long id) Sets the unique job identifier
void	_setLastActivationDate(java.util.Date lad) FOR INTERNAL USE ONLY - Sets the last activation date.
int	compareTo(SchedulableJobModel o)
java.lang.String	getDescription() Returns The job description
abstract java.lang.String	getJobClassName() Gets the class name of the job.
java.lang.Long	getPollingPeriod() Gets the polling period.
com.highdeal.util.Recurrence	getRecurrence() Gets the recurrence.
java.lang.String	getRecurrenceAsString() Gets the recurrence in String format.
int	getStatus() Returns the status of the job.
protected void	innerMarshall(XMLOutputter output)
protected void	innerSetAttributes(XMLAttributes atts)
protected int	parseStatus(java.lang.String s) Transforms the status from its string form to its constant value.
void	setDescription(java.lang.String s) Sets the job description
void	setPollingPeriod(java.lang.Long pollingPeriod) Sets the polling period.
void	setRecurrence(com.highdeal.util.Recurrence recurrence) Sets the recurrence.
void	setRecurrenceAsString(java.lang.String recurrenceFormat) Sets the recurrence in String format.
void	setStatus(int status) Sets the status of the job.
protected java.lang.String	statusToString() Transforms the current status to its string representation.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highdeal.hci.XMLMarshallable

addCharacterData, addChild, marshal, setAttributes

Field Detail

STATUS_ACTIVE

public static final int STATUS_ACTIVE

This status indicates that the job is active

See Also:

Constant Field Values

STATUS_INACTIVE

public static final int STATUS_INACTIVE

This status indicates that the job is inactive

See Also:

Constant Field Values

Constructor Detail

SchedulableJobModel

public SchedulableJobModel()

Method Detail

setPollingPeriod

public void setPollingPeriod(java.lang.Long pollingPeriod)

Sets the polling period.

Parameters:

pollingPeriod - The polling period

setRecurrenceAsString

public void setRecurrenceAsString(java.lang.String recurrenceFormat)

Sets the recurrence in String format.

Parameters:

recurrenceFormat - The recurrence in String format

getPollingPeriod

public java.lang.Long getPollingPeriod()

Gets the polling period.

Returns:

The polling period

getRecurrenceAsString

public java.lang.String getRecurrenceAsString()

Gets the recurrence in String format.

Returns:

The recurrence in String format

setRecurrence

public void setRecurrence(com.highdeal.util.Recurrence recurrence)

Sets the recurrence.

Parameters:

recurrence - The recurrence

getRecurrence

public com.highdeal.util.Recurrence getRecurrence()

Gets the recurrence.

Returns:

The recurrence

getDescription

public java.lang.String getDescription()

Returns The job description

setDescription

public void setDescription(java.lang.String s)

Sets the job description

setStatus

public void setStatus(int status)

Sets the status of the job.

Parameters:

status - The status of the job

getStatus

public int getStatus()

Returns the status of the job.

Returns:

The status of the job

getJobClassName

public abstract java.lang.String getJobClassName()

Gets the class name of the job.

Returns:

The class name of the job

_getJobID

public java.lang.Long _getJobID()

Returns The unique job identifier

_setJobID

public void _setJobID(java.lang.Long id)

Sets the unique job identifier

_getLastActivationDate

public java.util.Date _getLastActivationDate()

FOR INTERNAL USE ONLY - Returns the last activation date.

Returns:

lastActivationDate

_setLastActivationDate

public void _setLastActivationDate(java.util.Date lad)

FOR INTERNAL USE ONLY - Sets the last activation date.

Parameters:

lad - The last activation date

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

parseStatus

protected int parseStatus(java.lang.String s)

Transforms the status from its string form to its constant value.

Parameters:

s - The status in its string form

Returns:

The status in its constant value

statusToString

protected java.lang.String statusToString()

Transforms the current status to its string representation.

Returns:

The current status to its string representation

innerMarshall

protected void innerMarshall(XMLOutputter output)

innerSetAttributes

protected void innerSetAttributes(XMLAttributes atts)

compareTo

public int compareTo(SchedulableJobModel o)

Specified by:

compareTo in interface java.lang.Comparable<SchedulableJobModel>