plgrid
Class GridJobSubmitInfo

java.lang.Object
  plgrid.GridJobSubmitInfo

public class GridJobSubmitInfo
extends java.lang.Object

Contains information needed for job submission

Field Summary

static int	SUBMISSION_ARRAY
static int	SUBMISSION_SINGLE

Constructor Summary

GridJobSubmitInfo()
Constructor

Method Summary

static GridJobSubmitInfo	fromXML(java.lang.String xml)
static GridJobSubmitInfo	fromXMLElement(nu.xom.Element gjsiElement)
java.util.List<GridJobArgument>	getArguments() Return arguments of the command
int	getBeginIndex() Returns the index associated to the first job
java.lang.String	getCommand() Returns the command of the job
int	getEndIndex() Returns the index associated to the last job
java.util.Properties	getEnvironmentProperties() Return job's environment properties
java.lang.String	getErrorPath() Returns Error Path of the job
java.lang.String	getNativeSpecification() Returns job's native specification
int	getNumJobs() Returns number of jobs for this submission
java.lang.String	getOutputPath() Return Output Path of the job
boolean	getPrivilegeEscalation() Returns flag which indicates whether job will be submitted with sudo command or not
int	getSubmissionType() Returns the submission type
java.lang.String	getUsername() Returns job owner's username
void	setArguments(java.util.List<GridJobArgument> arguments) Sets job command arguments
void	setBeginIndex(int index) This function is used only for array/bulk job submission Sets the index associated to the first job
void	setCommand(java.lang.String command) Sets the job command
void	setEndIndex(int index) This function is used only for array/bulk job submission Sets the index associated to the first job
void	setEnvironmentProperties(java.util.Properties environmentProperties) Sets environment properties of the job
void	setErrorPath(java.lang.String errorPath) Sets the error path of the job
void	setNativeSpecification(java.lang.String nativeSpecification) Sets native specification of the job
void	setNumJobs(int numJobs) Sets number of jobs for this submission.
void	setOutputPath(java.lang.String outputPath) Sets the output path of the job
void	setPrivilegeEscalation(boolean privilegeEscalation) Sets flag to true of false which indicates whether job will be submitted with sudo command
void	setSubmissionType(int submissionType) Sets submission type which indicates whether the submission is array or single Allowed values are * SUBMISSION_SINGLE [ default ] * SUBMISSION_ARRAY
void	setUsername(java.lang.String username) Sets the job owner
java.lang.String	toXML()
nu.xom.Element	toXMLElement()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUBMISSION_SINGLE

public static int SUBMISSION_SINGLE

SUBMISSION_ARRAY

public static int SUBMISSION_ARRAY

Constructor Detail

GridJobSubmitInfo

public GridJobSubmitInfo()

Constructor

Method Detail

setOutputPath

public void setOutputPath(java.lang.String outputPath)

Sets the output path of the job

Parameters:

outputPath - Output Path

setErrorPath

public void setErrorPath(java.lang.String errorPath)

Sets the error path of the job

Parameters:

errorPath - Error Path

setUsername

public void setUsername(java.lang.String username)

Sets the job owner

Parameters:

username - Username of submitter

setNativeSpecification

public void setNativeSpecification(java.lang.String nativeSpecification)

Sets native specification of the job

Parameters:

nativeSpecification - Native spceification of the job

setEnvironmentProperties

public void setEnvironmentProperties(java.util.Properties environmentProperties)

Sets environment properties of the job

Parameters:

environmentProperties - Environment properties of the job

setSubmissionType

public void setSubmissionType(int submissionType)

Sets submission type which indicates whether the submission is array or single Allowed values are * SUBMISSION_SINGLE [ default ] * SUBMISSION_ARRAY

Parameters:

submissionType - The submission type

setBeginIndex

public void setBeginIndex(int index)

This function is used only for array/bulk job submission Sets the index associated to the first job

Parameters:

index - index associated to the first job

setEndIndex

public void setEndIndex(int index)

This function is used only for array/bulk job submission Sets the index associated to the first job

Parameters:

index - index associated to the first job

setCommand

public void setCommand(java.lang.String command)

Sets the job command

Parameters:

command - Command of the job

setArguments

public void setArguments(java.util.List<GridJobArgument> arguments)

Sets job command arguments

Parameters:

arguments - Arguments of command

setPrivilegeEscalation

public void setPrivilegeEscalation(boolean privilegeEscalation)

Sets flag to true of false which indicates whether job will be submitted with sudo command

Parameters:

privilegeEscalation - True or false indicating if the job will be submitted with sudo command

setNumJobs

public void setNumJobs(int numJobs)

Sets number of jobs for this submission. When submitting a single job, it is set to 1 by default, but when submitting array jobs this has to be set manually.

Parameters:

numJobs -

getOutputPath

public java.lang.String getOutputPath()

Return Output Path of the job

Returns:

Output Path of the job

getErrorPath

public java.lang.String getErrorPath()

Returns Error Path of the job

Returns:

Output Path of the job

getUsername

public java.lang.String getUsername()

Returns job owner's username

Returns:

job owner's username

getNativeSpecification

public java.lang.String getNativeSpecification()

Returns job's native specification

Returns:

job's native specification

getEnvironmentProperties

public java.util.Properties getEnvironmentProperties()

Return job's environment properties

Returns:

job's environment properties

getSubmissionType

public int getSubmissionType()

Returns the submission type

Returns:

Submission type

getBeginIndex

public int getBeginIndex()

Returns the index associated to the first job

Returns:

the index associated to the first job

getEndIndex

public int getEndIndex()

Returns the index associated to the last job

Returns:

the index associated to the last job

getCommand

public java.lang.String getCommand()

Returns the command of the job

Returns:

command of the job

getArguments

public java.util.List<GridJobArgument> getArguments()

Return arguments of the command

Returns:

arguments of the command

getNumJobs

public int getNumJobs()

Returns number of jobs for this submission

Returns:

number of jobs

getPrivilegeEscalation

public boolean getPrivilegeEscalation()

Returns flag which indicates whether job will be submitted with sudo command or not

Returns:

true or false

toXMLElement

public nu.xom.Element toXMLElement()

toXML

public java.lang.String toXML()

fromXMLElement

public static GridJobSubmitInfo fromXMLElement(nu.xom.Element gjsiElement)

fromXML

public static GridJobSubmitInfo fromXML(java.lang.String xml)