org.ow2.proactive.scheduler.common

Interface SchedulerState<T extends JobState>

All Superinterfaces:

Serializable

All Known Implementing Classes:

SchedulerStateImpl

@PublicAPI
public interface SchedulerState<T extends JobState>
extends Serializable

This interface is a representation of the whole scheduler jobs list state.
It is basically represented by 3 lists of jobs, and their scheduling status.

Since:

ProActive Scheduling 0.9

Method Summary

Modifier and Type	Method and Description
SchedulerState	filterOnUser(String name) Filter the state on the given user name and return a new instance of scheduler state impl After this call, this instance remains the same.
Vector<T>	getFinishedJobs() Get the finished Jobs list
Vector<T>	getPendingJobs() Get the pending Jobs list
Vector<T>	getRunningJobs() Get the running Jobs list
SchedulerStatus	getStatus() Get the status of the scheduler
int	getTotalNbJobs() Returns the total number of jobs (pending, running and finished)
SchedulerUsers	getUsers() Returns the list of connected users.
void	update(NotificationData<?> notification) Updates the scheduler state given the event passed as a parameter
void	update(SchedulerEvent eventType) Updates the scheduler state given the event passed as a parameter
void	update(T jobState) Updates the scheduler state given the event passed as a parameter

Method Detail

getFinishedJobs

Vector<T> getFinishedJobs()

Get the finished Jobs list

Returns:

the finished Jobs list

getPendingJobs

Vector<T> getPendingJobs()

Get the pending Jobs list

Returns:

the pending Jobs list

getRunningJobs

Vector<T> getRunningJobs()

Get the running Jobs list

Returns:

the running Jobs list

getStatus

SchedulerStatus getStatus()

Get the status of the scheduler

Returns:

the status of the scheduler

getUsers

SchedulerUsers getUsers()

Returns the list of connected users.

Returns:

the list of connected users.

getTotalNbJobs

int getTotalNbJobs()

Returns the total number of jobs (pending, running and finished)

Returns:

the total number of jobs accessible from the scheduler

update

void update(SchedulerEvent eventType)

Updates the scheduler state given the event passed as a parameter

update

void update(NotificationData<?> notification)

Updates the scheduler state given the event passed as a parameter

update

void update(T jobState)

Updates the scheduler state given the event passed as a parameter

filterOnUser

SchedulerState filterOnUser(String name)

Filter the state on the given user name and return a new instance of scheduler state impl After this call, this instance remains the same.

Parameters:

name - username to be filtered

Returns:

a new state filtered on job owner name