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

Class SituationAction

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<SituationAction>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituationtypev2.SituationAction
public class SituationAction extends VdmEntity<SituationAction>
Situation Action

Original entity name from the Odata EDM: SituationActionType

  • Field Details

    • ALL_FIELDS

      public static final SituationActionSelectable ALL_FIELDS
      Selector for all available fields of SituationAction.

    • SITN_DEF_TEMPLATE_ID

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

    • SITN_ACTION_ID

      public static final SituationActionField<String> SITN_ACTION_ID
      Use with available fluent helpers to apply the SitnActionID field to query operations.

    • TO_SITUATION_ACTION_TEXT

      public static final SituationActionLink<SituationActionText> TO_SITUATION_ACTION_TEXT
      Use with available fluent helpers to apply the to_SituationActionText navigation property to query operations.

  • Constructor Details

    • SituationAction

      public SituationAction()

    • SituationAction

      public SituationAction(@Nullable String sitnDefTemplateID, @Nullable String sitnActionID, List<SituationActionText> toSituationActionText)

  • Method Details

    • getType

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

    • 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

    • setSitnActionID

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

      Original property name from the Odata EDM: SitnActionID

      Parameters:
      sitnActionID - Action ID

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> SituationActionField<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> SituationActionField<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<SituationAction>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchSituationActionText

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

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

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

    • getSituationActionTextOrFetch

      @Nonnull public List<SituationActionText> getSituationActionTextOrFetch()
      Retrieval of associated SituationActionText entities (one to many). This corresponds to the OData navigation property to_SituationActionText.

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

    • getSituationActionTextIfPresent

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

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

    • setSituationActionText

      public void setSituationActionText(@Nonnull List<SituationActionText> value)
      Overwrites the list of associated SituationActionText entities for the loaded navigation property to_SituationActionText.

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

    • addSituationActionText

      public void addSituationActionText(SituationActionText... entity)
      Adds elements to the list of associated SituationActionText entities. This corresponds to the OData navigation property to_SituationActionText.

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

    • builder

      @Nonnull public static SituationAction.SituationActionBuilder 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

    • getSitnActionID

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

      Original property name from the Odata EDM: SitnActionID

      Returns:
      Action ID

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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