com.altair.hwm.interfaces.loadsubmission
Interface IHWMJob

All Known Implementing Classes:

HWMEComputeJob, HWMOptistructJob

public interface IHWMJob

Title: IHWMJob

Description: The interface for a job to be submitted to any job submission system. It abstracts the parameters that comprise of the job and provides API's to access and modify them. Company: Altair Engineering, Inc. Author:Shashi

Method Summary

void	AddFile(java.io.File solverDeckFile) This method adds a solver deck file to a job.
void	AddJobParams(java.util.Vector vectJobParams) Adds a vector of job related parameters for the job.
void	AddPostProcessingParams(java.util.Vector vectPostParams) Adds a vector of post processor parameters for the job.
void	AddSolverParams(java.util.Vector vectSolverParams) Adds a vector of solver parameters for the job.
java.lang.String	GetJobID() This method gets the ID for this job represented as a string.
IHWMJobStatus	GetJobStatus()
java.lang.String	GetName() Gets the name of the job.
void	RemoveFile(java.io.File solverDeckFile) This method removes a solver deck file to a job.
void	RemoveJobParams(java.util.Vector vectJobParams) Removes a vector of job related parameters for the job.
void	RemovePostProcessingParams(java.util.Vector vectPostParams) Removes a vector of post processor parameters for the job.
void	RemoveSolverParams(java.util.Vector vectSolverParams) Removes a vector of solver parameters from the job.
void	SetAsMaster(java.io.File solverDeckFile) Sets the specified deck file as the master file.
void	SetName(java.lang.String strName) Sets the name of the Job instance.

Method Detail

AddFile

void AddFile(java.io.File solverDeckFile)
             throws java.lang.Exception

This method adds a solver deck file to a job. Adding multiple files to a job definition is to be allowed.

Parameters:

solverDeckFile - The solver deck file to be added to the job.

Throws:

java.lang.Exception

RemoveFile

void RemoveFile(java.io.File solverDeckFile)
                throws java.lang.Exception

This method removes a solver deck file to a job. Removing multiple files from a job definition is to be allowed.

Parameters:

solverDeckFile - The solver deck file to be removed from the job.

Throws:

java.lang.Exception

SetAsMaster

void SetAsMaster(java.io.File solverDeckFile)
                 throws java.lang.Exception

Sets the specified deck file as the master file.

Parameters:

solverDeckFile - The specified deck file to be set as the master file.

Throws:

java.lang.Exception

AddSolverParams

void AddSolverParams(java.util.Vector vectSolverParams)
                     throws java.lang.Exception

Adds a vector of solver parameters for the job. Ex of solver params : adding subroutine nams etc.

Parameters:

vectSolverParams - A vector of solver parameters to be added for the job.

Throws:

java.lang.Exception

RemoveSolverParams

void RemoveSolverParams(java.util.Vector vectSolverParams)
                        throws java.lang.Exception

Removes a vector of solver parameters from the job. Ex of solver params : adding subroutine nams etc.

Parameters:

vectSolverParams - A vector of solver parameters to be removed from the job.

Throws:

java.lang.Exception

AddJobParams

void AddJobParams(java.util.Vector vectJobParams)
                  throws java.lang.Exception

Adds a vector of job related parameters for the job. Ex of a job related params: memory required, solver version etc

Parameters:

vectJobParams - A vector of job parameters to be added for the job.

Throws:

java.lang.Exception

RemoveJobParams

void RemoveJobParams(java.util.Vector vectJobParams)
                     throws java.lang.Exception

Removes a vector of job related parameters for the job. Ex of a job related params: memory required, solver version etc

Parameters:

vectJobParams - A vector of job parameters to be removed from the job.

Throws:

java.lang.Exception

AddPostProcessingParams

void AddPostProcessingParams(java.util.Vector vectPostParams)
                             throws java.lang.Exception

Adds a vector of post processor parameters for the job. ex: some arguments or an executable which will take existing solver output file and create another set of files.

Parameters:

vectPostParams - A vector of post processor parameters to be added for the job.

Throws:

java.lang.Exception

RemovePostProcessingParams

void RemovePostProcessingParams(java.util.Vector vectPostParams)
                                throws java.lang.Exception

Removes a vector of post processor parameters for the job. ex: some arguments or an executable which will take existing solver output file and create another set of files.

Parameters:

vectPostParams - A vector of post processor parameters to be removed from the job.

Throws:

java.lang.Exception

GetJobStatus

IHWMJobStatus GetJobStatus()
                           throws java.lang.Exception

Throws:

java.lang.Exception

SetName

void SetName(java.lang.String strName)
             throws java.lang.Exception

Sets the name of the Job instance.

Parameters:

strName - The name of the job to be set.

Throws:

java.lang.Exception

GetName

java.lang.String GetName()
                         throws java.lang.Exception

Gets the name of the job.

Returns:

A string representing the name of the job.

Throws:

java.lang.Exception

GetJobID

java.lang.String GetJobID()
                          throws java.lang.Exception

This method gets the ID for this job represented as a string.

Returns:

The ID for this job represented as a string.

Throws:

java.lang.Exception