Package com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituationtype

Class SituationContextDefSchema

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<SituationContextDefSchema>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituationtype.SituationContextDefSchema
public class SituationContextDefSchema extends VdmEntity<SituationContextDefSchema>
Schema for Data Context Definition

Original entity name from the Odata EDM: SituationContextDefSchemaType

  • Field Details

    • ALL_FIELDS

      public static final SituationContextDefSchemaSelectable ALL_FIELDS
      Selector for all available fields of SituationContextDefSchema.

    • SITN_DEF_TEMPLATE_ID

      public static final SituationContextDefSchemaField<String> SITN_DEF_TEMPLATE_ID
      Use with available fluent helpers to apply the SitnDefTemplateID field to query operations.

    • SITN_DATA_CNTXT_FORMAT_VERSION

      public static final SituationContextDefSchemaField<Integer> SITN_DATA_CNTXT_FORMAT_VERSION
      Use with available fluent helpers to apply the SitnDataCntxtFormatVersion field to query operations.

    • SITN_DATA_CNTXT_SCHEMA_VERSION

      public static final SituationContextDefSchemaField<Integer> SITN_DATA_CNTXT_SCHEMA_VERSION
      Use with available fluent helpers to apply the SitnDataCntxtSchemaVersion field to query operations.

    • SITN_DATA_CNTXT_SCHEMA

      public static final SituationContextDefSchemaField<String> SITN_DATA_CNTXT_SCHEMA
      Use with available fluent helpers to apply the SitnDataCntxtSchema field to query operations.

    • TO_SITUATION_CONTEXT_DEF_TEXT

      public static final SituationContextDefSchemaLink<SituationContextDefText> TO_SITUATION_CONTEXT_DEF_TEXT
      Use with available fluent helpers to apply the to_SituationContextDefText navigation property to query operations.

  • Constructor Details

    • SituationContextDefSchema

      public SituationContextDefSchema()

    • SituationContextDefSchema

      public SituationContextDefSchema(@Nullable String sitnDefTemplateID, @Nullable Integer sitnDataCntxtFormatVersion, @Nullable Integer sitnDataCntxtSchemaVersion, @Nullable String sitnDataCntxtSchema, List<SituationContextDefText> toSituationContextDefText)

  • Method Details

    • getType

      @Nonnull public Class<SituationContextDefSchema> getType()
      Specified by:
      getType in class VdmObject<SituationContextDefSchema>

    • setSitnDefTemplateID

      public void setSitnDefTemplateID(@Nullable String sitnDefTemplateID)
      (Key Field) Constraints: Not nullable, Maximum length: 32

      Original property name from the Odata EDM: SitnDefTemplateID

      Parameters:
      sitnDefTemplateID - Situation Standard Template ID

    • setSitnDataCntxtFormatVersion

      public void setSitnDataCntxtFormatVersion(@Nullable Integer sitnDataCntxtFormatVersion)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: SitnDataCntxtFormatVersion

      Parameters:
      sitnDataCntxtFormatVersion - Context Format Version

    • setSitnDataCntxtSchemaVersion

      public void setSitnDataCntxtSchemaVersion(@Nullable Integer sitnDataCntxtSchemaVersion)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: SitnDataCntxtSchemaVersion

      Parameters:
      sitnDataCntxtSchemaVersion - Schema Version of Data Context Definition

    • setSitnDataCntxtSchema

      public void setSitnDataCntxtSchema(@Nullable String sitnDataCntxtSchema)
      Constraints: none

      Original property name from the Odata EDM: SitnDataCntxtSchema

      Parameters:
      sitnDataCntxtSchema - Situation Data Context Data

    • getEntityCollection

      protected String getEntityCollection()
      Specified by:
      getEntityCollection in class VdmEntity<SituationContextDefSchema>

    • getKey

      @Nonnull protected Map<String,Object> getKey()
      Overrides:
      getKey in class VdmObject<SituationContextDefSchema>

    • toMapOfFields

      @Nonnull protected Map<String,Object> toMapOfFields()
      Overrides:
      toMapOfFields in class VdmObject<SituationContextDefSchema>

    • fromMap

      protected void fromMap(Map<String,Object> inputValues)
      Overrides:
      fromMap in class VdmObject<SituationContextDefSchema>

    • field

      @Nonnull public static <T> SituationContextDefSchemaField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
      Use with available fluent helpers to apply an extension field to query operations.
      Type Parameters:
      T - The type of the extension field when performing value comparisons.
      Parameters:
      fieldName - The name of the extension field as returned by the OData service.
      fieldType - The Java type to use for the extension field when performing value comparisons.
      Returns:
      A representation of an extension field from this entity.

    • field

      @Nonnull public static <T, DomainT> SituationContextDefSchemaField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
      Use with available fluent helpers to apply an extension field to query operations.
      Type Parameters:
      T - The type of the extension field when performing value comparisons.
      DomainT - The type of the extension field as returned by the OData service.
      Parameters:
      typeConverter - A TypeConverter<T, DomainT> instance whose first generic type matches the Java type of the field
      fieldName - The name of the extension field as returned by the OData service.
      Returns:
      A representation of an extension field from this entity, holding a reference to the given TypeConverter.

    • getDestinationForFetch

      @Nullable public HttpDestinationProperties getDestinationForFetch()
      Overrides:
      getDestinationForFetch in class VdmEntity<SituationContextDefSchema>

    • setServicePathForFetch

      protected void setServicePathForFetch(@Nullable String servicePathForFetch)
      Overrides:
      setServicePathForFetch in class VdmEntity<SituationContextDefSchema>

    • attachToService

      public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
      Overrides:
      attachToService in class VdmEntity<SituationContextDefSchema>

    • getDefaultServicePath

      protected String getDefaultServicePath()
      Overrides:
      getDefaultServicePath in class VdmEntity<SituationContextDefSchema>

    • toMapOfNavigationProperties

      @Nonnull protected Map<String,Object> toMapOfNavigationProperties()
      Overrides:
      toMapOfNavigationProperties in class VdmObject<SituationContextDefSchema>

    • fetchSituationContextDefText

      @Nonnull public List<SituationContextDefText> fetchSituationContextDefText()
      Fetches the SituationContextDefText entities (one to many) associated with this entity. This corresponds to the OData navigation property to_SituationContextDefText.

      Please note: This method will not cache or persist the query results.

      Returns:
      List containing one or more associated SituationContextDefText entities. If no entities are associated then an empty list is returned.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

    • getSituationContextDefTextOrFetch

      @Nonnull public List<SituationContextDefText> getSituationContextDefTextOrFetch()
      Retrieval of associated SituationContextDefText entities (one to many). This corresponds to the OData navigation property to_SituationContextDefText.

      If the navigation property to_SituationContextDefText of a queried SituationContextDefSchema is operated lazily, an ODataException can be thrown in case of an OData query error.

      Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.

      Returns:
      List of associated SituationContextDefText entities.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

    • getSituationContextDefTextIfPresent

      @Nonnull public io.vavr.control.Option<List<SituationContextDefText>> getSituationContextDefTextIfPresent()
      Retrieval of associated SituationContextDefText entities (one to many). This corresponds to the OData navigation property to_SituationContextDefText.

      If the navigation property for an entity SituationContextDefSchema has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.

      Returns:
      If the information for navigation property to_SituationContextDefText is already loaded, the result will contain the SituationContextDefText entities. If not, an Option with result state empty is returned.

    • setSituationContextDefText

      public void setSituationContextDefText(@Nonnull List<SituationContextDefText> value)
      Overwrites the list of associated SituationContextDefText entities for the loaded navigation property to_SituationContextDefText.

      If the navigation property to_SituationContextDefText of a queried SituationContextDefSchema is operated lazily, an ODataException can be thrown in case of an OData query error.

      Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.

      Parameters:
      value - List of SituationContextDefText entities.

    • addSituationContextDefText

      public void addSituationContextDefText(SituationContextDefText... entity)
      Adds elements to the list of associated SituationContextDefText entities. This corresponds to the OData navigation property to_SituationContextDefText.

      If the navigation property to_SituationContextDefText of a queried SituationContextDefSchema is operated lazily, an ODataException can be thrown in case of an OData query error.

      Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.

      Parameters:
      entity - Array of SituationContextDefText entities.

    • builder

      @Nonnull public static SituationContextDefSchema.SituationContextDefSchemaBuilder builder()

    • getSitnDefTemplateID

      @Nullable public String getSitnDefTemplateID()
      (Key Field) Constraints: Not nullable, Maximum length: 32

      Original property name from the Odata EDM: SitnDefTemplateID

      Returns:
      Situation Standard Template ID

    • getSitnDataCntxtFormatVersion

      @Nullable public Integer getSitnDataCntxtFormatVersion()
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: SitnDataCntxtFormatVersion

      Returns:
      Context Format Version

    • getSitnDataCntxtSchemaVersion

      @Nullable public Integer getSitnDataCntxtSchemaVersion()
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: SitnDataCntxtSchemaVersion

      Returns:
      Schema Version of Data Context Definition

    • getSitnDataCntxtSchema

      @Nullable public String getSitnDataCntxtSchema()
      Constraints: none

      Original property name from the Odata EDM: SitnDataCntxtSchema

      Returns:
      Situation Data Context Data

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class VdmObject<SituationContextDefSchema>

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class VdmEntity<SituationContextDefSchema>

    • canEqual

      protected boolean canEqual(@Nullable Object other)
      Overrides:
      canEqual in class VdmEntity<SituationContextDefSchema>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class VdmEntity<SituationContextDefSchema>