SimpleJobTemplate

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
Class SimpleJobTemplate

java.lang.Object
  org.ggf.drmaa.SimpleJobTemplate

All Implemented Interfaces:: JobTemplate

Direct Known Subclasses:: GridWayJobTemplate

public class SimpleJobTemplate
extends java.lang.Object
implements JobTemplate
extends java.lang.Object
implements JobTemplate

Field Summary
`protected java.util.List`	`args` String array attribute to refer to the remoteCommand arguments.
`protected java.util.Set`	`attributeNames`
`protected boolean`	`blockEmail` Not relevant for the current GridWay implementation, will be ignored
`protected PartialTimestamp`	`deadlineTime` Pre-defined string to represent a deadline for job execution.
`protected java.util.Set`	`email` Not relevant for the current GridWay implementation, will be ignored
`protected java.lang.String`	`errorPath` String attribute to refer to standard error file for the `remoteCommand`.
`protected long`	`hardRunDurationLimit` Not relevant for the current GridWay implementation, will be ignored
`protected long`	`hardWallclockTimeLimit` Not relevant for the current GridWay implementation, will be ignored
`protected java.lang.String`	`inputPath` String attribute to refer to standard input file for the `remoteCommand`.
`protected java.lang.String`	`jobCategory` Not relevant for the current GridWay implementation, will be ignored
`protected java.util.Map`	`jobEnvironment` String attribute to refer to the `remoteCommand` environment variables.
`protected java.lang.String`	`jobName` String attribute to refer to the DRMAA job-name.
`protected int`	`jobSubmissionState` Integer attribute to refer to the job state at submission, the job will enter either the QUEUED_ACTIVE state or HOLD state when submitted.
`protected boolean`	`joinFiles` Not relevant for the current GridWay implementation, will be ignored
`protected java.lang.String`	`nativeSpecification` Not relevant for the current GridWay implementation, will be ignored
`protected java.lang.String`	`outputPath` String attribute to refer to standard output file for the `remoteCommand`.
`protected java.lang.String`	`remoteCommand` Attribute to refer to the command to be executed on the remote host.
`protected long`	`softRunDurationLimit` Not relevant for the current GridWay implementation, will be ignored
`protected long`	`softWallclockTimeLimit` Not relevant for the current GridWay implementation, will be ignored
`protected java.util.Date`	`startTime` Not relevant for the current GridWay implementation, will be ignored
`protected FileTransferMode`	`transferFiles` Not relevant for the current GridWay implementation, will be ignored
`protected java.lang.String`	`workingDirectory` String attribute to refer to the JOB working directory.

Fields inherited from interface org.ggf.drmaa.JobTemplate
`ACTIVE_STATE, HOLD_STATE, HOME_DIRECTORY, PARAMETRIC_INDEX, WORKING_DIRECTORY`

Constructor Summary
`SimpleJobTemplate()` The SimpleJobTemplate() constructor creates a new instance of a SimpleJobTemplate.

