Class awBulkMutateJobSelector

Description

Specifies additional criteria for selecting bulk mutate jobs.

Located in /classes/cm/BulkMutateJobSelector.php

awComplexObject
   |
   --awJobSelector
      |
      --awBulkMutateJobSelector
Variable Summary
 long[] $jobIds
 string[] $jobStatuses
Method Summary
 void getRow ()
Variables
long[] $jobIds

The list of jobs, specified by IDs, to be selected. An empty list indicates all jobs for the effective customer should be selected.

<span class="constraint ContentsDistinct">This field must contain distinct elements.</span> <span class="constraint ContentsNotNull">This field must not contain {@code null} elements.</span>

string[] $jobStatuses

Only jobs having these statuses are selected. If omitted, it indicates that all jobs statuses should be selected.

<span class="constraint ContentsDistinct">This field must contain distinct elements.</span> <span class="constraint ContentsNotNull">This field must not contain {@code null} elements.</span>

  • var: awBasicJobStatus
int $resultPartIndex

The index of the result part to include with in the returned jobs.

{@code null} indicates that no result part is to be included. <p>Only set this field if the selector specifies exactly one job using #jobIds (a request part can be retrieved for only one job at a time).</p> <span class="constraint InRange">This field must be greater than or equal to 0.0.</span>

Inherited Variables

Inherited from awJobSelector

awJobSelector::$customerJobKeys
awJobSelector::$includeHistory
awJobSelector::$includeStats

Inherited from awComplexObject

awComplexObject::$_cachedCheckFields
awComplexObject::$_row
Methods

Documentation generated on Thu, 15 Apr 2010 19:06:11 +0300 by phpDocumentor 1.4.3