JobInfo

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.ggf.drmaa
Interface JobInfo

All Known Implementing Classes:: GridWayJobInfo

public interface JobInfo

The information regarding a job's execution is encapsulated in the JobInfo interface. Via the JobInfo interface a DRMAA application can discover information about the resource usage and exit status of a job.

Method Summary
`int`	`getExitStatus()` This method returns the exit code extracted from stat.
`java.lang.String`	`getJobId()` This method gets the completed job's id.
`java.util.Map`	`getResourceUsage()` This method gets the completed job's resource usage data.
`java.lang.String`	`getTerminatingSignal()` This methods returns the signal name that causes the termination of the job.
`boolean`	`hasCoreDump()` This methods always returns "0"
`boolean`	`hasExited()` This method returns into exited a non-zero value if stat was returned for a job that terminated normally.
`boolean`	`hasSignaled()` This method evaluates into signaled a non-zero value if stat was returned for a job that terminated due to the receipt of a signal.
`boolean`	`wasAborted()` This methods always returns "0"

Method Detail

getJobId

java.lang.String getJobId()
                          throws DrmaaException

This method gets the completed job's id.

Returns:: A String with the jobId value
Throws:: java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; InternalException; DrmaaException

getResourceUsage

java.util.Map getResourceUsage()
                               throws DrmaaException

This method gets the completed job's resource usage data.

Returns:: A Map object with the jobId value
Throws:: java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; InternalException; DrmaaException

hasExited

boolean hasExited()
                  throws DrmaaException

This method returns into exited a non-zero value if stat was returned for a job that terminated normally. The job exit status can be retrieved using getExitStatus().

Returns:: The return is true if the job terminated abnormally, drmaa_wifsignaled() can be used to gather more information. NOTE: The status code is interpreted in a bash fashion
Throws:: java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; InternalException; DrmaaException

getExitStatus

int getExitStatus()
                  throws DrmaaException

This method returns the exit code extracted from stat.

Returns:: The exit code extracted from stat
Throws:: java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; InternalException; DrmaaException

hasSignaled

boolean hasSignaled()
                    throws DrmaaException

This method evaluates into signaled a non-zero value if stat was returned for a job that terminated due to the receipt of a signal. NOTE: The status code is interpreted in a bash fashion

Returns:: The return is true if the job terminated on a signal
Throws:: java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; InternalException; DrmaaException

getTerminatingSignal

java.lang.String getTerminatingSignal()
                                      throws DrmaaException

This methods returns the signal name that causes the termination of the job. Only signals by POSIX are returned. For non-POSIX signals, the returned name is "UNKNOWN".

Returns:: The signal name stored in a String that causes the termination of the job
Throws:: java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; InternalException; DrmaaException

hasCoreDump

boolean hasCoreDump()
                    throws DrmaaException

This methods always returns "0"

Returns:: Always returns "0"
Throws:: java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; InternalException; DrmaaException

wasAborted

boolean wasAborted()
                   throws DrmaaException