Method Summary
`java.util.List`	`getArgs()` This method get the attribute `args`.
`java.util.Set`	`getAttributeNames()` This method return the list of supported property names.
`boolean`	`getBlockEmail()` This method get the attribute `blockEmail`.
`PartialTimestamp`	`getDeadlineTime()` This method get the attribute `deadlineTime`.
`java.util.Set`	`getEmail()` This method get the attribute `email`.
`java.lang.String`	`getErrorPath()` This method get the attribute `errorPath`.
`long`	`getHardRunDurationLimit()` This method get the attribute `hardRunDurationLimit`.
`long`	`getHardWallclockTimeLimit()` This method get the attribute `hardWallclockTimeLimit`.
`java.lang.String`	`getInputPath()` This method get the attribute `inputPath`.
`java.lang.String`	`getJobCategory()` This method get the attribute `jobCategory`.
`java.util.Map`	`getJobEnvironment()` This method get the attribute `jobEnvironment`.
`java.lang.String`	`getJobName()` This method get the attribute `jobName`.
`int`	`getJobSubmissionState()` This method get the attribute `jobSubmissionState`.
`boolean`	`getJoinFiles()` This method get the attribute `joinFiles`.
`java.lang.String`	`getNativeSpecification()` This method get the attribute `nativeSpecification`.
`protected java.util.Set`	`getOptionalAttributeNames()` This method return the list of the optional Gridway property names (implemented in `GridWayJobTemplate`): inputFiles, outputFiles, restartFiles rescheduleOnFailure, numberOfRetries, rank requirements
`java.lang.String`	`getOutputPath()` This method get the attribute `outputPath`.
`java.lang.String`	`getRemoteCommand()` This method get the attribute `remoteCommand`.
`long`	`getSoftRunDurationLimit()` This method get the attribute `softRunDurationLimit`.
`long`	`getSoftWallclockTimeLimit()` This method get the attribute `softWallclockTimeLimit`.
`java.util.Date`	`getStartTime()` This method get the attribute `startTime`.
`FileTransferMode`	`getTransferFiles()` This method get the attribute `transferFiles`.
`java.lang.String`	`getWorkingDirectory()` This method get the attribute `workingDirectory`.
`void`	`modified()` This method marks the job template to indicate that its properties have been modified.
`void`	`setArgs(java.util.List args)` This method set the attribute `args`.
`void`	`setBlockEmail(boolean blockEmail)` This method set the attribute `blockEmail`.
`void`	`setDeadlineTime(PartialTimestamp deadline)` This method set the attribute `deadlineTime`.
`void`	`setEmail(java.util.Set email)` This method set the attribute `email`.
`void`	`setErrorPath(java.lang.String errorPath)` This method set the attribute `errorPath`.
`void`	`setHardRunDurationLimit(long limit)` This method set the attribute `hardRunDurationLimit`.
`void`	`setHardWallclockTimeLimit(long limit)` This method set the attribute `hardWallclockTimeLimit`.
`void`	`setInputPath(java.lang.String inputPath)` This method set the attribute `inputPath`.
`void`	`setJobCategory(java.lang.String category)` This method set the attribute `jobCategory`.
`void`	`setJobEnvironment(java.util.Map env)` This method set the attribute `jobEnvironment`.
`void`	`setJobName(java.lang.String name)` This method set the attribute `jobName`.
`void`	`setJobSubmissionState(int state)` This method set the attribute `jobSubmissionState`.
`void`	`setJoinFiles(boolean joinFiles)` This method set the attribute `joinFiles`.
`void`	`setNativeSpecification(java.lang.String spec)` This method set the attribute `nativeSpecification`.
`void`	`setOutputPath(java.lang.String outputPath)` This method set the attribute `outputPath`.
`void`	`setRemoteCommand(java.lang.String command)` This method set the attribute `remoteCommand`.
`void`	`setSoftRunDurationLimit(long limit)` This method set the attribute `softRunDurationLimit`.
`void`	`setSoftWallclockTimeLimit(long limit)` This method set the attribute `softWallclockTimeLimit`.
`void`	`setStartTime(java.util.Date startTime)` This method set the attribute `startTime`.
`void`	`setTransferFiles(FileTransferMode mode)` This method set the attribute `transferFiles`.
`void`	`setWorkingDirectory(java.lang.String wd)` This method set the attribute `workingDirectory`.
`java.lang.String`	`toString()` This method returns a string representation of the job template instance

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

remoteCommand

protected java.lang.String remoteCommand

Attribute to refer to the command to be executed on the remote host. The remoteCommand attribute MUST BE RELATIVE to the working directory (workingDirectory). Architecture-dependent remoteCommand can be generated with GW_ARCH.

args

protected java.util.List args

String array attribute to refer to the remoteCommand arguments.

jobSubmissionState

protected int jobSubmissionState

