Fossology\UI\Api\Models\JobQueue Class Reference

Model class to hold JobQueue info. More...

Collaboration diagram for Fossology\UI\Api\Models\JobQueue:

Public Member Functions
	__construct ($jobQueueId, $jobQueueType, $startTime, $endTime, $status, $itemsProcessed, $log, $dependencies, $itemsPerSec, $canDoActions, $isInProgress, $isReady, $download)
	getJobQueueId ()
	setJobQueueId ($jobQueueId)
	getJobQueueType ()
	setJobQueueType ($jobQueueType)
	getStartTime ()
	setStartTime ($startTime)
	getEndTime ()
	setEndTime ($endTime)
	getStatus ()
	setStatus ($status)
	getItemsProcessed ()
	setItemsProcessed ($itemsProcessed)
	getLog ()
	setLog ($log)
	getDependencies ()
	setDependencies ($dependencies)
	getItemsPerSec ()
	setItemsPerSec ($itemsPerSec)
	isCanDoActions ()
	setCanDoActions ($canDoActions)
	isInProgress ()
	setIsInProgress ($isInProgress)
	isReady ()
	setIsReady ($isReady)
	getDownload ()
	setDownload ($download)
	getJSON ()
	getArray ()

Private Attributes
	$jobQueueId
	$jobQueueType
	$startTime
	$endTime
	$status
	$itemsProcessed
	$log
	$dependencies
	$itemsPerSec
	$canDoActions
	$isInProgress
	$isReady
	$download

Detailed Description

Model class to hold JobQueue info.

Definition at line 17 of file JobQueue.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Models\JobQueue::__construct	(		$jobQueueId,
			$jobQueueType,
			$startTime,
			$endTime,
			$status,
			$itemsProcessed,
			$log,
			$dependencies,
			$itemsPerSec,
			$canDoActions,
			$isInProgress,
			$isReady,
			$download
	)

Upload constructor.

Parameters

integer	$jobQueueId
string	$jobQueueType
string	$startTime
string	$endTime
string	$status
integer	$itemsProcessed
string | null	$log
array	$dependencies
float	$itemsPerSec
boolean	$canDoActions
boolean	$isInProgress
boolean	$isReady
array | null	$download

Definition at line 100 of file JobQueue.php.

Member Function Documentation

getArray()

Fossology\UI\Api\Models\JobQueue::getArray

(

)

Get the JobQueue as an associative array

Returns

array

Definition at line 344 of file JobQueue.php.

getDependencies()

Fossology\UI\Api\Models\JobQueue::getDependencies

(

)

Returns

array

Definition at line 235 of file JobQueue.php.

getDownload()

Fossology\UI\Api\Models\JobQueue::getDownload

(

)

Returns

array|null

Definition at line 318 of file JobQueue.php.

getEndTime()

Fossology\UI\Api\Models\JobQueue::getEndTime

(

)

Returns

string

Definition at line 171 of file JobQueue.php.

getItemsPerSec()

Fossology\UI\Api\Models\JobQueue::getItemsPerSec

(

)

Returns

float

Definition at line 254 of file JobQueue.php.

getItemsProcessed()

Fossology\UI\Api\Models\JobQueue::getItemsProcessed

(

)

Returns

int

Definition at line 203 of file JobQueue.php.

getJobQueueId()

Fossology\UI\Api\Models\JobQueue::getJobQueueId

(

)

Returns

int

Definition at line 123 of file JobQueue.php.

getJobQueueType()

Fossology\UI\Api\Models\JobQueue::getJobQueueType

(

)

Returns

string

Definition at line 139 of file JobQueue.php.

getJSON()

Fossology\UI\Api\Models\JobQueue::getJSON

(

)

Get JobQueue in JSON representation

Returns

string

Definition at line 335 of file JobQueue.php.

getLog()

Fossology\UI\Api\Models\JobQueue::getLog

(

)

Returns

string|null

Definition at line 219 of file JobQueue.php.

getStartTime()

Fossology\UI\Api\Models\JobQueue::getStartTime

(

)

Returns

string

Definition at line 155 of file JobQueue.php.

getStatus()

Fossology\UI\Api\Models\JobQueue::getStatus

(

)

Returns

string

Definition at line 187 of file JobQueue.php.

isCanDoActions()

Fossology\UI\Api\Models\JobQueue::isCanDoActions

(

)

Returns

bool

Definition at line 270 of file JobQueue.php.

isInProgress()

Fossology\UI\Api\Models\JobQueue::isInProgress

(

)

Returns

bool

Definition at line 286 of file JobQueue.php.

isReady()

