|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
public interface JobTemplate
DRMAA application uses the JobTemplate interface, in order to define the attributes associated with a job.
JobTemplates are created via the active Session implementation. A DRMAA application
gets a JobTemplate from the active Session, specifies in the JobTemplate any required job
parameters, and the passes the JobTemplate back to the Session when requesting that a job be
executed. When finished, the DRMAA application should call the
Session.deleteJobTemplate(org.ggf.drmaa.JobTemplate) method to allow the underlying implementation to free any
resources bound to the JobTemplate object.
| Field Summary | |
|---|---|
static int |
ACTIVE_STATE
Pre-defined string to refer to the ACTIVE state on submission. |
static int |
HOLD_STATE
Pre-defined string to refer to the HOLD state on submission. |
static java.lang.String |
HOME_DIRECTORY
Pre-defined string to refer the user's home directory. |
static java.lang.String |
PARAMETRIC_INDEX
Pre-defined string to be used in parametric jobs (bulk jobs). |
static java.lang.String |
WORKING_DIRECTORY
Pre-defined string constant to represent the current working directory when building paths for the input, output, and error path attribute values. |
| Method Summary | |
|---|---|
java.util.List |
getArgs()
This method get the attribute SimpleJobTemplate.args. |
java.util.Set |
getAttributeNames()
This method return the list of supported property names. |
boolean |
getBlockEmail()
This method get the attribute SimpleJobTemplate.blockEmail. |
PartialTimestamp |
getDeadlineTime()
This method get the attribute SimpleJobTemplate.deadlineTime. |
java.util.Set |
getEmail()
This method get the attribute SimpleJobTemplate.email. |
java.lang.String |
getErrorPath()
This method get the attribute SimpleJobTemplate.errorPath. |
long |
getHardRunDurationLimit()
This method get the attribute SimpleJobTemplate.hardRunDurationLimit. |
long |
getHardWallclockTimeLimit()
This method get the attribute SimpleJobTemplate.hardWallclockTimeLimit. |
java.lang.String |
getInputPath()
This method get the attribute SimpleJobTemplate.inputPath. |
java.lang.String |
getJobCategory()
This method get the attribute SimpleJobTemplate.jobCategory. |
java.util.Map |
getJobEnvironment()
This method get the attribute SimpleJobTemplate.jobEnvironment. |
java.lang.String |
getJobName()
This method get the attribute SimpleJobTemplate.jobName. |
int |
getJobSubmissionState()
This method get the attribute SimpleJobTemplate.jobSubmissionState. |
boolean |
getJoinFiles()
This method get the attribute SimpleJobTemplate.joinFiles. |
java.lang.String |
getNativeSpecification()
This method get the attribute SimpleJobTemplate.nativeSpecification. |
java.lang.String |
getOutputPath()
This method get the attribute SimpleJobTemplate.outputPath. |
java.lang.String |
getRemoteCommand()
This method get the attribute SimpleJobTemplate.remoteCommand. |
long |
getSoftRunDurationLimit()
This method get the attribute SimpleJobTemplate.softRunDurationLimit. |
long |
getSoftWallclockTimeLimit()
This method get the attribute SimpleJobTemplate.softWallclockTimeLimit. |
java.util.Date |
getStartTime()
This method get the attribute SimpleJobTemplate.startTime. |
FileTransferMode |
getTransferFiles()
This method get the attribute SimpleJobTemplate.transferFiles. |
java.lang.String |
getWorkingDirectory()
This method get the attribute SimpleJobTemplate.workingDirectory. |
void |
setArgs(java.util.List args)
This method set the attribute SimpleJobTemplate.args. |
void |
setBlockEmail(boolean blockEmail)
This method set the attribute SimpleJobTemplate.blockEmail. |
void |
setDeadlineTime(PartialTimestamp deadline)
This method set the attribute SimpleJobTemplate.deadlineTime. |
void |
setEmail(java.util.Set email)
This method set the attribute SimpleJobTemplate.email. |
void |
setErrorPath(java.lang.String errorPath)
This method set the attribute SimpleJobTemplate.errorPath. |
void |
setHardRunDurationLimit(long limit)
This method set the attribute SimpleJobTemplate.hardRunDurationLimit. |
void |
setHardWallclockTimeLimit(long limit)
This method set the attribute SimpleJobTemplate.hardWallclockTimeLimit. |
void |
setInputPath(java.lang.String inputPath)
This method set the attribute SimpleJobTemplate.inputPath. |
void |
setJobCategory(java.lang.String category)
This method set the attribute SimpleJobTemplate.jobCategory. |
void |
setJobEnvironment(java.util.Map env)
This method set the attribute SimpleJobTemplate.jobEnvironment. |
void |
setJobName(java.lang.String name)
This method set the attribute SimpleJobTemplate.jobName. |
void |
setJobSubmissionState(int state)
This method set the attribute SimpleJobTemplate.jobSubmissionState. |
void |
setJoinFiles(boolean joinFiles)
This method set the attribute SimpleJobTemplate.joinFiles. |
void |
setNativeSpecification(java.lang.String spec)
This method set the attribute SimpleJobTemplate.nativeSpecification. |
void |
setOutputPath(java.lang.String outputPath)
This method set the attribute SimpleJobTemplate.outputPath. |
void |
setRemoteCommand(java.lang.String command)
This method set the attribute SimpleJobTemplate.remoteCommand. |
void |
setSoftRunDurationLimit(long limit)
This method set the attribute SimpleJobTemplate.softRunDurationLimit. |
void |
setSoftWallclockTimeLimit(long limit)
This method set the attribute SimpleJobTemplate.softWallclockTimeLimit. |
void |
setStartTime(java.util.Date startTime)
This method set the attribute SimpleJobTemplate.startTime. |
void |
setTransferFiles(FileTransferMode mode)
This method set the attribute SimpleJobTemplate.transferFiles. |
void |
setWorkingDirectory(java.lang.String wd)
This method set the attribute SimpleJobTemplate.workingDirectory. |
| Field Detail |
|---|
static final int HOLD_STATE
setJobSubmissionState(int) method call.
static final int ACTIVE_STATE
setJobSubmissionState(int) method call.
static final java.lang.String HOME_DIRECTORY
static final java.lang.String WORKING_DIRECTORY
static final java.lang.String PARAMETRIC_INDEX
Session.runBulkJobs(org.ggf.drmaa.JobTemplate, int, int, int) method call. Use DRMAA_GW_JOB_ID for "stand-alone" jobs.
| Method Detail |
|---|
void setRemoteCommand(java.lang.String command)
throws DrmaaException
SimpleJobTemplate.remoteCommand.
command - A command to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setArgs(java.util.List args)
throws DrmaaException
SimpleJobTemplate.args.
args - The attributes to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setJobSubmissionState(int state)
throws DrmaaException
SimpleJobTemplate.jobSubmissionState.
state - The state to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setJobEnvironment(java.util.Map env)
throws DrmaaException
SimpleJobTemplate.jobEnvironment.
env - The jobEnvironment to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setWorkingDirectory(java.lang.String wd)
throws DrmaaException
SimpleJobTemplate.workingDirectory.
wd - The working directoy to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setJobCategory(java.lang.String category)
throws DrmaaException
SimpleJobTemplate.jobCategory.
category - The category to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setNativeSpecification(java.lang.String spec)
throws DrmaaException
SimpleJobTemplate.nativeSpecification.
spec - The native specification to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setEmail(java.util.Set email)
throws DrmaaException
SimpleJobTemplate.email.
email - The email to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setBlockEmail(boolean blockEmail)
throws DrmaaException
SimpleJobTemplate.blockEmail.
blockEmail - The blockEmail to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setStartTime(java.util.Date startTime)
throws DrmaaException
SimpleJobTemplate.startTime.
startTime - The startTime to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setJobName(java.lang.String name)
throws DrmaaException
SimpleJobTemplate.jobName.
name - The Job name to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setInputPath(java.lang.String inputPath)
throws DrmaaException
SimpleJobTemplate.inputPath.
inputPath - The input path to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setOutputPath(java.lang.String outputPath)
throws DrmaaException
SimpleJobTemplate.outputPath.
outputPath - The output path to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setErrorPath(java.lang.String errorPath)
throws DrmaaException
SimpleJobTemplate.errorPath.
errorPath - The error path to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setJoinFiles(boolean joinFiles)
throws DrmaaException
SimpleJobTemplate.joinFiles.
joinFiles - The joinFiles to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setTransferFiles(FileTransferMode mode)
throws DrmaaException
SimpleJobTemplate.transferFiles.
mode - The transfer mode to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setDeadlineTime(PartialTimestamp deadline)
throws DrmaaException
SimpleJobTemplate.deadlineTime.
deadline - The deadline to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setHardWallclockTimeLimit(long limit)
throws DrmaaException
SimpleJobTemplate.hardWallclockTimeLimit.
limit - The hard wall clock time limit to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setSoftWallclockTimeLimit(long limit)
throws DrmaaException
SimpleJobTemplate.softWallclockTimeLimit.
limit - The soft wall clock time timit to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setHardRunDurationLimit(long limit)
throws DrmaaException
SimpleJobTemplate.hardRunDurationLimit.
limit - The hard run duration limit to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
void setSoftRunDurationLimit(long limit)
throws DrmaaException
SimpleJobTemplate.softRunDurationLimit.
limit - The soft run duration limit to set
InvalidAttributeValueException
ConflictingAttributeValuesException
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
java.lang.String getRemoteCommand()
throws DrmaaException
SimpleJobTemplate.remoteCommand.
String with the remoteCommand value
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
java.util.List getArgs()
throws DrmaaException
SimpleJobTemplate.args.
String array with the args value
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
int getJobSubmissionState()
throws DrmaaException
SimpleJobTemplate.jobSubmissionState.
String with the jobSubmissionState value
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
java.util.Map getJobEnvironment()
throws DrmaaException
SimpleJobTemplate.jobEnvironment.
Properties object with the jobEnvironment value
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
java.lang.String getWorkingDirectory()
throws DrmaaException
SimpleJobTemplate.workingDirectory.
String with the workingDirectory value
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
java.lang.String getJobCategory()
throws DrmaaException
SimpleJobTemplate.jobCategory.
String with the jobCategory value
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
java.lang.String getNativeSpecification()
throws DrmaaException
SimpleJobTemplate.nativeSpecification.
String with the nativeSpecificationnativeSpecification value
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
java.util.Set getEmail()
throws DrmaaException
SimpleJobTemplate.email.
String array with the email value
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
boolean getBlockEmail()
throws DrmaaException
SimpleJobTemplate.blockEmail.
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
java.util.Date getStartTime()
throws DrmaaException
SimpleJobTemplate.startTime.
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
java.lang.String getJobName()
throws DrmaaException
SimpleJobTemplate.jobName.
String with the jobName value
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
java.lang.String getInputPath()
throws DrmaaException
SimpleJobTemplate.inputPath.
String with the inputPath value
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
java.lang.String getOutputPath()
throws DrmaaException
SimpleJobTemplate.outputPath.
String with the outputPath value
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
java.lang.String getErrorPath()
throws DrmaaException
SimpleJobTemplate.errorPath.
String with the errorPath value
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
boolean getJoinFiles()
throws DrmaaException
SimpleJobTemplate.joinFiles.
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
FileTransferMode getTransferFiles()
throws DrmaaException
SimpleJobTemplate.transferFiles.
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
PartialTimestamp getDeadlineTime()
throws DrmaaException
SimpleJobTemplate.deadlineTime.
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
long getHardWallclockTimeLimit()
throws DrmaaException
SimpleJobTemplate.hardWallclockTimeLimit.
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
long getSoftWallclockTimeLimit()
throws DrmaaException
SimpleJobTemplate.softWallclockTimeLimit.
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
long getHardRunDurationLimit()
throws DrmaaException
SimpleJobTemplate.hardRunDurationLimit.
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
long getSoftRunDurationLimit()
throws DrmaaException
SimpleJobTemplate.softRunDurationLimit.
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
java.util.Set getAttributeNames()
throws DrmaaException
SimpleJobTemplate.remoteCommand, SimpleJobTemplate.args, SimpleJobTemplate.jobSubmissionStateSimpleJobTemplate.jobEnvironment, SimpleJobTemplate.workingDirectory, SimpleJobTemplate.jobNameSimpleJobTemplate.inputPath, SimpleJobTemplate.outputPath, SimpleJobTemplate.errorPathGridWayJobTemplate) are:
NoActiveSessionException
java.lang.OutOfMemoryError
DrmCommunicationException
AuthorizationException
java.lang.IllegalArgumentException
InternalException
DrmaaException
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||