Package com.smartgwt.client.data

Class DSLoadSettings

java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.data.DSLoadSettings
All Implemented Interfaces:
HasHandlers
public class DSLoadSettings extends DataClass
Settings to control optional DataSource loading features.
See Also:

  • Constructor Details

    • DSLoadSettings

      public DSLoadSettings()

    • DSLoadSettings

      public DSLoadSettings(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static DSLoadSettings getOrCreateRef(JavaScriptObject jsObj)

    • setAllowMissing

      public DSLoadSettings setAllowMissing(Boolean allowMissing)
      Treat a requested DataSource that does not exist on the server as an ordinary outcome rather than an error: it is skipped without any error on the client or the server, the callback fires as usual, and DataSource.get() returns null for it. Use this when a DataSource is legitimately present in some deployments and absent in others, for example one belonging to an optional server feature, and the page should check for it and adapt.

      Only a DataSource that is not defined at all is treated this way. One that is defined but cannot be loaded, or a missing parent loaded through loadParents, is still reported as an error.

      Parameters:
      allowMissing - New allowMissing value. Default value is null
      Returns:
      DSLoadSettings instance, for chaining setter calls

    • getAllowMissing

      public Boolean getAllowMissing()
      Treat a requested DataSource that does not exist on the server as an ordinary outcome rather than an error: it is skipped without any error on the client or the server, the callback fires as usual, and DataSource.get() returns null for it. Use this when a DataSource is legitimately present in some deployments and absent in others, for example one belonging to an optional server feature, and the page should check for it and adapt.

      Only a DataSource that is not defined at all is treated this way. One that is defined but cannot be loaded, or a missing parent loaded through loadParents, is still reported as an error.

      Returns:
      Current allowMissing value. Default value is null

    • setForceReload

      public DSLoadSettings setForceReload(Boolean forceReload)
      Forcibly reload a dataSource if it's already loaded.
      Parameters:
      forceReload - New forceReload value. Default value is null
      Returns:
      DSLoadSettings instance, for chaining setter calls

    • getForceReload

      public Boolean getForceReload()
      Forcibly reload a dataSource if it's already loaded.
      Returns:
      Current forceReload value. Default value is null

    • setLoadParents

      public DSLoadSettings setLoadParents(Boolean loadParents)
      Load parent DataSources automatically for DataSources that have an inheritsFrom defined. Otherwise a DataSource with inheritsFrom will be broken if the parent DataSource is not already loaded.
      Parameters:
      loadParents - New loadParents value. Default value is null
      Returns:
      DSLoadSettings instance, for chaining setter calls

    • getLoadParents

      public Boolean getLoadParents()
      Load parent DataSources automatically for DataSources that have an inheritsFrom defined. Otherwise a DataSource with inheritsFrom will be broken if the parent DataSource is not already loaded.
      Returns:
      Current loadParents value. Default value is null

    • setMockMode

      public DSLoadSettings setMockMode(Boolean mockMode)
      Place loaded DataSource into mockMode
      Parameters:
      mockMode - New mockMode value. Default value is null
      Returns:
      DSLoadSettings instance, for chaining setter calls

    • getMockMode

      public Boolean getMockMode()
      Place loaded DataSource into mockMode
      Returns:
      Current mockMode value. Default value is null