Fossology\DeciderJob\UI\DeciderJobAgentPlugin Class Reference

UI plugin for DeciderJobAgent. More...

Inheritance diagram for Fossology\DeciderJob\UI\DeciderJobAgentPlugin:

Collaboration diagram for Fossology\DeciderJob\UI\DeciderJobAgentPlugin:

Public Member Functions
	preInstall ()
	AgentAdd ($jobId, $uploadId, &$errorMsg, $dependencies=array(), $conflictStrategyId=null)
Public Member Functions inherited from Fossology\Lib\Plugin\AgentPlugin
	execute ()
	postInstall ()
	preInstall ()
	unInstall ()
	getName ()
	AgentHasResults ($uploadId=0)
	AgentAdd ($jobId, $uploadId, &$errorMsg, $dependencies=array(), $arguments=null)
	__toString ()

Public Attributes
const	CONFLICT_STRATEGY_FLAG = "-k"
Public Attributes inherited from Fossology\Lib\Plugin\AgentPlugin
const	PRE_JOB_QUEUE = 'preJq'
	$AgentName
	$Name = "agent_abstract"
	$Dependency = array()
	$Title = 'how to show checkbox'
	$PluginLevel = 10
	$State = PLUGIN_STATE_READY
	$DBaccess = PLUGIN_DB_WRITE

Additional Inherited Members
Protected Member Functions inherited from Fossology\Lib\Plugin\AgentPlugin
	doAgentAdd ($jobId, $uploadId, &$errorMsg, $dependencies, $jqargs="", $jq_cmd_args=null)
	implicitAgentAdd ($jobId, $uploadId, &$errorMsg, $dependency)

Detailed Description

UI plugin for DeciderJobAgent.

Definition at line 32 of file DeciderJobAgentPlugin.php.

Member Function Documentation

Fossology\DeciderJob\UI\DeciderJobAgentPlugin::AgentAdd	(		$jobId,
			$uploadId,
		&	$errorMsg,
			$dependencies = array(),
			$conflictStrategyId = null
	)

Parameters

int	$jobId
int	$uploadId
	&string	$errorMsg - error message on failure
array	$dependencies	- array of plugin names representing dependencies.
mixed	$arguments	(ignored if not a string)

Returns

int

• jqId Successfully queued
• 0 Not queued, latest version of agent has previously run successfully
• -1 Not queued, error, error string in $ErrorMsg

See also

Fossology::Lib::Plugin::AgentPlugin::AgentAdd()

Definition at line 58 of file DeciderJobAgentPlugin.php.

Fossology\DeciderJob\UI\DeciderJobAgentPlugin::preInstall

(

)

See also

Fossology::Lib::Plugin::AgentPlugin::preInstall()

Implements Fossology\Lib\Plugin\Plugin.

Definition at line 49 of file DeciderJobAgentPlugin.php.

---

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

• src/deciderjob/ui/DeciderJobAgentPlugin.php