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

Class SituationTemplate

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

Original entity name from the Odata EDM: SituationTemplateType

  • Field Details

    • ALL_FIELDS

      public static final SituationTemplateSelectable ALL_FIELDS
      Selector for all available fields of SituationTemplate.

    • SITN_DEF_TEMPLATE_ID

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

    • SITN_DEF_DATA_CONTEXT_IS_ENABLED

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

    • TO_SITUATION_ACTION

      public static final SituationTemplateLink<SituationAction> TO_SITUATION_ACTION
      Use with available fluent helpers to apply the to_SituationAction navigation property to query operations.

    • TO_SITUATION_TEMPLATE_TEXT

      public static final SituationTemplateLink<SituationTemplateText> TO_SITUATION_TEMPLATE_TEXT
      Use with available fluent helpers to apply the to_SituationTemplateText navigation property to query operations.

    • TO_SITUATION_TYPE

      public static final SituationTemplateLink<SituationType> TO_SITUATION_TYPE
      Use with available fluent helpers to apply the to_SituationType navigation property to query operations.

  • Constructor Details

  • Method Details

    • getType

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

    • 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

    • setSitnDefDataContextIsEnabled

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

      Original property name from the Odata EDM: SitnDefDataContextIsEnabled

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

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> SituationTemplateField<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> SituationTemplateField<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<SituationTemplate>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchSituationAction

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

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

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

    • getSituationActionOrFetch

      @Nonnull public List<SituationAction> getSituationActionOrFetch()
      Retrieval of associated SituationAction entities (one to many). This corresponds to the OData navigation property to_SituationAction.

      If the navigation property to_SituationAction of a queried SituationTemplate 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 SituationAction 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.

    • getSituationActionIfPresent

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

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

    • setSituationAction

      public void setSituationAction(@Nonnull List<SituationAction> value)
      Overwrites the list of associated SituationAction entities for the loaded navigation property to_SituationAction.

      If the navigation property to_SituationAction of a queried SituationTemplate 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 SituationAction entities.

    • addSituationAction

      public void addSituationAction(SituationAction... entity)
      Adds elements to the list of associated SituationAction entities. This corresponds to the OData navigation property to_SituationAction.

      If the navigation property to_SituationAction of a queried SituationTemplate 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 SituationAction entities.

    • fetchSituationTemplateText

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

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

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

    • getSituationTemplateTextOrFetch

      @Nonnull public List<SituationTemplateText> getSituationTemplateTextOrFetch()
      Retrieval of associated SituationTemplateText entities (one to many). This corresponds to the OData navigation property to_SituationTemplateText.

      If the navigation property to_SituationTemplateText of a queried SituationTemplate 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 SituationTemplateText 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.

    • getSituationTemplateTextIfPresent

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

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

    • setSituationTemplateText

      public void setSituationTemplateText(@Nonnull List<SituationTemplateText> value)
      Overwrites the list of associated SituationTemplateText entities for the loaded navigation property to_SituationTemplateText.

      If the navigation property to_SituationTemplateText of a queried SituationTemplate 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 SituationTemplateText entities.

    • addSituationTemplateText

      public void addSituationTemplateText(SituationTemplateText... entity)
      Adds elements to the list of associated SituationTemplateText entities. This corresponds to the OData navigation property to_SituationTemplateText.

      If the navigation property to_SituationTemplateText of a queried SituationTemplate 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 SituationTemplateText entities.

    • fetchSituationType

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

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

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

    • getSituationTypeOrFetch

      @Nonnull public List<SituationType> getSituationTypeOrFetch()
      Retrieval of associated SituationType entities (one to many). This corresponds to the OData navigation property to_SituationType.

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

    • getSituationTypeIfPresent

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

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

    • setSituationType

      public void setSituationType(@Nonnull List<SituationType> value)
      Overwrites the list of associated SituationType entities for the loaded navigation property to_SituationType.

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

    • addSituationType

      public void addSituationType(SituationType... entity)
      Adds elements to the list of associated SituationType entities. This corresponds to the OData navigation property to_SituationType.

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

    • builder

      @Nonnull public static SituationTemplate.SituationTemplateBuilder 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

    • getSitnDefDataContextIsEnabled

      @Nullable public Boolean getSitnDefDataContextIsEnabled()
      Constraints: none

      Original property name from the Odata EDM: SitnDefDataContextIsEnabled

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

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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