Newer Version Available

This content describes an older version of this product. View Latest

BatchDataSrcFilterCriteria

Represents the details of a condition in the filter criteria used to retrieve records from the data source of a batch job. This object is available in API version 66.0 and later.

Supported Calls

describeSObjects(), query(), retrieve()

Fields

Field Details
BatchDataSourceId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the batch data source associated with the batch data source filter criteria.
This field is a relationship field.
Relationship Name
BatchDataSource
Relationship Type
Master-detail
Refers To
BatchDataSource (the master object)
DomainObjectName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the object that contains the field that's used in the filter criteria condition.
DynamicValueType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Specifies the data type of the input variable that's used in the filter criteria condition.
Possible values are:
  • boolean
  • currency
  • date
  • datetime
  • integer
  • picklist
  • reference
  • string
FieldName
Type
string
Properties
Filter, Group, Sort
Description
The name of the field that's used in the filter criteria condition.
FieldPath
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The patch of the related object field that's used in the filter criteria condition.
FieldValue
Type
string
Properties
Filter, Group, Sort
Description
The value of the specified field used to filter records of the data source.
FilterCriteriaSequence
Type
int
Properties
Filter, Group, Sort
Description
The sequence number of the condition in the filter criteria.
IsDynamicValue
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the value of the filter criteria condition is provided by an input variable.
The default value is false.
Operator
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Specifies the operator used in the filter criteria condition.
Possible values are:
  • equals—Equals
  • excludes—Excludes
  • greaterThan—Greater Than
  • greaterThanOrEqualTo—Greater Than Or Equal To
  • in—In
  • includes—Includes
  • isNotNull—Is Not Null
  • isNull—Is Null
  • lessThan—Less Than
  • lessThanOrEqualTo—Less Than Or Equal To
  • like—Like
  • notEquals—Not Equals
  • notIn—Not In