Fossology\UI\Api\Models\SuccessfulAgent Class Reference

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

Public Member Functions
	__construct ($agentId, $agentRev, $agentName)
	getAgentId ()
	getAgentRev ()
	getAgentName ()
	getJSON ($version=ApiVersion::V1)
	getArray ($version=ApiVersion::V1)
	setAgentId ($agentId)
	setAgentRev ($agentRev)
	setAgentName ($agentName)

Private Attributes
	$agentId
	$agentRev
	$agentName

Detailed Description

Definition at line 13 of file SuccessfulAgent.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Models\SuccessfulAgent::__construct	(		$agentId,
			$agentRev,
			$agentName
	)

Parameters

integer	$agentId
string	$agentRev
string	$agentName

Definition at line 36 of file SuccessfulAgent.php.

Member Function Documentation

getAgentId()

Fossology\UI\Api\Models\SuccessfulAgent::getAgentId

(

)

Returns

integer

Definition at line 46 of file SuccessfulAgent.php.

getAgentName()

Fossology\UI\Api\Models\SuccessfulAgent::getAgentName

(

)

Returns

string

Definition at line 62 of file SuccessfulAgent.php.

getAgentRev()

Fossology\UI\Api\Models\SuccessfulAgent::getAgentRev

(

)

Returns

string

Definition at line 54 of file SuccessfulAgent.php.

getArray()

Fossology\UI\Api\Models\SuccessfulAgent::getArray

(

$version = ApiVersion::V1

)

Get ScannedLicense element as associative array

Parameters

integer

$version

Returns

array

Definition at line 83 of file SuccessfulAgent.php.

getJSON()

Fossology\UI\Api\Models\SuccessfulAgent::getJSON

(

$version = ApiVersion::V1

)

JSON representation of current scannedLicense

Parameters

integer

$version

Returns

string

Definition at line 73 of file SuccessfulAgent.php.

setAgentId()

Fossology\UI\Api\Models\SuccessfulAgent::setAgentId

(

$agentId

)

Parameters

integer

$agentId

Definition at line 102 of file SuccessfulAgent.php.

setAgentName()

Fossology\UI\Api\Models\SuccessfulAgent::setAgentName

(

$agentName

)

Parameters

string

$agentName

Definition at line 118 of file SuccessfulAgent.php.

setAgentRev()

Fossology\UI\Api\Models\SuccessfulAgent::setAgentRev

(

$agentRev

)

Parameters

string

$agentRev

Definition at line 110 of file SuccessfulAgent.php.

Member Data Documentation

$agentId

integer Fossology\UI\Api\Models\SuccessfulAgent::$agentId

private

Agent id

Definition at line 19 of file SuccessfulAgent.php.

$agentName

string Fossology\UI\Api\Models\SuccessfulAgent::$agentName

private

Agent's name

Definition at line 29 of file SuccessfulAgent.php.

$agentRev

string Fossology\UI\Api\Models\SuccessfulAgent::$agentRev

private

Agent's rev

Definition at line 24 of file SuccessfulAgent.php.

---

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

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