Integer attribute to refer to the job state at submission, the job will enter either the QUEUED_ACTIVE state or HOLD state when submitted. The preprocessor directives ACTIVE_STATE and HOLD_STATE SHOULD be used to assign the value of this attribute. The default value is ACTIVE_STATE.

jobEnvironment

protected java.util.Map jobEnvironment

String attribute to refer to the remoteCommand environment variables.

workingDirectory

protected java.lang.String workingDirectory

String attribute to refer to the JOB working directory. The current GridWay DRMAA implementation will generate a job template file with name jobName in the job working directory (workingDirectory). It is a MANDATORY attribute value and MUST BE DEFINED. Plase note that ALL FILES ARE NAMED RELATIVE TO THE WORKING DIRECTORY. Also this is a LOCAL PATH NAME, this directory will be recreated in the remote host, and it will be the working directory of the job on the execution host.

jobCategory

protected java.lang.String jobCategory

Not relevant for the current GridWay implementation, will be ignored

nativeSpecification

protected java.lang.String nativeSpecification

Not relevant for the current GridWay implementation, will be ignored

email

protected java.util.Set email

Not relevant for the current GridWay implementation, will be ignored

blockEmail

protected boolean blockEmail

Not relevant for the current GridWay implementation, will be ignored

startTime

protected java.util.Date startTime

Not relevant for the current GridWay implementation, will be ignored

jobName

protected java.lang.String jobName

String attribute to refer to the DRMAA job-name. The current GridWay DRMAA implementation will generate a job template file with name jobName in the job working directory (workingDirectory). jobName is a MANDATORY attribute value and MUST BE DEFINED. The default value is "job_template".

inputPath

protected java.lang.String inputPath

String attribute to refer to standard input file for the remoteCommand. The standard input file IS RELATIVE TO THE WORKING DIRECTORY.

outputPath

protected java.lang.String outputPath

String attribute to refer to standard output file for the remoteCommand. The standard ouput file IS RELATIVE TO THE WORKING DIRECTORY.

errorPath

protected java.lang.String errorPath

String attribute to refer to standard error file for the remoteCommand. The standard error file IS RELATIVE TO THE WORKING DIRECTORY.

joinFiles

protected boolean joinFiles

Not relevant for the current GridWay implementation, will be ignored

transferFiles

protected FileTransferMode transferFiles

Not relevant for the current GridWay implementation, will be ignored

deadlineTime

protected PartialTimestamp deadlineTime

Pre-defined string to represent a deadline for job execution. GridWay WILL NOT terminate a job after the deadline, neither guarantees that the job is executed before the deadline. A deadline is specified absolute to job submission time.

hardWallclockTimeLimit

protected long hardWallclockTimeLimit

Not relevant for the current GridWay implementation, will be ignored

softWallclockTimeLimit

protected long softWallclockTimeLimit

Not relevant for the current GridWay implementation, will be ignored

hardRunDurationLimit

protected long hardRunDurationLimit

Not relevant for the current GridWay implementation, will be ignored

softRunDurationLimit

protected long softRunDurationLimit

Not relevant for the current GridWay implementation, will be ignored

attributeNames

protected java.util.Set attributeNames

Constructor Detail

SimpleJobTemplate

public SimpleJobTemplate()

The SimpleJobTemplate() constructor creates a new instance of a SimpleJobTemplate. In most cases, a DRMAA implementation will require that JobTemplates be created through the Session.createJobTemplate() method, however. In those cases, passing a JobTemplate created through the JobTemplate() constructor to the Session.deleteJobTemplate(org.ggf.drmaa.JobTemplate), Session.runJob(org.ggf.drmaa.JobTemplate), or Session.runBulkJobs(org.ggf.drmaa.JobTemplate, int, int, int) methods will result in an InvalidJobTemplateException being thrown.

Method Detail

setRemoteCommand

public void setRemoteCommand(java.lang.String command)
                      throws DrmaaException

This method set the attribute remoteCommand.

