org.ow2.proactive.scheduler.job

Class JobInfoImpl

java.lang.Object

org.ow2.proactive.scheduler.job.JobInfoImpl

All Implemented Interfaces:

Serializable, JobInfo

public class JobInfoImpl
extends Object
implements JobInfo

JobInfo provides some information about the Job it is linked with.
These information and only them are able to change inside the job, and that's what the scheduler will send to each listener.
To have a job up to date, you must use org.ow2.proactive.scheduler.job.InternalJob#setJobInfo(JobInfo). This will automatically put the job up to date.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobInfoImpl()
JobInfoImpl(JobInfoImpl jobInfo)

Method Summary

Modifier and Type	Method and Description
void	clearTasksChanges()
long	getFinishedTime() Returns the time at which the Job has finished.
Map<String,String>	getGenericInformation() Returns the generic information Map
long	getInErrorTime() Returns the time at which a Job was seen as in-error for the last time.
JobId	getJobId() Returns an identifier that uniquely identifies the Job within a Scheduler instance.
String	getJobOwner() Returns the name of the Job owner.
long	getLastUpdatedTime() Returns the time at which the last updated happened on the Job.
List<ClientTaskState>	getModifiedTasks()
int	getNumberOfFailedTasks() Returns the number of tasks managed by the Job that are in a failed state due to a resource failure.
int	getNumberOfFaultyTasks() Returns the number of tasks managed by the Job that are in a faulty state.
int	getNumberOfFinishedTasks() Returns the number of tasks managed by the Job which are finished.
int	getNumberOfInErrorTasks() Returns the number of tasks managed by the Job that are in an in-error state.
int	getNumberOfPendingTasks() Returns the number of tasks managed by the Job which are pending.
int	getNumberOfRunningTasks() Returns the number of tasks managed by the Job which are running.
JobPriority	getPriority() Returns the priority of the Job.
long	getRemovedTime() Returns the time at which the Job has been marked as removed.
long	getScheduledTimeForRemoval() Returns the scheduled time for removal.
long	getStartTime() Returns the time at which the Job has started.
JobStatus	getStatus() Return the status of the job.
long	getSubmittedTime() Returns the time at which the Job was submitted.
Set<TaskId>	getTasksSkipped() Used as an argument for SchedulerEvent.TASK_SKIPPED to specify which tasks were skipped
int	getTotalNumberOfTasks() Returns the number of tasks managed by the Job.
Map<String,String>	getVariables() Returns the variables Map
boolean	isStarted()
boolean	isToBeRemoved() Returns a boolean that indicates whether the job is marked for removal or not.
void	setFinishedTime(long finishedTime)
void	setGenericInformation(Map<String,String> genericInformation)
void	setInErrorTime(long inErrorTime)
void	setJobId(JobId jobId)
void	setJobOwner(String owner)
void	setLastUpdatedTime(long lastUpdatedTime)
void	setNumberOfFailedTasks(int numberOfFailedTasks)
void	setNumberOfFaultyTasks(int numberOfFaultyTasks)
void	setNumberOfFinishedTasks(int numberOfFinishedTasks)
void	setNumberOfInErrorTasks(int numberOfInErrorTasks)
void	setNumberOfPendingTasks(int numberOfPendingTasks)
void	setNumberOfRunningTasks(int numberOfRunningTasks)
void	setPriority(JobPriority priority)
void	setRemovedTime(long removedTime)
void	setScheduledTimeForRemoval(long scheduledTimeForRemoval)
void	setStartTime(long startTime)
void	setStatus(JobStatus status)
void	setSubmittedTime(long submittedTime)
void	setTasksChanges(ChangedTasksInfo changesInfo, JobState job)
void	setToBeRemoved()
void	setTotalNumberOfTasks(int totalNumberOfTasks)
void	setVariables(Map<String,String> variables)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JobInfoImpl

public JobInfoImpl()

JobInfoImpl

public JobInfoImpl(JobInfoImpl jobInfo)

Method Detail

getJobOwner

public String getJobOwner()

Returns the name of the Job owner.

Specified by:

getJobOwner in interface JobInfo

Returns:

the name of the Job owner (the one who submitted the Job).

setJobOwner

public void setJobOwner(String owner)

getJobId

public JobId getJobId()

Returns an identifier that uniquely identifies the Job within a Scheduler instance.

Specified by:

getJobId in interface JobInfo

Returns:

an identifier that uniquely identifies the Job within a Scheduler instance.

setJobId

public void setJobId(JobId jobId)

getFinishedTime

public long getFinishedTime()

Returns the time at which the Job has finished.

Specified by:

getFinishedTime in interface JobInfo

Returns:

the time at which the Job has finished (i.e. all tasks have finished because of a normal or abnormal termination).

setFinishedTime

public void setFinishedTime(long finishedTime)

getRemovedTime

public long getRemovedTime()

Returns the time at which the Job has been marked as removed.

Specified by:

getRemovedTime in interface JobInfo

Returns:

the time at which the Job has been marked as removed.

setRemovedTime

public void setRemovedTime(long removedTime)

getStartTime

public long getStartTime()

Returns the time at which the Job has started.

Specified by:

getStartTime in interface JobInfo

Returns:

the time at which the Job has started.

isStarted

public boolean isStarted()

Specified by:

isStarted in interface JobInfo

Returns:

true if job is already started

setStartTime

public void setStartTime(long startTime)

getInErrorTime

public long getInErrorTime()

Returns the time at which a Job was seen as in-error for the last time.

Specified by:

getInErrorTime in interface JobInfo

