Class JobController

Hierarchy

JobController

Implements

Controller

Constructors

constructor

new JobController(context: PipelineContext, name: string, steps?: StepController[]): JobController
Parameters
- context: PipelineContext
- name: string
- steps: StepController[] = []
Returns JobController
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:46

Properties

`Private` `Readonly` _changedCallback

_changedCallback: ((event: string, step: StepController) => void)

Type declaration

- (event: string, step: StepController): void
- Parameters
  - event: string
  - step: StepController
  Returns void

`Private` `Readonly` _context

_context: PipelineContext

`Private` _current

_current: number

`Private` `Readonly` _name

_name: string

`Private` `Readonly` _observer

_observer: Observer<JobControllerEvent>

`Private` _state

_state: ControllerState

`Private` _stepDestructors

_stepDestructors: ObserverDestructor[]

`Private` `Readonly` _steps

_steps: StepController[]

`Static` Event

Event: typeof JobControllerEvent = JobControllerEvent

Methods

`Private` _onChanged

_onChanged(event: string, eventStep: StepController): void
Parameters
- event: string
- eventStep: StepController
Returns void
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:372

destroy

destroy(): void
Returns void
Implementation of Controller.destroy
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:78

getContext

getContext(): PipelineContext
Returns PipelineContext
Implementation of Controller.getContext
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:66

getErrorString

getErrorString(): string
Returns string
Implementation of Controller.getErrorString
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:361

getName

getName(): string
Returns string
Implementation of Controller.getName
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:74

getOutputString

getOutputString(): string
Returns string
Implementation of Controller.getOutputString
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:365

getState

getState(): ControllerState
Returns ControllerState
Implementation of Controller.getState
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:70

getStateDTO

getStateDTO(): JobControllerStateDTO
Returns JobControllerStateDTO
Implementation of Controller.getStateDTO
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:105

isCancelled

isCancelled(): boolean
Returns boolean
Implementation of Controller.isCancelled
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:169

isFailed

isFailed(): boolean
Returns boolean
Implementation of Controller.isFailed
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:203

isFinished

isFinished(): boolean
Returns boolean
Implementation of Controller.isFinished
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:186

isPaused

isPaused(): boolean
Returns boolean
Implementation of Controller.isPaused
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:152

isRunning

isRunning(): boolean
Returns boolean
Implementation of Controller.isRunning
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:118

isStarted

isStarted(): boolean
Returns boolean
Implementation of Controller.isStarted
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:135

isSuccessful

isSuccessful(): boolean
Returns boolean
Implementation of Controller.isSuccessful
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:220

on

on(name: JobControllerEvent, callback: ObserverCallback<JobControllerEvent, any[]>): ObserverDestructor
Parameters
- name: JobControllerEvent
- callback: ObserverCallback<JobControllerEvent, any[]>
Returns ObserverDestructor
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:94

onCancelled

onCancelled(callback: ObserverCallback<JobControllerEvent, [JobController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<JobControllerEvent, [JobController]>
Returns ObserverDestructor
Implementation of Controller.onCancelled
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:333

onChanged

onChanged(callback: ObserverCallback<JobControllerEvent, [JobController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<JobControllerEvent, [JobController]>
Returns ObserverDestructor
Implementation of Controller.onChanged
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:337

onFailed

onFailed(callback: ObserverCallback<JobControllerEvent, [JobController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<JobControllerEvent, [JobController]>
Returns ObserverDestructor
Implementation of Controller.onFailed
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:341

onFinished

onFinished(callback: ObserverCallback<JobControllerEvent, [JobController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<JobControllerEvent, [JobController]>
Returns ObserverDestructor
Implementation of Controller.onFinished
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:345

onPaused

onPaused(callback: ObserverCallback<JobControllerEvent, [JobController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<JobControllerEvent, [JobController]>
Returns ObserverDestructor
Implementation of Controller.onPaused
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:349

onResumed

onResumed(callback: ObserverCallback<JobControllerEvent, [JobController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<JobControllerEvent, [JobController]>
Returns ObserverDestructor
Implementation of Controller.onResumed
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:353

onStarted

onStarted(callback: ObserverCallback<JobControllerEvent, [JobController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<JobControllerEvent, [JobController]>
Returns ObserverDestructor
Implementation of Controller.onStarted
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:357

pause

pause(): JobController
Returns JobController
Implementation of Controller.pause
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:261

resume

resume(): JobController
Returns JobController
Implementation of Controller.resume
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:285

start

start(): JobController
Returns JobController
Implementation of Controller.start
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:237

stop

stop(): JobController
Returns JobController
Implementation of Controller.stop
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:309

toJSON

toJSON(): JsonAny
Returns JsonAny
Implementation of Controller.toJSON
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:114

toString

toString(): string
Returns string
Implementation of Controller.toString
- Defined in fi/hg/pipeline/controllers/job/JobController.ts:101

Generated using TypeDoc