MockDSExportSettings (Smart GWT EE API 13.1p (2026-01-20))

java.lang.Object
- com.smartgwt.client.core.JsObject
- - com.smartgwt.client.core.DataClass
  - - com.smartgwt.client.util.MockDSExportSettings

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers
```
public class MockDSExportSettings
extends DataClass
```
Settings used to control the export or serialization of a DataSource by Reify.getMockDS().

Field Summary
- Fields inherited from class com.smartgwt.client.core.DataClass
  factoryCreated, factoryProperties
- Fields inherited from class com.smartgwt.client.core.JsObject
  jsObj

Constructor Summary

Constructors
Constructor and Description

MockDSExportSettings()

MockDSExportSettings(com.google.gwt.core.client.JavaScriptObject jsObj)

Constructors
Constructor and Description
`MockDSExportSettings()`
`MockDSExportSettings(com.google.gwt.core.client.JavaScriptObject jsObj)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Criteria`	`getCriteria()` The `criteria` used to fetch the records returned as part of the export or serialization.
`MockDSExportFormat`	`getFormat()` Determines the format emitted by `Reify.getMockDS()`.
`boolean`	`getIncludeCustomSimpleTypes()` Whether to include custom-defined `SimpleTypes`.
`boolean`	`getIncludeFKs()` Should `foreign key` relationships be included in the export or serialization of the `DataSource`?
`boolean`	`getIncludeImageFields()` Should `image fields` be included in the export or serialization of the `DataSource`? They are excluded by default since the stored paths are unlikely to be correct when placed in any other environment, such as Reify.
`int`	`getNumLevels()` The number of levels of nodes to include, for DataSources that define a `tree relationship` between fields by declaring a `foreignKey` on one field that refers to another from that same DataSource.
`int`	`getNumRows()` The number of rows of data to include, if more meet the `criteria`.
`java.lang.String[]`	`getOmitRelations()` If including `foreign key` relationships, those relationships to skip.
`static MockDSExportSettings`	`getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
`DSRequest[]`	`getRequestProperties()` The properties that will be specified on the `DSRequest` when fetching records.
`DSRequest`	`getRequestPropertiesAsDSRequest()` The properties that will be specified on the `DSRequest` when fetching records.
`boolean`	`getRootCriteriaOnly()` For DataSources that define a `tree relationship` between fields by declaring a `foreignKey` on one field that refers to another from that same DataSource, should `criteria` be applied only to the root node? If false, the criteria will be applied to all nodes.
`MockDSExportValidatorMode`	`getValidatorMode()` Controls which `validators`, if any, to include in the fields of the exported `MockDataSource`.
`MockDSExportSettings`	`setCriteria(Criteria criteria)` The `criteria` used to fetch the records returned as part of the export or serialization.
`MockDSExportSettings`	`setFormat(MockDSExportFormat format)` Determines the format emitted by `Reify.getMockDS()`.
`MockDSExportSettings`	`setIncludeCustomSimpleTypes(boolean includeCustomSimpleTypes)` Whether to include custom-defined `SimpleTypes`.
`MockDSExportSettings`	`setIncludeFKs(boolean includeFKs)` Should `foreign key` relationships be included in the export or serialization of the `DataSource`?
`MockDSExportSettings`	`setIncludeImageFields(boolean includeImageFields)` Should `image fields` be included in the export or serialization of the `DataSource`? They are excluded by default since the stored paths are unlikely to be correct when placed in any other environment, such as Reify.
`MockDSExportSettings`	`setNumLevels(int numLevels)` The number of levels of nodes to include, for DataSources that define a `tree relationship` between fields by declaring a `foreignKey` on one field that refers to another from that same DataSource.
`MockDSExportSettings`	`setNumRows(int numRows)` The number of rows of data to include, if more meet the `criteria`.
`MockDSExportSettings`	`setOmitRelations(java.lang.String... omitRelations)` If including `foreign key` relationships, those relationships to skip.
`MockDSExportSettings`	`setRequestProperties(DSRequest... requestProperties)` The properties that will be specified on the `DSRequest` when fetching records.
`MockDSExportSettings`	`setRequestProperties(DSRequest requestProperties)` The properties that will be specified on the `DSRequest` when fetching records.
`MockDSExportSettings`	`setRootCriteriaOnly(boolean rootCriteriaOnly)` For DataSources that define a `tree relationship` between fields by declaring a `foreignKey` on one field that refers to another from that same DataSource, should `criteria` be applied only to the root node? If false, the criteria will be applied to all nodes.
`MockDSExportSettings`	`setValidatorMode(MockDSExportValidatorMode validatorMode)` Controls which `validators`, if any, to include in the fields of the exported `MockDataSource`.

Methods inherited from class com.smartgwt.client.core.DataClass
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated

Methods inherited from class com.smartgwt.client.core.JsObject
equals, getJsObj, hashCode, isCreated, setJavaScriptObject, setJsObj

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MockDSExportSettings
```
public MockDSExportSettings()
```
  - MockDSExportSettings
```
public MockDSExportSettings(com.google.gwt.core.client.JavaScriptObject jsObj)
```
- Method Detail
  - getOrCreateRef
```
public static MockDSExportSettings getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
```
  - setCriteria
```
public MockDSExportSettings setCriteria(Criteria criteria)
```
    The criteria used to fetch the records returned as part of the export or serialization.
    
    Parameters:
    
    criteria - New criteria value. Default value is null
    
    Returns:
    
    MockDSExportSettings instance, for chaining setter calls
  - getCriteria
```
public Criteria getCriteria()
```
    The criteria used to fetch the records returned as part of the export or serialization.
    
    Returns:
    
    Current criteria value. Default value is null
  - setFormat
```
public MockDSExportSettings setFormat(MockDSExportFormat format)
```
    Determines the format emitted by Reify.getMockDS().
    
    Parameters:
    
    format - New format value. Default value is "xmlMockDS"
    
    Returns:
    
    MockDSExportSettings instance, for chaining setter calls
  - getFormat
```
public MockDSExportFormat getFormat()
```
    Determines the format emitted by Reify.getMockDS().
    
    Returns:
    
    Current format value. Default value is "xmlMockDS"
  - setIncludeCustomSimpleTypes
```
public MockDSExportSettings setIncludeCustomSimpleTypes(boolean includeCustomSimpleTypes)
```
    Whether to include custom-defined SimpleTypes.
    
    Parameters:
    
    includeCustomSimpleTypes - New includeCustomSimpleTypes value. Default value is false
    
    Returns:
    
    MockDSExportSettings instance, for chaining setter calls
  - getIncludeCustomSimpleTypes
```
public boolean getIncludeCustomSimpleTypes()
```
    Whether to include custom-defined SimpleTypes.
    
    Returns:
    
    Current includeCustomSimpleTypes value. Default value is false
  - setIncludeFKs
```
public MockDSExportSettings setIncludeFKs(boolean includeFKs)
```
    Should foreign key relationships be included in the export or serialization of the DataSource?
    
    Parameters:
    
    includeFKs - New includeFKs value. Default value is true
    
    Returns:
    
    MockDSExportSettings instance, for chaining setter calls
  - getIncludeFKs
```
public boolean getIncludeFKs()
```
    Should foreign key relationships be included in the export or serialization of the DataSource?
    
    Returns:
    
    Current includeFKs value. Default value is true
  - setIncludeImageFields
```
public MockDSExportSettings setIncludeImageFields(boolean includeImageFields)
```
    Should image fields be included in the export or serialization of the DataSource? They are excluded by default since the stored paths are unlikely to be correct when placed in any other environment, such as Reify.
    
    Parameters:
    
    includeImageFields - New includeImageFields value. Default value is false
    
    Returns:
    
    MockDSExportSettings instance, for chaining setter calls
  - getIncludeImageFields
```
public boolean getIncludeImageFields()
```
    Should image fields be included in the export or serialization of the DataSource? They are excluded by default since the stored paths are unlikely to be correct when placed in any other environment, such as Reify.
    
    Returns:
    
    Current includeImageFields value. Default value is false
  - setNumLevels
```
public MockDSExportSettings setNumLevels(int numLevels)
```
    The number of levels of nodes to include, for DataSources that define a tree relationship between fields by declaring a foreignKey on one field that refers to another from that same DataSource.
    
    Parameters:
    
    numLevels - New numLevels value. Default value is 3
    
    Returns:
    
    MockDSExportSettings instance, for chaining setter calls
    
    See Also:
    
    setRootCriteriaOnly(boolean)
  - getNumLevels
```
public int getNumLevels()
```
    The number of levels of nodes to include, for DataSources that define a tree relationship between fields by declaring a foreignKey on one field that refers to another from that same DataSource.
    
    Returns:
    
    Current numLevels value. Default value is 3
    
    See Also:
    
    getRootCriteriaOnly()
  - setNumRows
```
public MockDSExportSettings setNumRows(int numRows)
```
    The number of rows of data to include, if more meet the criteria.
    
    Parameters:
    
    numRows - New numRows value. Default value is 20
    
    Returns:
    
    MockDSExportSettings instance, for chaining setter calls
  - getNumRows
```
public int getNumRows()
```
    The number of rows of data to include, if more meet the criteria.
    
    Returns:
    
    Current numRows value. Default value is 20
  - setOmitRelations
```
public MockDSExportSettings setOmitRelations(java.lang.String... omitRelations)
```
    If including foreign key relationships, those relationships to skip. This can be used to avoid dangling references to DataSources that are not being exported or serialized.
    
    Parameters:
    
    omitRelations - New omitRelations value. Default value is null
    
    Returns:
    
    MockDSExportSettings instance, for chaining setter calls
    
    See Also:
    
    setIncludeFKs(boolean)
  - getOmitRelations
```
public java.lang.String[] getOmitRelations()
```
    If including foreign key relationships, those relationships to skip. This can be used to avoid dangling references to DataSources that are not being exported or serialized.
    
    Returns:
    
    Current omitRelations value. Default value is null
    
    See Also:
    
    getIncludeFKs()
  - setRequestProperties
```
public MockDSExportSettings setRequestProperties(DSRequest... requestProperties)
```
    The properties that will be specified on the DSRequest when fetching records. You can pass an array of different request properties matching the length of the dsNames param of Reify.getMockDS() or Reify.showMockDS() if you want the fetch for each DataSource made with different properties.
    
    Parameters:
    
    requestProperties - New requestProperties value. Default value is null
    
    Returns:
    
    MockDSExportSettings instance, for chaining setter calls
  - getRequestProperties
```
public DSRequest[] getRequestProperties()
```
    The properties that will be specified on the DSRequest when fetching records. You can pass an array of different request properties matching the length of the dsNames param of Reify.getMockDS() or Reify.showMockDS() if you want the fetch for each DataSource made with different properties.
    
    Returns:
    
    Current requestProperties value. Default value is null
  - setRequestProperties
```
public MockDSExportSettings setRequestProperties(DSRequest requestProperties)
```
    The properties that will be specified on the DSRequest when fetching records. You can pass an array of different request properties matching the length of the dsNames param of Reify.getMockDS() or Reify.showMockDS() if you want the fetch for each DataSource made with different properties.
    
    Parameters:
    
    requestProperties - New requestProperties value. Default value is null
    
    Returns:
    
    MockDSExportSettings instance, for chaining setter calls
  - getRequestPropertiesAsDSRequest
```
public DSRequest getRequestPropertiesAsDSRequest()
```
    The properties that will be specified on the DSRequest when fetching records. You can pass an array of different request properties matching the length of the dsNames param of Reify.getMockDS() or Reify.showMockDS() if you want the fetch for each DataSource made with different properties.
    
    Returns:
    
    Current requestProperties value. Default value is null
  - setRootCriteriaOnly
```
public MockDSExportSettings setRootCriteriaOnly(boolean rootCriteriaOnly)
```
    For DataSources that define a tree relationship between fields by declaring a foreignKey on one field that refers to another from that same DataSource, should criteria be applied only to the root node? If false, the criteria will be applied to all nodes.
    
    Parameters:
    
    rootCriteriaOnly - New rootCriteriaOnly value. Default value is false
    
    Returns:
    
    MockDSExportSettings instance, for chaining setter calls
    
    See Also:
    
    setNumLevels(int)
  - getRootCriteriaOnly
```
public boolean getRootCriteriaOnly()
```
    For DataSources that define a tree relationship between fields by declaring a foreignKey on one field that refers to another from that same DataSource, should criteria be applied only to the root node? If false, the criteria will be applied to all nodes.
    
    Returns:
    
    Current rootCriteriaOnly value. Default value is false
    
    See Also:
    
    getNumLevels()
  - setValidatorMode
```
public MockDSExportSettings setValidatorMode(MockDSExportValidatorMode validatorMode)
```
    Controls which validators, if any, to include in the fields of the exported MockDataSource. Since MockDataSources are client-only, server-only validators are not exported. Auto-generated validators are also not exported, since they will be recreated based on the type of the field during the import process.
    
    Parameters:
    
    validatorMode - New validatorMode value. Default value is "standard"
    
    Returns:
    
    MockDSExportSettings instance, for chaining setter calls
  - getValidatorMode
```
public MockDSExportValidatorMode getValidatorMode()
```
    Controls which validators, if any, to include in the fields of the exported MockDataSource. Since MockDataSources are client-only, server-only validators are not exported. Auto-generated validators are also not exported, since they will be recreated based on the type of the field during the import process.
    
    Returns:
    
    Current validatorMode value. Default value is "standard"

Class MockDSExportSettings

Field Summary

Fields inherited from class com.smartgwt.client.core.DataClass

Fields inherited from class com.smartgwt.client.core.JsObject

Constructor Summary

Method Summary

Methods inherited from class com.smartgwt.client.core.DataClass

Methods inherited from class com.smartgwt.client.core.JsObject

Methods inherited from class java.lang.Object

Constructor Detail

MockDSExportSettings

MockDSExportSettings

Method Detail

getOrCreateRef

setCriteria

getCriteria

setFormat

getFormat

setIncludeCustomSimpleTypes

getIncludeCustomSimpleTypes

setIncludeFKs

getIncludeFKs

setIncludeImageFields

getIncludeImageFields

setNumLevels

getNumLevels

setNumRows

getNumRows

setOmitRelations

getOmitRelations

setRequestProperties

getRequestProperties

setRequestProperties

getRequestPropertiesAsDSRequest

setRootCriteriaOnly

getRootCriteriaOnly

setValidatorMode

getValidatorMode