Fossology\UI\Api\Models\ShowJob Class Reference

Model class to hold ShowJob info. More...

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

Public Member Functions
	__construct ($jobId, $jobName, $jobQueue, $uploadId)
	getJobId ()
	setJobId ($jobId)
	getJobName ()
	setJobName ($jobName)
	getJobQueue ()
	setJobQueue ($jobQueue)
	getUploadId ()
	setUploadId ($uploadId)
	getJSON ()
	getArray ()

Private Attributes
	$jobId
	$jobName
	$jobQueue
	$uploadId

Detailed Description

Model class to hold ShowJob info.

Definition at line 17 of file ShowJob.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Models\ShowJob::__construct	(		$jobId,
			$jobName,
			$jobQueue,
			$uploadId
	)

ShowJob constructor.

Parameters

integer	$jobId
string	$jobName
array	$jobQueue
integer	$uploadId

Definition at line 47 of file ShowJob.php.

Member Function Documentation

getArray()

Fossology\UI\Api\Models\ShowJob::getArray

(

)

Get the ShowJob as an associative array

Returns

array

Definition at line 132 of file ShowJob.php.

getJobId()

Fossology\UI\Api\Models\ShowJob::getJobId

(

)

Returns

int

Definition at line 58 of file ShowJob.php.

getJobName()

Fossology\UI\Api\Models\ShowJob::getJobName

(

)

Returns

string

Definition at line 74 of file ShowJob.php.

getJobQueue()

Fossology\UI\Api\Models\ShowJob::getJobQueue

(

)

Returns

array

Definition at line 90 of file ShowJob.php.

getJSON()

Fossology\UI\Api\Models\ShowJob::getJSON

(

)

Get ShowJob in JSON representation

Returns

string

Definition at line 123 of file ShowJob.php.

getUploadId()

Fossology\UI\Api\Models\ShowJob::getUploadId

(

)

Returns

int

Definition at line 106 of file ShowJob.php.

setJobId()

Fossology\UI\Api\Models\ShowJob::setJobId

(

$jobId

)

Parameters

int

$jobId

Definition at line 66 of file ShowJob.php.

setJobName()

Fossology\UI\Api\Models\ShowJob::setJobName

(

$jobName

)

Parameters

string

$jobName

Definition at line 82 of file ShowJob.php.

setJobQueue()

Fossology\UI\Api\Models\ShowJob::setJobQueue

(

$jobQueue

)

Parameters

array

$jobQueue

Definition at line 98 of file ShowJob.php.

setUploadId()

Fossology\UI\Api\Models\ShowJob::setUploadId

(

$uploadId

)

Parameters

int

$uploadId

Definition at line 114 of file ShowJob.php.

Member Data Documentation

$jobId

integer Fossology\UI\Api\Models\ShowJob::$jobId

private

Job Id

Definition at line 23 of file ShowJob.php.

$jobName

string Fossology\UI\Api\Models\ShowJob::$jobName

private

Name of the Job

Definition at line 28 of file ShowJob.php.

$jobQueue

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

private

Array of JobQueues

Definition at line 33 of file ShowJob.php.

$uploadId

int Fossology\UI\Api\Models\ShowJob::$uploadId

private

Upload ID for the job

Definition at line 38 of file ShowJob.php.

---

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

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