Specified by:: setRemoteCommand in interface JobTemplate

Parameters:: command - A command to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setArgs

public void setArgs(java.util.List args)
             throws DrmaaException

This method set the attribute args.

Specified by:: setArgs in interface JobTemplate

Parameters:: args - The attributes to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setJobSubmissionState

public void setJobSubmissionState(int state)
                           throws DrmaaException

This method set the attribute jobSubmissionState.

Specified by:: setJobSubmissionState in interface JobTemplate

Parameters:: state - The state to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setJobEnvironment

public void setJobEnvironment(java.util.Map env)
                       throws DrmaaException

This method set the attribute jobEnvironment.

Specified by:: setJobEnvironment in interface JobTemplate

Parameters:: env - The jobEnvironment to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setWorkingDirectory

public void setWorkingDirectory(java.lang.String wd)
                         throws DrmaaException

This method set the attribute workingDirectory.

Specified by:: setWorkingDirectory in interface JobTemplate

Parameters:: wd - The working directoy to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setJobCategory

public void setJobCategory(java.lang.String category)
                    throws DrmaaException

This method set the attribute jobCategory.

Specified by:: setJobCategory in interface JobTemplate

Parameters:: category - The category to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setNativeSpecification

public void setNativeSpecification(java.lang.String spec)
                            throws DrmaaException

This method set the attribute nativeSpecification.

Specified by:: setNativeSpecification in interface JobTemplate

Parameters:: spec - The native specification to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setEmail

public void setEmail(java.util.Set email)
              throws DrmaaException

This method set the attribute email.

Specified by:: setEmail in interface JobTemplate

Parameters:: email - The email to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setBlockEmail

public void setBlockEmail(boolean blockEmail)
                   throws DrmaaException

This method set the attribute blockEmail.

Specified by:: setBlockEmail in interface JobTemplate

Parameters:: blockEmail - The blockEmail to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setStartTime

public void setStartTime(java.util.Date startTime)
                  throws DrmaaException

This method set the attribute startTime.

Specified by:: setStartTime in interface JobTemplate

Parameters:: startTime - The startTime to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setJobName

public void setJobName(java.lang.String name)
                throws DrmaaException

This method set the attribute jobName.

Specified by:: setJobName in interface JobTemplate

Parameters:: name - The Job name to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setInputPath

public void setInputPath(java.lang.String inputPath)
                  throws DrmaaException

This method set the attribute inputPath.

Specified by:: setInputPath in interface JobTemplate

Parameters:: inputPath - The input path to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setOutputPath

public void setOutputPath(java.lang.String outputPath)
                   throws DrmaaException

This method set the attribute outputPath.

Specified by:: setOutputPath in interface JobTemplate

Parameters:: outputPath - The output path to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setErrorPath

public void setErrorPath(java.lang.String errorPath)
                  throws DrmaaException

This method set the attribute errorPath.

Specified by:: setErrorPath in interface JobTemplate

Parameters:: errorPath - The error path to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setJoinFiles

public void setJoinFiles(boolean joinFiles)
                  throws DrmaaException

This method set the attribute joinFiles.

Specified by:: setJoinFiles in interface JobTemplate

Parameters:: joinFiles - The joinFiles to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setTransferFiles

public void setTransferFiles(FileTransferMode mode)
                      throws DrmaaException

This method set the attribute transferFiles.

Specified by:: setTransferFiles in interface JobTemplate

Parameters:: mode - The transfer mode to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setDeadlineTime

public void setDeadlineTime(PartialTimestamp deadline)
                     throws DrmaaException

This method set the attribute deadlineTime.

Specified by:: setDeadlineTime in interface JobTemplate

Parameters:: deadline - The deadline to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setHardWallclockTimeLimit

public void setHardWallclockTimeLimit(long limit)
                               throws DrmaaException

This method set the attribute hardWallclockTimeLimit.

Specified by:: setHardWallclockTimeLimit in interface JobTemplate

