uk.ac.ncl.cs.instantsoap.job
Interface Job

All Known Implementing Classes:

FileJob

public interface Job

Interesting state about a pending, executing or completed job.

Author:

Louis, Matthew Pocock

Method Summary

void	delete() Delete any resources associated with with this job.
Throwable	getFailureReason() Get the reason for failure.
InvocationState	getInvocationState() Get the invocation state.
Date	getJobExecutionEndTime() Get the time the job ended to be executed.
Date	getJobExecutionStartTime() Get the time the job started to be executed.
Date	getJobSubmissionTime() Get the job submition time.
Date	getLastRetrieval() Get the last time the results where retrieved.
Map<String,String>	getResult() Get the results data.
boolean	isFailure() True if the job has resulted in failure, false otherwise.
void	setFailure(boolean failure) Set the job failure status.
void	setFailureReason(Throwable throwable) Set the reason for failure.
void	setInvocationState(InvocationState state) Set the invocation state.
void	setJobExecutionEndTime(Date time) Set the job execution end time.
void	setJobExecutionStartTime(Date time) Set the job execution start time.
void	setJobSubmissionTime(Date time) Set the job submission time.
void	setLastRetrieval(Date time) Set the last time the results where retrieved.
void	setResut(Map<String,String> data) Set the result data.

Method Detail

isFailure

boolean isFailure()

True if the job has resulted in failure, false otherwise.

Returns:

the job failure status

setFailure

void setFailure(boolean failure)

Set the job failure status.

Parameters:

failure - the new failure status

setResut

void setResut(Map<String,String> data)
              throws JobExecutionException

Set the result data.

Parameters:

data - the reults data Map

Throws:

JobExecutionException

getResult

Map<String,String> getResult()
                             throws JobExecutionException

Get the results data.

Returns:

the results data

Throws:

JobExecutionException

setFailureReason

void setFailureReason(Throwable throwable)
                      throws JobExecutionException

Set the reason for failure.

Parameters:

throwable - the Throwable containing the failure reason

Throws:

JobExecutionException

getFailureReason

Throwable getFailureReason()
                           throws JobExecutionException

Get the reason for failure.

Returns:

the Throwable containing the failure reason

Throws:

JobExecutionException

getInvocationState

InvocationState getInvocationState()

Get the invocation state.

Returns:

the InvocationState

setInvocationState

void setInvocationState(InvocationState state)

Set the invocation state.

Parameters:

state - the new InvocationState

getJobSubmissionTime

Date getJobSubmissionTime()

Get the job submition time.

Returns:

the Date capturing when the job was submitted

setJobSubmissionTime

void setJobSubmissionTime(Date time)

Set the job submission time.

Parameters:

time - the new Date for the job submission

getJobExecutionStartTime

Date getJobExecutionStartTime()

Get the time the job started to be executed.

Returns:

the Date capturing when the job started to be executed

setJobExecutionStartTime

void setJobExecutionStartTime(Date time)

Set the job execution start time.

Parameters:

time - the new Date for the job execution

getJobExecutionEndTime

Date getJobExecutionEndTime()

Get the time the job ended to be executed.

Returns:

the Date capturing when the job ended be executed

setJobExecutionEndTime

void setJobExecutionEndTime(Date time)

Set the job execution end time.

Parameters:

time - the new Date for the job execution

getLastRetrieval

Date getLastRetrieval()

Get the last time the results where retrieved.

Returns:

the Date when the results where retrieved

setLastRetrieval

void setLastRetrieval(Date time)

Set the last time the results where retrieved.

Parameters:

time - the Date when the results where retrieved

delete

void delete()

Delete any resources associated with with this job.