Class Scenario

java.lang.Object
com.onenetwork.platform.common.Scenario

public class Scenario
extends java.lang.Object
Stub for Scenario to compile platform-api code. This is removed from the platform-api jar, and at runtime the version from dvce.jar is used.
  • Constructor Summary

    Constructors 
    Constructor Description
    Scenario()  
  • Method Summary

    Modifier and Type Method Description
    java.lang.String getId()
    Gets the value of the id property.
    java.lang.String getScenarioType()
    Gets the value of the scenarioType property.
    java.lang.Long getSysScenarioId()
    Returns the surrogate id value for SysScenarioId.
    void setId​(java.lang.String value)
    Sets the value of the id property.
    void setScenarioType​(java.lang.String value)
    Sets the value of the scenarioType property.
    void setSysScenarioId​(java.lang.Long value, boolean nullifyNaturalKeys)
    Sets the surrogate id value for SysScenarioId.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

  • Method Details

    • getId

      public java.lang.String getId()
      Gets the value of the id property.
      Returns:
      possible object is String
    • setId

      public void setId​(java.lang.String value)
      Sets the value of the id property.
      Parameters:
      value - allowed object is String
    • getScenarioType

      public java.lang.String getScenarioType()
      Gets the value of the scenarioType property.
      Returns:
      possible object is String
    • setScenarioType

      public void setScenarioType​(java.lang.String value)
      Sets the value of the scenarioType property.
      Parameters:
      value - allowed object is String
    • getSysScenarioId

      public java.lang.Long getSysScenarioId()
      Returns the surrogate id value for SysScenarioId. After reading a model, this will always match with the corresponding natural keys, which are: scenarioId
    • setSysScenarioId

      public void setSysScenarioId​(java.lang.Long value, boolean nullifyNaturalKeys)
      Sets the surrogate id value for SysScenarioId. As a client, when you want to update the model in the database, you may set values either by natural key or by sys id, or by both. Calling this method with 'true' will nullify the natural keys for this surrogate key: scenarioId. This ensures the values don't conflict. If you are 'populating' an object and want to set both natural and surrogate keys, you should set the natural keys first, then call this method with 'false' for nullifyNaturalKeys.
      Parameters:
      value - new value for SysScenarioId
      nullifyNaturalKeys - true to nullify the related natural keys (scenarioId), or false to leave as is - please note that you can pass either surrogate id or natural keys to the server write API, or both