org.jppf.node.protocol

Interface JobSLA

All Superinterfaces:

JobCommonSLA, Serializable

All Known Implementing Classes:

JPPFJobSLA

public interface JobSLA
extends JobCommonSLA

This interface represents the Service Level Agreement between a JPPF job and a server. It determines the state, conditions and order in which a job will be executed.

Method Summary

Methods

Modifier and Type	Method and Description
int	getMaxNodes() Get the maximum number of nodes this job can run on.
int	getPriority() Get the priority of this job.
String	getResultsStrategy() Get the strategy used to return the results back to the client.
boolean	isBroadcastJob() Determine whether the job is a broadcast job.
boolean	isCancelUponClientDisconnect() Determine whether the job should be canceled by the driver if the client gets disconnected.
boolean	isSuspended() Determine whether this job is initially suspended.
void	setBroadcastJob(boolean broadcastJob) Specify whether the job is a broadcast job.
void	setCancelUponClientDisconnect(boolean cancelUponClientDisconnect) Specify whether the job should be canceled by the driver if the client gets disconnected.
void	setMaxNodes(int maxNodes) Set the maximum number of nodes this job can run on.
void	setPriority(int priority) Set the priority of this job.
void	setResultsStrategy(String name) Set the strategy used to return the results back to the client.
void	setSuspended(boolean suspended) Specify whether this job is initially suspended.

Methods inherited from interface org.jppf.node.protocol.JobCommonSLA

getExecutionPolicy, getJobExpirationSchedule, getJobSchedule, setExecutionPolicy, setJobExpirationSchedule, setJobSchedule

Method Detail

getPriority

int getPriority()

Get the priority of this job.

Returns:

the priority as an int.

setPriority

void setPriority(int priority)

Set the priority of this job.

Parameters:

priority - the priority as an int.

getMaxNodes

int getMaxNodes()

Get the maximum number of nodes this job can run on.

Returns:

the number of nodes as an int value.

setMaxNodes

void setMaxNodes(int maxNodes)

Set the maximum number of nodes this job can run on.

Parameters:

maxNodes - the number of nodes as an int value. A value <= 0 means no limit on the number of nodes.

isSuspended

boolean isSuspended()

Determine whether this job is initially suspended.

Returns:

true if the job is suspended, false otherwise.

setSuspended

void setSuspended(boolean suspended)

Specify whether this job is initially suspended.

Parameters:

suspended - true if the job is suspended, false otherwise.

isBroadcastJob

boolean isBroadcastJob()

Determine whether the job is a broadcast job.

Returns:

true for a broadcast job, false otherwise.

setBroadcastJob

void setBroadcastJob(boolean broadcastJob)

Specify whether the job is a broadcast job.

Parameters:

broadcastJob - true for a broadcast job, false otherwise.

isCancelUponClientDisconnect

boolean isCancelUponClientDisconnect()

Determine whether the job should be canceled by the driver if the client gets disconnected.

Returns:

true if the job should be canceled (this is the default), false otherwise.

setCancelUponClientDisconnect

void setCancelUponClientDisconnect(boolean cancelUponClientDisconnect)

Specify whether the job should be canceled by the driver if the client gets disconnected.

Parameters:

cancelUponClientDisconnect - true if the job should be canceled, false otherwise.

getResultsStrategy

String getResultsStrategy()

Get the strategy used to return the results back to the client.

Returns:

the name of the strategy to use.

setResultsStrategy

void setResultsStrategy(String name)

Set the strategy used to return the results back to the client.

Parameters:

name - the name of the strategy to use.