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

Class SituationType

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<SituationType>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituationtype.SituationType
public class SituationType extends VdmEntity<SituationType>
Situation Type

Original entity name from the Odata EDM: SituationTypeType

  • Field Details

    • ALL_FIELDS

      public static final SituationTypeSelectable ALL_FIELDS
      Selector for all available fields of SituationType.

    • SITN_DEFINITION_ID

      public static final SituationTypeField<String> SITN_DEFINITION_ID
      Use with available fluent helpers to apply the SitnDefinitionID field to query operations.

    • SITN_DEF_TEMPLATE_ID

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

    • SITN_DEF_IS_ENABLED

      public static final SituationTypeField<Boolean> SITN_DEF_IS_ENABLED
      Use with available fluent helpers to apply the SitnDefIsEnabled field to query operations.

    • SITN_DEF_DATA_CONTEXT_IS_ENABLED

      public static final SituationTypeField<Boolean> SITN_DEF_DATA_CONTEXT_IS_ENABLED
      Use with available fluent helpers to apply the SitnDefDataContextIsEnabled field to query operations.

    • SITN_DEF_AUTOMATION_IS_ENABLED

      public static final SituationTypeField<Boolean> SITN_DEF_AUTOMATION_IS_ENABLED
      Use with available fluent helpers to apply the SitnDefAutomationIsEnabled field to query operations.

    • TO_SITUATION_TYPE_TEXT

      public static final SituationTypeLink<SituationTypeText> TO_SITUATION_TYPE_TEXT
      Use with available fluent helpers to apply the to_SituationTypeText navigation property to query operations.

    • TO_SITUATION_TEMPLATE

      public static final SituationTypeOneToOneLink<SituationTemplate> TO_SITUATION_TEMPLATE
      Use with available fluent helpers to apply the to_SituationTemplate navigation property to query operations.

  • Constructor Details

    • SituationType

      public SituationType()

    • SituationType

      public SituationType(@Nullable String sitnDefinitionID, @Nullable String sitnDefTemplateID, @Nullable Boolean sitnDefIsEnabled, @Nullable Boolean sitnDefDataContextIsEnabled, @Nullable Boolean sitnDefAutomationIsEnabled, List<SituationTypeText> toSituationTypeText, @Nullable SituationTemplate toSituationTemplate)

  • Method Details

    • getType

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

    • setSitnDefinitionID

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

      Original property name from the Odata EDM: SitnDefinitionID

      Parameters:
      sitnDefinitionID - Situation Type ID

    • setSitnDefTemplateID

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

      Original property name from the Odata EDM: SitnDefTemplateID

      Parameters:
      sitnDefTemplateID - Situation Standard Template ID

    • setSitnDefIsEnabled

      public void setSitnDefIsEnabled(@Nullable Boolean sitnDefIsEnabled)
      Constraints: none

      Original property name from the Odata EDM: SitnDefIsEnabled

      Parameters:
      sitnDefIsEnabled - Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')

    • setSitnDefDataContextIsEnabled

      public void setSitnDefDataContextIsEnabled(@Nullable Boolean sitnDefDataContextIsEnabled)
      Constraints: none

      Original property name from the Odata EDM: SitnDefDataContextIsEnabled

      Parameters:
      sitnDefDataContextIsEnabled - Data Context Enabled

    • setSitnDefAutomationIsEnabled

      public void setSitnDefAutomationIsEnabled(@Nullable Boolean sitnDefAutomationIsEnabled)
      Constraints: none

      Original property name from the Odata EDM: SitnDefAutomationIsEnabled

      Parameters:
      sitnDefAutomationIsEnabled - Automation Enabled

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> SituationTypeField<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> SituationTypeField<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<SituationType>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchSituationTypeText

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

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

      Returns:
      List containing one or more associated SituationTypeText 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.

    • getSituationTypeTextOrFetch

      @Nonnull public List<SituationTypeText> getSituationTypeTextOrFetch()
      Retrieval of associated SituationTypeText entities (one to many). This corresponds to the OData navigation property to_SituationTypeText.

      If the navigation property to_SituationTypeText of a queried SituationType 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 SituationTypeText 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.

    • getSituationTypeTextIfPresent

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

      If the navigation property for an entity SituationType 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_SituationTypeText is already loaded, the result will contain the SituationTypeText entities. If not, an Option with result state empty is returned.

    • setSituationTypeText

      public void setSituationTypeText(@Nonnull List<SituationTypeText> value)
      Overwrites the list of associated SituationTypeText entities for the loaded navigation property to_SituationTypeText.

      If the navigation property to_SituationTypeText of a queried SituationType 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 SituationTypeText entities.

    • addSituationTypeText

      public void addSituationTypeText(SituationTypeText... entity)
      Adds elements to the list of associated SituationTypeText entities. This corresponds to the OData navigation property to_SituationTypeText.

      If the navigation property to_SituationTypeText of a queried SituationType 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 SituationTypeText entities.

    • fetchSituationTemplate

      @Nullable public SituationTemplate fetchSituationTemplate()
      Fetches the SituationTemplate entity (one to one) associated with this entity. This corresponds to the OData navigation property to_SituationTemplate.

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

      Returns:
      The single associated SituationTemplate entity, or null if an entity is not associated.
      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.

    • getSituationTemplateOrFetch

      @Nullable public SituationTemplate getSituationTemplateOrFetch()
      Retrieval of associated SituationTemplate entity (one to one). This corresponds to the OData navigation property to_SituationTemplate.

      If the navigation property to_SituationTemplate of a queried SituationType 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 SituationTemplate entity.
      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.

    • getSituationTemplateIfPresent

      @Nonnull public io.vavr.control.Option<SituationTemplate> getSituationTemplateIfPresent()
      Retrieval of associated SituationTemplate entity (one to one). This corresponds to the OData navigation property to_SituationTemplate.

      If the navigation property for an entity SituationType 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_SituationTemplate is already loaded, the result will contain the SituationTemplate entity. If not, an Option with result state empty is returned.

    • setSituationTemplate

      public void setSituationTemplate(SituationTemplate value)
      Overwrites the associated SituationTemplate entity for the loaded navigation property to_SituationTemplate.
      Parameters:
      value - New SituationTemplate entity.

    • builder

      @Nonnull public static SituationType.SituationTypeBuilder builder()

    • getSitnDefinitionID

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

      Original property name from the Odata EDM: SitnDefinitionID

      Returns:
      Situation Type ID

    • getSitnDefTemplateID

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

      Original property name from the Odata EDM: SitnDefTemplateID

      Returns:
      Situation Standard Template ID

    • getSitnDefIsEnabled

      @Nullable public Boolean getSitnDefIsEnabled()
      Constraints: none

      Original property name from the Odata EDM: SitnDefIsEnabled

      Returns:
      Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')

    • getSitnDefDataContextIsEnabled

      @Nullable public Boolean getSitnDefDataContextIsEnabled()
      Constraints: none

      Original property name from the Odata EDM: SitnDefDataContextIsEnabled

      Returns:
      Data Context Enabled

    • getSitnDefAutomationIsEnabled

      @Nullable public Boolean getSitnDefAutomationIsEnabled()
      Constraints: none

      Original property name from the Odata EDM: SitnDefAutomationIsEnabled

      Returns:
      Automation Enabled

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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