Skuid Model Condition Metadata Object¶
The Skuid Model Condition Metadata Object is built on the server-side and is not a constructible type.
Conditions are defined for a particular Model. For more information about defining conditions in the Page Composer, see how conditions determine the records in your model.
Note
All properties in the Condition Metadata Object should be treated as read-only. Overwriting these values on the rendered page will result in undefined behavior and likely cause unexpected and undesirable results.
Properties¶
-
field string
The name of the field on which the condition will operate, as defined in the Page Composer.
-
joinField¶ string
For a subquery, defines the field on which the subquery will be joined to the parent object, as defined in the Page Composer.
-
joinObject¶ string
For a subquery, the name of the sObject to query for a value or list of values for the condition, as defined in the Page Composer.
-
mergeField¶ string
When a condition derives its value from a “Field from another model”, the name of the field from which the value will be derived, as defined in the Page Composer.
-
model¶ string
The name of the skuid.model.Model that acts as the source for a “Field from another model” condition (“modelmerge”), as defined in the Page Composer.
-
name¶ string
The name of the filter as defined in the Page Composer.
-
noValueBehavior¶ string
A value defined in the Page Composer describing how the condition will behave if a value could not be derived from a URL parameter (the parameter was missing) or Model (no rows were returned).
deactivate - Deactivate this condition noquery - Abort this model’s query
-
operator¶ string
An operator defined in the Page Composer describing how the condition’s field will be compared to a value as defined in the Page Composer.
- =
- !=
- gt - >
- lt - <
- gte - >=
- lte - <=
- in
- not in
- starts with
- ends with
- contains
- does not contain
- does not start with
- does not end with
-
originalInactive¶ boolean
The default “inactive” state for a condition, as defined in the Page Composer.
-
subConditions¶ Skuid Model Condition Metadata Object
Conditions defined in the Page Composed which are applied to a subquery which will generate a value or list of values for the current condition.
-
subConditionLogic¶ string
A value defined in the Page Composer which describes how multiple subconditions should be combined.
Example: “(1 AND 2) OR (3 AND 4)”
-
type¶ string
The type of condition as defined by the “Value Content” picklist in the Page Composer.
- fieldvalue - Single specified value
- multiple - Multiple specified values
- param - URL parameter
- userinfo - UserInfo of page viewer
- blank - None - blank value
- modelmerge - Field from another model
- join - Result of subquery