g-Eclipse
Release 1.0.0

eu.geclipse.batch
Interface IBatchJobInfo

All Known Implementing Classes:
BatchJobInfo

public interface IBatchJobInfo

Interface for holding information about a specific Grid job.


Nested Class Summary
static class IBatchJobInfo.JobState
          This field determines the type of the state of this Queue.
 
Method Summary
 void deleteJob()
          Deletes this job from the batch service.
 java.lang.String getJobId()
           
 java.lang.String getJobName()
           
 java.lang.String getQueueName()
           
 java.lang.String getServiceTypeName()
          Return the type of batch service name that handles this batch job.
 IBatchJobInfo.JobState getStatus()
           
 java.lang.String getTimeUse()
           
 java.lang.String getUserAccount()
           
 void holdJob()
          Puts a hold on the job in the queue of the batch service.
 boolean isDeletable()
          Can this job be deleted.
 boolean isHoldable()
          Can this job be held.
 boolean isMovable()
          Can this job be moved.
 boolean isReleasable()
          Can this job be released.
 boolean isReRunnable()
          Can this job be reRun.
 void moveJob(java.lang.String destQueue, java.lang.String destServer)
          Move this job to another worker node or batch service.
 void releaseJob()
          Release the job with a previous hold in queue of the batch system.
 void reRunJob()
          ReRun the currently executing job in the batch system.
 void setQueueName(java.lang.String queueName)
           
 void setStatus(IBatchJobInfo.JobState status)
           
 void setTimeUse(java.lang.String timeUse)
           
 void setUserAccount(java.lang.String userAccount)
           
 

Method Detail

getQueueName

java.lang.String getQueueName()
Returns:
the queueName

setQueueName

void setQueueName(java.lang.String queueName)
Parameters:
queueName - the queueName to set

getStatus

IBatchJobInfo.JobState getStatus()
Returns:
the status

setStatus

void setStatus(IBatchJobInfo.JobState status)
Parameters:
status - the status to set

getTimeUse

java.lang.String getTimeUse()
Returns:
the timeUse

setTimeUse

void setTimeUse(java.lang.String timeUse)
Parameters:
timeUse - the timeUse to set

getUserAccount

java.lang.String getUserAccount()
Returns:
the userAccount

setUserAccount

void setUserAccount(java.lang.String userAccount)
Parameters:
userAccount - the userAccount to set

getJobId

java.lang.String getJobId()
Returns:
the jobId

getJobName

java.lang.String getJobName()
Returns:
the jobName

isDeletable

boolean isDeletable()
Can this job be deleted.

Returns:
Returns true<\code> if this job can be deleted, false otherwise.

isMovable

boolean isMovable()
Can this job be moved.

Returns:
Returns true if this job can be moved, false otherwise.

isHoldable

boolean isHoldable()
Can this job be held.

Returns:
Returns true<\code> if this job can be held, false otherwise.

isReleasable

boolean isReleasable()
Can this job be released.

Returns:
Returns true<\code> if this job can be released, false otherwise.

isReRunnable

boolean isReRunnable()
Can this job be reRun.

Returns:
Returns true<\code> if this job can be reRun, false otherwise.

deleteJob

void deleteJob()
               throws ProblemException
Deletes this job from the batch service.

Throws:
ProblemException - If command is not executed successfully

moveJob

void moveJob(java.lang.String destQueue,
             java.lang.String destServer)
             throws ProblemException
Move this job to another worker node or batch service.

Parameters:
destQueue - The destination queue, null if no destination queue.
destServer - The destination server, null if no destination server.
Throws:
ProblemException - If command is not executed successfully

holdJob

void holdJob()
             throws ProblemException
Puts a hold on the job in the queue of the batch service.

Throws:
ProblemException - If command is not executed successfully

releaseJob

void releaseJob()
                throws ProblemException
Release the job with a previous hold in queue of the batch system.

Throws:
ProblemException - If command is not executed successfully

reRunJob

void reRunJob()
              throws ProblemException
ReRun the currently executing job in the batch system.

Throws:
ProblemException - If command is not executed successfully

getServiceTypeName

java.lang.String getServiceTypeName()
Return the type of batch service name that handles this batch job.

Returns:
Returns the batch service name, null if unknown.

g-Eclipse
Release 1.0.0