Fossology\UI\Api\Models\JobQueue::isReady

(

)

Returns

bool

Definition at line 302 of file JobQueue.php.

setCanDoActions()

Fossology\UI\Api\Models\JobQueue::setCanDoActions

(

$canDoActions

)

Parameters

bool

$canDoActions

Definition at line 278 of file JobQueue.php.

setDependencies()

Fossology\UI\Api\Models\JobQueue::setDependencies

(

$dependencies

)

Parameters

array

$dependencies

Definition at line 243 of file JobQueue.php.

setDownload()

Fossology\UI\Api\Models\JobQueue::setDownload

(

$download

)

Parameters

array | null

$download

Definition at line 326 of file JobQueue.php.

setEndTime()

Fossology\UI\Api\Models\JobQueue::setEndTime

(

$endTime

)

Parameters

string

$endTime

Definition at line 179 of file JobQueue.php.

setIsInProgress()

Fossology\UI\Api\Models\JobQueue::setIsInProgress

(

$isInProgress

)

Parameters

bool

$isInProgress

Definition at line 294 of file JobQueue.php.

setIsReady()

Fossology\UI\Api\Models\JobQueue::setIsReady

(

$isReady

)

Parameters

bool

$isReady

Definition at line 310 of file JobQueue.php.

setItemsPerSec()

Fossology\UI\Api\Models\JobQueue::setItemsPerSec

(

$itemsPerSec

)

Parameters

float

$itemsPerSec

Definition at line 262 of file JobQueue.php.

setItemsProcessed()

Fossology\UI\Api\Models\JobQueue::setItemsProcessed

(

$itemsProcessed

)

Parameters

int

$itemsProcessed

Definition at line 211 of file JobQueue.php.

setJobQueueId()

Fossology\UI\Api\Models\JobQueue::setJobQueueId

(

$jobQueueId

)

Parameters

int

$jobQueueId

Definition at line 131 of file JobQueue.php.

setJobQueueType()

Fossology\UI\Api\Models\JobQueue::setJobQueueType

(

$jobQueueType

)

Parameters

string

$jobQueueType

Definition at line 147 of file JobQueue.php.

setLog()

Fossology\UI\Api\Models\JobQueue::setLog

(

$log

)

Parameters

string | null

$log

Definition at line 227 of file JobQueue.php.

setStartTime()

Fossology\UI\Api\Models\JobQueue::setStartTime

(

$startTime

)

Parameters

string

$startTime

Definition at line 163 of file JobQueue.php.

setStatus()

Fossology\UI\Api\Models\JobQueue::setStatus

(

$status

)

Parameters

string

$status

Definition at line 195 of file JobQueue.php.

Member Data Documentation

$dependencies

array Fossology\UI\Api\Models\JobQueue::$dependencies

private

Job dependencies

Definition at line 58 of file JobQueue.php.

$download

array null Fossology\UI\Api\Models\JobQueue::$download

private

Any download related info

Definition at line 82 of file JobQueue.php.

$endTime

string Fossology\UI\Api\Models\JobQueue::$endTime

private

End Time of the Job

Definition at line 38 of file JobQueue.php.

$isInProgress

boolean Fossology\UI\Api\Models\JobQueue::$isInProgress

private

Is the job still in progress

Definition at line 72 of file JobQueue.php.

$isReady

boolean Fossology\UI\Api\Models\JobQueue::$isReady

private

Is the job ready

Definition at line 77 of file JobQueue.php.

$itemsPerSec

float Fossology\UI\Api\Models\JobQueue::$itemsPerSec

private

Items processed per second

Definition at line 63 of file JobQueue.php.

$itemsProcessed

integer Fossology\UI\Api\Models\JobQueue::$itemsProcessed

private

Total items processed

Definition at line 48 of file JobQueue.php.

$jobQueueId

integer Fossology\UI\Api\Models\JobQueue::$jobQueueId

private

Job queue Id

Definition at line 23 of file JobQueue.php.

$jobQueueType

string Fossology\UI\Api\Models\JobQueue::$jobQueueType

private

Job queue type

Definition at line 28 of file JobQueue.php.

$log

string null Fossology\UI\Api\Models\JobQueue::$log

private

Log location

Definition at line 53 of file JobQueue.php.

$startTime

string Fossology\UI\Api\Models\JobQueue::$startTime

private

Start time of the Job

Definition at line 33 of file JobQueue.php.

$status

string Fossology\UI\Api\Models\JobQueue::$status

private

Status of the Job

Definition at line 43 of file JobQueue.php.

---

The documentation for this class was generated from the following file:

• src/www/ui/api/Models/JobQueue.php