Returns:

the time at which a Job was seen as in-error for the last time. The default value is -1.

setInErrorTime

public void setInErrorTime(long inErrorTime)

getSubmittedTime

public long getSubmittedTime()

Returns the time at which the Job was submitted.

Specified by:

getSubmittedTime in interface JobInfo

Returns:

the time at which the Job was submitted.

setSubmittedTime

public void setSubmittedTime(long submittedTime)

getLastUpdatedTime

public long getLastUpdatedTime()

Description copied from interface: JobInfo

Returns the time at which the last updated happened on the Job.

Specified by:

getLastUpdatedTime in interface JobInfo

Returns:

the time in long format.

setLastUpdatedTime

public void setLastUpdatedTime(long lastUpdatedTime)

getTotalNumberOfTasks

public int getTotalNumberOfTasks()

Returns the number of tasks managed by the Job.

Specified by:

getTotalNumberOfTasks in interface JobInfo

Returns:

the number of tasks managed by the Job. The number should correspond to the sum of tasks which are grouped in pending, running and finished.

setTotalNumberOfTasks

public void setTotalNumberOfTasks(int totalNumberOfTasks)

getNumberOfFinishedTasks

public int getNumberOfFinishedTasks()

Returns the number of tasks managed by the Job which are finished.

Specified by:

getNumberOfFinishedTasks in interface JobInfo

Returns:

the number of tasks managed by the Job which are finished.

setNumberOfFinishedTasks

public void setNumberOfFinishedTasks(int numberOfFinishedTasks)

getNumberOfPendingTasks

public int getNumberOfPendingTasks()

Returns the number of tasks managed by the Job which are pending.

Specified by:

getNumberOfPendingTasks in interface JobInfo

Returns:

the number of tasks managed by the Job which are pending.

setNumberOfPendingTasks

public void setNumberOfPendingTasks(int numberOfPendingTasks)

getNumberOfRunningTasks

public int getNumberOfRunningTasks()

Returns the number of tasks managed by the Job which are running.

Specified by:

getNumberOfRunningTasks in interface JobInfo

Returns:

the number of tasks managed by the Job which are running.

setNumberOfRunningTasks

public void setNumberOfRunningTasks(int numberOfRunningTasks)

getNumberOfFailedTasks

public int getNumberOfFailedTasks()

Returns the number of tasks managed by the Job that are in a failed state due to a resource failure.

Specified by:

getNumberOfFailedTasks in interface JobInfo

Returns:

the number of tasks managed by the Job that are in a failed state due to a resource failure.

setNumberOfFailedTasks

public void setNumberOfFailedTasks(int numberOfFailedTasks)

getNumberOfFaultyTasks

public int getNumberOfFaultyTasks()

Returns the number of tasks managed by the Job that are in a faulty state.

Specified by:

getNumberOfFaultyTasks in interface JobInfo

Returns:

the number of tasks managed by the Job that are in a faulty state due to a task fault (exception or return code).

setNumberOfFaultyTasks

public void setNumberOfFaultyTasks(int numberOfFaultyTasks)

getNumberOfInErrorTasks

public int getNumberOfInErrorTasks()

Returns the number of tasks managed by the Job that are in an in-error state.

Specified by:

getNumberOfInErrorTasks in interface JobInfo

Returns:

the number of tasks managed by the Job that are in an in-error state because of faulty tasks that were configured to suspend on error.

setNumberOfInErrorTasks

public void setNumberOfInErrorTasks(int numberOfInErrorTasks)

getPriority

public JobPriority getPriority()

Returns the priority of the Job.

Specified by:

getPriority in interface JobInfo

Returns:

the priority of the Job.

setPriority

public void setPriority(JobPriority priority)

getStatus

public JobStatus getStatus()

Return the status of the job.

Specified by:

getStatus in interface JobInfo

Returns:

the status of the job.

setStatus

public void setStatus(JobStatus status)

isToBeRemoved

public boolean isToBeRemoved()

Returns a boolean that indicates whether the job is marked for removal or not.

Specified by:

isToBeRemoved in interface JobInfo

Returns:

a boolean that indicates whether the job is marked for removal or not.

setToBeRemoved

public void setToBeRemoved()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

setTasksChanges

public void setTasksChanges(ChangedTasksInfo changesInfo,
                            JobState job)

clearTasksChanges

public void clearTasksChanges()

getModifiedTasks

public List<ClientTaskState> getModifiedTasks()

getTasksSkipped

public Set<TaskId> getTasksSkipped()

Used as an argument for SchedulerEvent.TASK_SKIPPED to specify which tasks were skipped

Returns:

a set of the skipped tasks

setScheduledTimeForRemoval

public void setScheduledTimeForRemoval(long scheduledTimeForRemoval)

getScheduledTimeForRemoval

public long getScheduledTimeForRemoval()

Description copied from interface: JobInfo

Returns the scheduled time for removal. If none is set, returns 0.

Specified by:

getScheduledTimeForRemoval in interface JobInfo

Returns:

the time at which the Job is to be removed.

getGenericInformation

public Map<String,String> getGenericInformation()

Description copied from interface: JobInfo

Returns the generic information Map

Specified by:

getGenericInformation in interface JobInfo

Returns:

generic information Map

setGenericInformation

public void setGenericInformation(Map<String,String> genericInformation)

getVariables

public Map<String,String> getVariables()

Description copied from interface: JobInfo

Returns the variables Map

Specified by:

getVariables in interface JobInfo

Returns:

variables Map

setVariables

public void setVariables(Map<String,String> variables)