BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
IJobSpecification Interface Reference
Inheritance diagram for IJobSpecification:

Public Member Functions

 getType ()
 
 getParams ()
 
 getReleaseTimestamp ()
 
 ignoreDuplicates ()
 
 getDeduplicationInfo ()
 
 getRootJobParams ()
 
 hasRootJobParams ()
 
 isRootJob ()
 
 getTitle ()
 

Detailed Description

Job queue task description interface

Since
1.23

Member Function Documentation

IJobSpecification::getDeduplicationInfo ( )

Subclasses may need to override this to make duplication detection work. The resulting map conveys everything that makes the job unique. This is only checked if ignoreDuplicates() returns true, meaning that duplicate jobs are supposed to be ignored.

Returns
array Map of key/values

Implemented in RefreshLinksJob, CategoryMembershipChangeJob, Job, JobSpecification, PublishStashedFileJob, and AssembleUploadChunksJob.

IJobSpecification::getParams ( )
Returns
array

Implemented in JobSpecification, and Job.

IJobSpecification::getReleaseTimestamp ( )
Returns
int|null UNIX timestamp to delay running this job until, otherwise null

Implemented in JobSpecification, and Job.

IJobSpecification::getRootJobParams ( )
See Also
JobQueue::deduplicateRootJob()
Returns
array
Since
1.26

Implemented in Job, and JobSpecification.

IJobSpecification::getTitle ( )
Returns
Title Descriptive title (this can simply be informative)

Implemented in JobSpecification, Job, and SMW\MediaWiki\Jobs\JobBase.

IJobSpecification::getType ( )
Returns
string Job type

Implemented in JobSpecification, Job, and SMW\MediaWiki\Jobs\JobBase.

IJobSpecification::hasRootJobParams ( )
See Also
JobQueue::deduplicateRootJob()
Returns
bool
Since
1.22

Implemented in Job, and JobSpecification.

IJobSpecification::ignoreDuplicates ( )
Returns
bool Whether only one of each identical set of jobs should be run

Implemented in Job, and JobSpecification.

IJobSpecification::isRootJob ( )
See Also
JobQueue::deduplicateRootJob()
Returns
bool Whether this is job is a root job

Implemented in Job, and JobSpecification.


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