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

Class BusSolnOrdItmRateElement

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<BusSolnOrdItmRateElement>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssolutionorder.BusSolnOrdItmRateElement
public class BusSolnOrdItmRateElement extends VdmEntity<BusSolnOrdItmRateElement>
Subscription Billing Item Rate Elements

Original entity name from the Odata EDM: A_BusSolnOrdItmRateElementType

  • Field Details

    • ALL_FIELDS

      public static final BusSolnOrdItmRateElementSelectable ALL_FIELDS
      Selector for all available fields of BusSolnOrdItmRateElement.

    • BUSINESS_SOLUTION_ORDER

      public static final BusSolnOrdItmRateElementField<String> BUSINESS_SOLUTION_ORDER
      Use with available fluent helpers to apply the BusinessSolutionOrder field to query operations.

    • BUSINESS_SOLUTION_ORDER_ITEM

      public static final BusSolnOrdItmRateElementField<String> BUSINESS_SOLUTION_ORDER_ITEM
      Use with available fluent helpers to apply the BusinessSolutionOrderItem field to query operations.

    • SUBSCRIPTION_RATE_ELEMENT

      public static final BusSolnOrdItmRateElementField<String> SUBSCRIPTION_RATE_ELEMENT
      Use with available fluent helpers to apply the SubscriptionRateElement field to query operations.

    • SUBSCRIPTION_RATE_ELEMENT_TYPE

      public static final BusSolnOrdItmRateElementField<String> SUBSCRIPTION_RATE_ELEMENT_TYPE
      Use with available fluent helpers to apply the SubscriptionRateElementType field to query operations.

    • SUBSCRPN_RATE_ELEMENT_TYPE_TEXT

      public static final BusSolnOrdItmRateElementField<String> SUBSCRPN_RATE_ELEMENT_TYPE_TEXT
      Use with available fluent helpers to apply the SubscrpnRateElementTypeText field to query operations.

    • SUBSCRPN_RATE_ELEMENT_NET_AMOUNT

      public static final BusSolnOrdItmRateElementField<BigDecimal> SUBSCRPN_RATE_ELEMENT_NET_AMOUNT
      Use with available fluent helpers to apply the SubscrpnRateElementNetAmount field to query operations.

    • SUBSCRPN_RATE_ELEMENT_GROSS_AMOUNT

      public static final BusSolnOrdItmRateElementField<BigDecimal> SUBSCRPN_RATE_ELEMENT_GROSS_AMOUNT
      Use with available fluent helpers to apply the SubscrpnRateElementGrossAmount field to query operations.

    • SUBSCRPN_RATE_ELEMENT_TAX_AMOUNT

      public static final BusSolnOrdItmRateElementField<BigDecimal> SUBSCRPN_RATE_ELEMENT_TAX_AMOUNT
      Use with available fluent helpers to apply the SubscrpnRateElementTaxAmount field to query operations.

    • CURRENCY

      public static final BusSolnOrdItmRateElementField<String> CURRENCY
      Use with available fluent helpers to apply the Currency field to query operations.

    • TO_BUSINESS_SOLUTION_ORDER

      public static final BusSolnOrdItmRateElementOneToOneLink<BusinessSolutionOrder> TO_BUSINESS_SOLUTION_ORDER
      Use with available fluent helpers to apply the to_BusinessSolutionOrder navigation property to query operations.

    • TO_SUBSCRIPTION_BILLING_ITEM

      public static final BusSolnOrdItmRateElementOneToOneLink<BusSolnOrdSubscrpnBillgItem> TO_SUBSCRIPTION_BILLING_ITEM
      Use with available fluent helpers to apply the to_SubscriptionBillingItem navigation property to query operations.

    • TO_SUBSCRIPTION_RATE_ELM_PRICE_ELM

      public static final BusSolnOrdItmRateElementLink<BusSolnOrdItmRateElmntPrcElm> TO_SUBSCRIPTION_RATE_ELM_PRICE_ELM
      Use with available fluent helpers to apply the to_SubscriptionRateElmPriceElm navigation property to query operations.

  • Constructor Details

  • Method Details

    • getType

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

    • setBusinessSolutionOrder

      public void setBusinessSolutionOrder(@Nullable String businessSolutionOrder)
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: BusinessSolutionOrder

      Parameters:
      businessSolutionOrder - Transaction ID

    • setBusinessSolutionOrderItem

      public void setBusinessSolutionOrderItem(@Nullable String businessSolutionOrderItem)
      (Key Field) Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: BusinessSolutionOrderItem

      Parameters:
      businessSolutionOrderItem - Shortened Item Number in Document

    • setSubscriptionRateElement

      public void setSubscriptionRateElement(@Nullable String subscriptionRateElement)
      (Key Field) Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: SubscriptionRateElement

      Parameters:
      subscriptionRateElement - Product Number

    • setSubscriptionRateElementType

      public void setSubscriptionRateElementType(@Nullable String subscriptionRateElementType)
      (Key Field) Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: SubscriptionRateElementType

      Parameters:
      subscriptionRateElementType - Rate Type

    • setSubscrpnRateElementTypeText

      public void setSubscrpnRateElementTypeText(@Nullable String subscrpnRateElementTypeText)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: SubscrpnRateElementTypeText

      Parameters:
      subscrpnRateElementTypeText - Short Text for Fixed Values

    • setSubscrpnRateElementNetAmount

      public void setSubscrpnRateElementNetAmount(@Nullable BigDecimal subscrpnRateElementNetAmount)
      Constraints: Not nullable, Precision: 16, Scale: 3

      Original property name from the Odata EDM: SubscrpnRateElementNetAmount

      Parameters:
      subscrpnRateElementNetAmount - Net Value

    • setSubscrpnRateElementGrossAmount

      public void setSubscrpnRateElementGrossAmount(@Nullable BigDecimal subscrpnRateElementGrossAmount)
      Constraints: Not nullable, Precision: 16, Scale: 3

      Original property name from the Odata EDM: SubscrpnRateElementGrossAmount

      Parameters:
      subscrpnRateElementGrossAmount - Gross Order Value in PO Currency

    • setSubscrpnRateElementTaxAmount

      public void setSubscrpnRateElementTaxAmount(@Nullable BigDecimal subscrpnRateElementTaxAmount)
      Constraints: Not nullable, Precision: 16, Scale: 3

      Original property name from the Odata EDM: SubscrpnRateElementTaxAmount

      Parameters:
      subscrpnRateElementTaxAmount - Tax amount in document currency

    • setCurrency

      public void setCurrency(@Nullable String currency)
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: Currency

      Parameters:
      currency - Currency

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> BusSolnOrdItmRateElementField<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> BusSolnOrdItmRateElementField<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<BusSolnOrdItmRateElement>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchBusinessSolutionOrder

      @Nullable public BusinessSolutionOrder fetchBusinessSolutionOrder()
      Fetches the BusinessSolutionOrder entity (one to one) associated with this entity. This corresponds to the OData navigation property to_BusinessSolutionOrder.

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

      Returns:
      The single associated BusinessSolutionOrder 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.

    • getBusinessSolutionOrderOrFetch

      @Nullable public BusinessSolutionOrder getBusinessSolutionOrderOrFetch()
      Retrieval of associated BusinessSolutionOrder entity (one to one). This corresponds to the OData navigation property to_BusinessSolutionOrder.

      If the navigation property to_BusinessSolutionOrder of a queried BusSolnOrdItmRateElement 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 BusinessSolutionOrder 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.

    • getBusinessSolutionOrderIfPresent

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

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

    • setBusinessSolutionOrder

      public void setBusinessSolutionOrder(BusinessSolutionOrder value)
      Overwrites the associated BusinessSolutionOrder entity for the loaded navigation property to_BusinessSolutionOrder.
      Parameters:
      value - New BusinessSolutionOrder entity.

    • fetchSubscriptionBillingItem

      @Nullable public BusSolnOrdSubscrpnBillgItem fetchSubscriptionBillingItem()
      Fetches the BusSolnOrdSubscrpnBillgItem entity (one to one) associated with this entity. This corresponds to the OData navigation property to_SubscriptionBillingItem.

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

      Returns:
      The single associated BusSolnOrdSubscrpnBillgItem 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.

    • getSubscriptionBillingItemOrFetch

      @Nullable public BusSolnOrdSubscrpnBillgItem getSubscriptionBillingItemOrFetch()
      Retrieval of associated BusSolnOrdSubscrpnBillgItem entity (one to one). This corresponds to the OData navigation property to_SubscriptionBillingItem.

      If the navigation property to_SubscriptionBillingItem of a queried BusSolnOrdItmRateElement 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 BusSolnOrdSubscrpnBillgItem 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.

    • getSubscriptionBillingItemIfPresent

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

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

    • setSubscriptionBillingItem

      public void setSubscriptionBillingItem(BusSolnOrdSubscrpnBillgItem value)
      Overwrites the associated BusSolnOrdSubscrpnBillgItem entity for the loaded navigation property to_SubscriptionBillingItem.
      Parameters:
      value - New BusSolnOrdSubscrpnBillgItem entity.

    • fetchSubscriptionRateElmPriceElm

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

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

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

    • getSubscriptionRateElmPriceElmOrFetch

      @Nonnull public List<BusSolnOrdItmRateElmntPrcElm> getSubscriptionRateElmPriceElmOrFetch()
      Retrieval of associated BusSolnOrdItmRateElmntPrcElm entities (one to many). This corresponds to the OData navigation property to_SubscriptionRateElmPriceElm.

      If the navigation property to_SubscriptionRateElmPriceElm of a queried BusSolnOrdItmRateElement 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 BusSolnOrdItmRateElmntPrcElm 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.

    • getSubscriptionRateElmPriceElmIfPresent

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

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

    • setSubscriptionRateElmPriceElm

      public void setSubscriptionRateElmPriceElm(@Nonnull List<BusSolnOrdItmRateElmntPrcElm> value)
      Overwrites the list of associated BusSolnOrdItmRateElmntPrcElm entities for the loaded navigation property to_SubscriptionRateElmPriceElm.

      If the navigation property to_SubscriptionRateElmPriceElm of a queried BusSolnOrdItmRateElement 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 BusSolnOrdItmRateElmntPrcElm entities.

    • addSubscriptionRateElmPriceElm

      public void addSubscriptionRateElmPriceElm(BusSolnOrdItmRateElmntPrcElm... entity)
      Adds elements to the list of associated BusSolnOrdItmRateElmntPrcElm entities. This corresponds to the OData navigation property to_SubscriptionRateElmPriceElm.

      If the navigation property to_SubscriptionRateElmPriceElm of a queried BusSolnOrdItmRateElement 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 BusSolnOrdItmRateElmntPrcElm entities.

    • builder

      @Nonnull public static BusSolnOrdItmRateElement.BusSolnOrdItmRateElementBuilder builder()

    • getBusinessSolutionOrder

      @Nullable public String getBusinessSolutionOrder()
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: BusinessSolutionOrder

      Returns:
      Transaction ID

    • getBusinessSolutionOrderItem

      @Nullable public String getBusinessSolutionOrderItem()
      (Key Field) Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: BusinessSolutionOrderItem

      Returns:
      Shortened Item Number in Document

    • getSubscriptionRateElement

      @Nullable public String getSubscriptionRateElement()
      (Key Field) Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: SubscriptionRateElement

      Returns:
      Product Number

    • getSubscriptionRateElementType

      @Nullable public String getSubscriptionRateElementType()
      (Key Field) Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: SubscriptionRateElementType

      Returns:
      Rate Type

    • getSubscrpnRateElementTypeText

      @Nullable public String getSubscrpnRateElementTypeText()
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: SubscrpnRateElementTypeText

      Returns:
      Short Text for Fixed Values

    • getSubscrpnRateElementNetAmount

      @Nullable public BigDecimal getSubscrpnRateElementNetAmount()
      Constraints: Not nullable, Precision: 16, Scale: 3

      Original property name from the Odata EDM: SubscrpnRateElementNetAmount

      Returns:
      Net Value

    • getSubscrpnRateElementGrossAmount

      @Nullable public BigDecimal getSubscrpnRateElementGrossAmount()
      Constraints: Not nullable, Precision: 16, Scale: 3

      Original property name from the Odata EDM: SubscrpnRateElementGrossAmount

      Returns:
      Gross Order Value in PO Currency

    • getSubscrpnRateElementTaxAmount

      @Nullable public BigDecimal getSubscrpnRateElementTaxAmount()
      Constraints: Not nullable, Precision: 16, Scale: 3

      Original property name from the Odata EDM: SubscrpnRateElementTaxAmount

      Returns:
      Tax amount in document currency

    • getCurrency

      @Nullable public String getCurrency()
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: Currency

      Returns:
      Currency

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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