Parameters:: limit - The hard wall clock time limit to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setSoftWallclockTimeLimit

public void setSoftWallclockTimeLimit(long limit)
                               throws DrmaaException

This method set the attribute softWallclockTimeLimit.

Specified by:: setSoftWallclockTimeLimit in interface JobTemplate

Parameters:: limit - The soft wall clock time timit to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setHardRunDurationLimit

public void setHardRunDurationLimit(long limit)
                             throws DrmaaException

This method set the attribute hardRunDurationLimit.

Specified by:: setHardRunDurationLimit in interface JobTemplate

Parameters:: limit - The hard run duration limit to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

setSoftRunDurationLimit

public void setSoftRunDurationLimit(long limit)
                             throws DrmaaException

This method set the attribute softRunDurationLimit.

Specified by:: setSoftRunDurationLimit in interface JobTemplate

Parameters:: limit - The soft run duration limit to set
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException; DrmaaException

getRemoteCommand

public java.lang.String getRemoteCommand()

This method get the attribute remoteCommand.

Specified by:: getRemoteCommand in interface JobTemplate

Returns:: A String with the remoteCommand value

getArgs

public java.util.List getArgs()

This method get the attribute args.

Specified by:: getArgs in interface JobTemplate

Returns:: A List object with the args value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getJobSubmissionState

public int getJobSubmissionState()

This method get the attribute jobSubmissionState.

Specified by:: getJobSubmissionState in interface JobTemplate

Returns:: A int with the jobSubmissionState value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getJobEnvironment

public java.util.Map getJobEnvironment()

This method get the attribute jobEnvironment.

Specified by:: getJobEnvironment in interface JobTemplate

Returns:: A Map object with the jobEnvironment value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getWorkingDirectory

public java.lang.String getWorkingDirectory()

This method get the attribute workingDirectory.

Specified by:: getWorkingDirectory in interface JobTemplate

Returns:: A String with the workingDirectory value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getJobCategory

public java.lang.String getJobCategory()

This method get the attribute jobCategory.

Specified by:: getJobCategory in interface JobTemplate

Returns:: A String with the jobCategory value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getNativeSpecification

public java.lang.String getNativeSpecification()

This method get the attribute nativeSpecification.

Specified by:: getNativeSpecification in interface JobTemplate

Returns:: A String with the nativeSpecification value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getEmail

public java.util.Set getEmail()

This method get the attribute email.

Specified by:: getEmail in interface JobTemplate

Returns:: A Set object with the email value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getBlockEmail

public boolean getBlockEmail()

This method get the attribute blockEmail.

Specified by:: getBlockEmail in interface JobTemplate

Returns:: A boolean with the blockEmail value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getStartTime

public java.util.Date getStartTime()

This method get the attribute startTime.

Specified by:: getStartTime in interface JobTemplate

Returns:: A Date object with the startTime value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException

getJobName

public java.lang.String getJobName()

This method get the attribute jobName.

Specified by:: getJobName in interface JobTemplate

Returns:: A String with the jobName value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getInputPath

public java.lang.String getInputPath()

This method get the attribute inputPath.

Specified by:: getInputPath in interface JobTemplate

Returns:: A String with the inputPath value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getOutputPath

public java.lang.String getOutputPath()

This method get the attribute outputPath.

Specified by:: getOutputPath in interface JobTemplate

Returns:: A String with the outputPath value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getErrorPath

public java.lang.String getErrorPath()

This method get the attribute errorPath.

Specified by:: getErrorPath in interface JobTemplate

Returns:: A String with the errorPath value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getJoinFiles

public boolean getJoinFiles()

This method get the attribute joinFiles.

Specified by:: getJoinFiles in interface JobTemplate

Returns:: A boolean with the joinFiles value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getTransferFiles

public FileTransferMode getTransferFiles()

This method get the attribute transferFiles.

Specified by:: getTransferFiles in interface JobTemplate

