gbs: python::GBSTask::GBSProtoJob Class Reference

A potential job made actual through the Task.PromoteProtoJob() method.

Protojobs allow users to create large numbers of jobs
automatically using scripts or data files and review and correct
them before "promoting" them into jobs.  As such they are easy
to create and destroy, are not persisted and are consequently lost at
program termination, unless promoted.

GBSProtoJob emulate the following small subset of a real job:-

GetType()
  Return object type.

GetScriptLocalArgs()
  Return (as a string) the list of application script args that are local to this job

SetScriptLocalArgs(args_str)
  Set (as a string) the list of application script args that are local to this job

  e.g.  job.SetScriptLocalArgs('123 "a string with spaces" 456')

Member Function Documentation

def python::GBSTask::GBSProtoJob::__init__	(	self,
		name
	)

Definition at line 969 of file GBSTask.py.

00975                                                                 :-
00976

def python::GBSTask::GBSProtoJob::__repr__ ( self )

Definition at line 979 of file GBSTask.py.

00990                            :
        self.__name               = name

def python::GBSTask::GBSProtoJob::AsString	(	self,
		level = `"Brief"`
	)

Return string description.

 Return string description at the following levels:-
"Brief"    one line summary suitable for rows in tables
"Heading"  one line summary suitable as heading for "Brief"

Definition at line 982 of file GBSTask.py.

00990                            :
00991         self.__name               = name
00992         self.__scriptLocalArgs    = ""
00993         self.__localEnvironment   = ""
00994         self.__localInputSandbox  = ""
00995         self.__localOutputSandbox = ""
00996         
00997 
00998     def GetType(self): return "GBSProtoJob"
00999 
01000     def __repr__(self): return self.AsString()

def python::GBSTask::GBSProtoJob::GetLocalEnvironment ( self )

Return, as a comma separated list string, the environment that is local to this job

Definition at line 1001 of file GBSTask.py.

01003                                       :
01004 
        """Return string description.

def python::GBSTask::GBSProtoJob::GetLocalInputSandbox ( self )

Return, as a comma separated list string, the input sandbox file list that is local to this job.

Definition at line 1009 of file GBSTask.py.

01011                                 :
01012             s  = "Name".ljust(20)
            s += "Status".ljust(23)

def python::GBSTask::GBSProtoJob::GetLocalOutputSandbox ( self )

Return, as a comma separated list string, the ouput sandbox file list that is local to this job.

Definition at line 1013 of file GBSTask.py.

01022                                  :
        """Return, as a comma separated list string, the environment that is local to this job"""

def python::GBSTask::GBSProtoJob::GetScriptLocalArgs ( self )

Return (as a string) the list of application script args that are local to this job

Definition at line 1005 of file GBSTask.py.

01007                                                           :-
01008         "Brief"    one line summary suitable for rows in tables

def python::GBSTask::GBSProtoJob::GetType ( self )

Definition at line 977 of file GBSTask.py.

00990                            :
        self.__name               = name

def python::GBSTask::GBSProtoJob::SetLocalEnvironment	(	self,
		env_str
	)

Set, as a comma separated list string, the environment that local to this job..

Definition at line 1017 of file GBSTask.py.

01022                                  :
        """Return, as a comma separated list string, the environment that is local to this job"""

def python::GBSTask::GBSProtoJob::SetLocalInputSandbox	(	self,
		in_sbox_str
	)

Set, as a comma separated list string, the input sandbox file list that is local to this job

Definition at line 1025 of file GBSTask.py.

01026                                 :
01027         """Return (as a string) the list of application script args that are local to this job"""
01028         return self.__scriptLocalArgs
01029     
01030     def GetLocalInputSandbox(self):
01031         """Return, as a comma separated list string, the input sandbox file list that is local to this job."""
        return self.__localInputSandbox

def python::GBSTask::GBSProtoJob::SetLocalOutputSandbox	(	self,
		out_sbox_str
	)

Set, as a comma separated list string, the output sandbox file list that is local to this job.

Definition at line 1032 of file GBSTask.py.

01034                                    :
01035         """Return, as a comma separated list string, the ouput sandbox file list that is local to this job."""
01036         return self.__localOutputSandbox
01037 
01038     def SetLocalEnvironment(self,env_str):
01039         """Set, as a comma separated list string, the environment that local to this job.."""
        self.__localEnvironment = env_str

def python::GBSTask::GBSProtoJob::SetScriptLocalArgs	(	self,
		arg_str
	)

Set (as a string) the comma separated list of application script args that are local to this job.

Definition at line 1021 of file GBSTask.py.

01022                                  :
01023         """Return, as a comma separated list string, the environment that is local to this job"""
01024         return self.__localEnvironment

python::GBSTask::GBSProtoJob Class Reference

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation


Public Member Functions
def	__init__
def	GetType
def	__repr__
def	AsString
def	GetLocalEnvironment
def	GetScriptLocalArgs
def	GetLocalInputSandbox
def	GetLocalOutputSandbox
def	SetLocalEnvironment
def	SetScriptLocalArgs
def	SetLocalInputSandbox
def	SetLocalOutputSandbox
Private Attributes
	__name
	__scriptLocalArgs
	__localEnvironment
	__localInputSandbox
	__localOutputSandbox