Fossology\UI\Api\Models\Job Class Reference

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

Public Member Functions
	__construct ($id, $name="", $queueDate="", $uploadId=0, $userId=0, $groupId=0, $eta=0, $status="", $jobQueue=[])
	getJSON ($version=ApiVersion::V1)
	getId ()
	getName ()
	getQueueDate ()
	getUploadId ()
	getUserId ()
	getGroupId ()
	getEta ()
	getStatus ()
	getJobQueue ()
	setName ($name)
	setQueueDate ($queueDate)
	setUploadId ($uploadId)
	setUserId ($userId)
	setGroupId ($groupId)
	setEta ($eta)
	setStatus ($status)
	setJobQueue ($jobQueue)

Private Attributes
	$id
	$name
	$queueDate
	$uploadId
	$userId
	$groupId
	$eta
	$status
	$jobQueue

Detailed Description

Definition at line 22 of file Job.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Models\Job::__construct	(		$id,
			$name = "",
			$queueDate = "",
			$uploadId = 0,
			$userId = 0,
			$groupId = 0,
			$eta = 0,
			$status = "",
			$jobQueue = []
	)

Job constructor.

Parameters

integer	$id
string	$name
string	$queueDate
integer	$uploadId
integer	$userId
integer	$groupId
integer	$eta
string	$status
array	$jobQueue

Definition at line 88 of file Job.php.

Member Function Documentation

getEta()

Fossology\UI\Api\Models\Job::getEta

(

)

Get job ETA in seconds

Returns

number Job ETA in seconds

Definition at line 204 of file Job.php.

getGroupId()

Fossology\UI\Api\Models\Job::getGroupId

(

)

Get group id

Returns

number Group id

Definition at line 195 of file Job.php.

getId()

Fossology\UI\Api\Models\Job::getId

(

)

Get the job ID

Returns

number Job id

Definition at line 150 of file Job.php.

getJobQueue()

Fossology\UI\Api\Models\Job::getJobQueue

(

)

Get job queue

Returns

array Job queue

Definition at line 222 of file Job.php.

getJSON()

Fossology\UI\Api\Models\Job::getJSON

(

$version = ApiVersion::V1

)

JSON representation of current job

Returns

string

Definition at line 106 of file Job.php.

getName()

Fossology\UI\Api\Models\Job::getName

(

)

Get the job name

Returns

string Job name

Definition at line 159 of file Job.php.

getQueueDate()

Fossology\UI\Api\Models\Job::getQueueDate

(

)

Get date with timezone when job was added

Returns

string Job date

Definition at line 168 of file Job.php.

getStatus()

Fossology\UI\Api\Models\Job::getStatus

(

)

Get job status

Returns

string Job status

Definition at line 213 of file Job.php.

getUploadId()

Fossology\UI\Api\Models\Job::getUploadId

(

)

Get upload id

Returns

number Upload id

Definition at line 177 of file Job.php.

getUserId()

Fossology\UI\Api\Models\Job::getUserId

(

)

Get user id

Returns

number User id

Definition at line 186 of file Job.php.

setEta()

Fossology\UI\Api\Models\Job::setEta

(

$eta

)

Set the job ETA

Parameters

number

$eta

Job ETA

Definition at line 276 of file Job.php.

setGroupId()

Fossology\UI\Api\Models\Job::setGroupId

(

$groupId

)

Set the group id

Parameters

number

$groupId

New group id

Definition at line 267 of file Job.php.

setJobQueue()

Fossology\UI\Api\Models\Job::setJobQueue

(

$jobQueue

)

Set the job queue

Parameters

array

$jobQueue

Job queue

Definition at line 294 of file Job.php.

setName()

Fossology\UI\Api\Models\Job::setName

(

$name

)

Set the job name

Parameters

string

$name

Job name

Definition at line 231 of file Job.php.

setQueueDate()

Fossology\UI\Api\Models\Job::setQueueDate

(

$queueDate

)

Set the job queue date

Parameters

string

$queueDate

New queue date

Definition at line 240 of file Job.php.

setStatus()

Fossology\UI\Api\Models\Job::setStatus

(

$status

)

Set the job status

Parameters

string

$status

Job status

Definition at line 285 of file Job.php.

setUploadId()

Fossology\UI\Api\Models\Job::setUploadId

(

$uploadId

)

Set the job upload id

Parameters

number

$uploadId

Job upload id

Definition at line 249 of file Job.php.

setUserId()

Fossology\UI\Api\Models\Job::setUserId

(

$userId

)

Set the user id

Parameters

number

$userId

User id

Definition at line 258 of file Job.php.

Member Data Documentation

$eta

integer Fossology\UI\Api\Models\Job::$eta

private

Estimated time of completion of job

Definition at line 58 of file Job.php.

$groupId

integer Fossology\UI\Api\Models\Job::$groupId

private

Group id for current job

Definition at line 53 of file Job.php.

$id

integer Fossology\UI\Api\Models\Job::$id

private

Job id

Definition at line 28 of file Job.php.

$jobQueue

array Fossology\UI\Api\Models\Job::$jobQueue

private

Array of JobQueues

Definition at line 73 of file Job.php.

$name

string Fossology\UI\Api\Models\Job::$name

private

Job name

Definition at line 33 of file Job.php.

$queueDate

string Fossology\UI\Api\Models\Job::$queueDate

private

Job queue date

Definition at line 38 of file Job.php.

$status

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

private

The status of the job. Can be one of following:

• Completed
• Failed
• Queued
• Processing

Definition at line 68 of file Job.php.

$uploadId

integer Fossology\UI\Api\Models\Job::$uploadId

private

Upload id for current job

Definition at line 43 of file Job.php.

$userId

integer Fossology\UI\Api\Models\Job::$userId

private

User id for current job

Definition at line 48 of file Job.php.

---

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

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