Returns:: A FileTransferMode object with the transferFiles value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getDeadlineTime

public PartialTimestamp getDeadlineTime()

This method get the attribute deadlineTime.

Specified by:: getDeadlineTime in interface JobTemplate

Returns:: A PartialTimestamp object with the deadlineTime value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getHardWallclockTimeLimit

public long getHardWallclockTimeLimit()

This method get the attribute hardWallclockTimeLimit.

Specified by:: getHardWallclockTimeLimit in interface JobTemplate

Returns:: A long with the hardWallclockTimeLimit value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getSoftWallclockTimeLimit

public long getSoftWallclockTimeLimit()

This method get the attribute softWallclockTimeLimit.

Specified by:: getSoftWallclockTimeLimit in interface JobTemplate

Returns:: A long with the softWallclockTimeLimit value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getHardRunDurationLimit

public long getHardRunDurationLimit()

This method get the attribute hardRunDurationLimit.

Specified by:: getHardRunDurationLimit in interface JobTemplate

Returns:: A long with the hardRunDurationLimit value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getSoftRunDurationLimit

public long getSoftRunDurationLimit()

This method get the attribute softRunDurationLimit.

Specified by:: getSoftRunDurationLimit in interface JobTemplate

Returns:: A long with the softRunDurationLimit value
Throws:: InvalidAttributeValueException; ConflictingAttributeValuesException; NoActiveSessionException; java.lang.OutOfMemoryError; DrmCommunicationException; AuthorizationException; java.lang.IllegalArgumentException; InternalException

getAttributeNames

public java.util.Set getAttributeNames()

This method return the list of supported property names. The required Gridway property names are:

The optional Gridway property names (implemented in GridWayJobTemplate) are:

inputFiles, outputFiles, restartFiles
rescheduleOnFailure, numberOfRetries, rank
requirements

Specified by:: getAttributeNames in interface JobTemplate

toString

public java.lang.String toString()

This method returns a string representation of the job template instance

Overrides:: toString in class java.lang.Object

modified

public void modified()

This method marks the job template to indicate that its properties have been modified. Not relevant for the current GridWay implementation, will be ignored.

getOptionalAttributeNames

protected java.util.Set getOptionalAttributeNames()

This method return the list of the optional Gridway property names (implemented in GridWayJobTemplate):

inputFiles, outputFiles, restartFiles
rescheduleOnFailure, numberOfRetries, rank
requirements

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 Class SimpleJobTemplate

remoteCommand

args

jobSubmissionState

jobEnvironment

workingDirectory

jobCategory

nativeSpecification

email

blockEmail

startTime

jobName

inputPath

outputPath

errorPath

joinFiles

transferFiles

deadlineTime

hardWallclockTimeLimit

softWallclockTimeLimit

hardRunDurationLimit

softRunDurationLimit

attributeNames

SimpleJobTemplate

setRemoteCommand

setArgs

setJobSubmissionState

setJobEnvironment

setWorkingDirectory

setJobCategory

setNativeSpecification

setEmail

setBlockEmail

setStartTime

setJobName

setInputPath

setOutputPath

setErrorPath

setJoinFiles

setTransferFiles

setDeadlineTime

setHardWallclockTimeLimit

setSoftWallclockTimeLimit

setHardRunDurationLimit

setSoftRunDurationLimit

getRemoteCommand

getArgs

getJobSubmissionState

getJobEnvironment

getWorkingDirectory

getJobCategory

getNativeSpecification

getEmail

getBlockEmail

getStartTime

getJobName

getInputPath

getOutputPath

getErrorPath

getJoinFiles

getTransferFiles

getDeadlineTime

getHardWallclockTimeLimit

getSoftWallclockTimeLimit

getHardRunDurationLimit

getSoftRunDurationLimit

getAttributeNames

toString

modified

getOptionalAttributeNames

org.ggf.drmaa
Class SimpleJobTemplate