|
SDS2 Parametric API
|
This module provides an interface to job setup information. More...
Classes | |
| class | error |
| No documentation available. More... | |
| class | JobSetupLock |
| Opaque class representing the lock status of job options. More... | |
| class | MemberRevisionTuple |
| MemberRevisionTuple(short_description, long_description) More... | |
Functions | |
| def | GetJobPluginOption |
| def | GetJobPluginOptions |
| def | GetRefreshedJobPluginOption |
| def | GetRefreshedJobPluginOptions |
| def | IsSetupLocked |
| def | Job |
| def | JobName |
| def | JobProperties |
| def | JobPropertySet |
| def | LockSetup |
| def | ProcessJob |
| def | ProcessOneMem |
| def | ProcessSelection |
| def | RegisterDefaultPluginOption |
| def | RepositoryPath |
| def | SetDefaultPluginOption |
| def | UpdatePluginOption |
This module provides an interface to job setup information.
usage: import job jb = Job() blt_class = jb.bolt_class etc
| def job.GetJobPluginOption | ( | plugin_type, | |
| default | |||
| ) |
Return the setup option registered for plugin_type if one exists.
Otherwise return default | def job.GetJobPluginOptions | ( | args | ) |
Return all the setup objects registered by plugins
| def job.GetRefreshedJobPluginOption | ( | plugin_type, | |
| default | |||
| ) |
Refresh job options before returning GetJobPluginOption(plugin_type, default)
| def job.GetRefreshedJobPluginOptions | ( | args | ) |
Refresh job options before returning GetJobPluginOptions()
| def job.IsSetupLocked | ( | JobSetupLock_instance | ) |
Return True iff JobSetupLock_instance.IsLocked()
| def job.Job | ( | args | ) |
Job() returns a job object
| def job.JobName | ( | args | ) |
JobName() returns the job name string
| def job.JobProperties | ( | args | ) |
JobProperties() return a dictionary of job properties.
| def job.JobPropertySet | ( | args | ) |
JobPropertySet() sets a specific Job property.
| def job.LockSetup | ( | args | ) |
Return a JobSetupLock instance representing the lock status of job options
| def job.ProcessJob | ( | args | ) |
ProcessJob() processes the current job
| def job.ProcessOneMem | ( | args | ) |
ProcessOneMem() processes one member only
| def job.ProcessSelection | ( | members | ) |
Process the specified members according to the user and site options
| def job.RegisterDefaultPluginOption | ( | plugin_type, | |
| setup | |||
| ) |
Registers setup as the default setup for plugin_type
for the current session only. Does not require LockSetup().IsLocked()
and does not commit setup to the job options | def job.RepositoryPath | ( | args | ) |
RepositoryPath() returns the job repository path
| def job.SetDefaultPluginOption | ( | JobSetupLock_instance, | |
| plugin_type, | |||
| setup | |||
| ) |
Similar to {...}.setdefault(plugin_type, setup) when
JobSetupLock_instance.IsLocked() | def job.UpdatePluginOption | ( | JobSetupLock_instance, | |
| plugin_type, | |||
| setup | |||
| ) |
Return True iff the job options is updated with the specified
plugin_type and setup 
1.8.1.2