class Job extends ConcreteObject (View source)

Constants

JOB_SUCCESS

JOB_ERROR_EXCEPTION_GENERAL

Properties

$error from ConcreteObject
protected $jobClassLocations
$jID
$jStatus
$availableJStatus
$jDateLastRun
$jHandle
$jNotUninstallable
$isScheduled
$scheduledInterval
$scheduledValue

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

No description

run()

No description

getJobName()

No description

getJobDescription()

No description

getJobHandle()

No description

getJobID()

No description

getPackageHandle()

No description

getJobLastStatusCode()

No description

didFail()

No description

canUninstall()

No description

supportsQueue()

No description

static 
jobClassLocations()

No description

getJobDateLastRun()

No description

getJobStatus()

No description

getJobLastStatusText()

No description

static 
authenticateRequest($auth)

No description

static 
generateAuth()

No description

static 
exportList($xml)

No description

static Job[]
getList(bool $scheduledOnly = false)

No description

reset()

No description

markStarted()

No description

markCompleted($resultCode, $resultMsg = false)

No description

static 
getByID($jID)

No description

static 
getByHandle($jHandle = '')

No description

static 
getJobObjByHandle($jHandle = '', $jobData = array())

No description

static 
getClassName($jHandle, $pkgHandle = null)

No description

static 
getAvailableList($includeConcreteDirJobs = 1)

No description

executeJob()

No description

setJobStatus($jStatus = 'ENABLED')

No description

static 
installByHandle($jHandle = '')

No description

static 
getListByPackage($pkg)

No description

static 
installByPackage($jHandle, $pkg)

No description

install()

No description

uninstall()

No description

static 
clearLog()

Removes Job log entries.

isScheduledForNow()

No description

setSchedule($scheduled, $interval, $value)

No description

Details

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

abstract run()

abstract getJobName()

abstract getJobDescription()

getJobHandle()

getJobID()

getPackageHandle()

getJobLastStatusCode()

didFail()

canUninstall()

supportsQueue()

static jobClassLocations()

getJobDateLastRun()

getJobStatus()

getJobLastStatusText()

static authenticateRequest($auth)

Parameters

$auth

static generateAuth()

static exportList($xml)

Parameters

$xml

static Job[] getList(bool $scheduledOnly = false)

Parameters

bool $scheduledOnly

Return Value

Job[]

reset()

markStarted()

markCompleted($resultCode, $resultMsg = false)

Parameters

$resultCode
$resultMsg

static getByID($jID)

Parameters

$jID

static getByHandle($jHandle = '')

Parameters

$jHandle

static getJobObjByHandle($jHandle = '', $jobData = array())

Parameters

$jHandle
$jobData

static protected getClassName($jHandle, $pkgHandle = null)

Parameters

$jHandle
$pkgHandle

static getAvailableList($includeConcreteDirJobs = 1)

Parameters

$includeConcreteDirJobs

executeJob()

setJobStatus($jStatus = 'ENABLED')

Parameters

$jStatus

static installByHandle($jHandle = '')

Parameters

$jHandle

static getListByPackage($pkg)

Parameters

$pkg

static installByPackage($jHandle, $pkg)

Parameters

$jHandle
$pkg

install()

uninstall()

static clearLog()

Removes Job log entries.

isScheduledForNow()

setSchedule($scheduled, $interval, $value)

Parameters

$scheduled
$interval
$value