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

Class SalesOrderBillingPlan

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<SalesOrderBillingPlan>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesorder.SalesOrderBillingPlan
public class SalesOrderBillingPlan extends VdmEntity<SalesOrderBillingPlan>
Header Billing Plan

Original entity name from the Odata EDM: A_SalesOrderBillingPlanType

  • Field Details

    • ALL_FIELDS

      public static final SalesOrderBillingPlanSelectable ALL_FIELDS
      Selector for all available fields of SalesOrderBillingPlan.

    • SALES_ORDER

      public static final SalesOrderBillingPlanField<String> SALES_ORDER
      Use with available fluent helpers to apply the SalesOrder field to query operations.

    • BILLING_PLAN

      public static final SalesOrderBillingPlanField<String> BILLING_PLAN
      Use with available fluent helpers to apply the BillingPlan field to query operations.

    • BILLING_PLAN_START_DATE

      public static final SalesOrderBillingPlanField<LocalDateTime> BILLING_PLAN_START_DATE
      Use with available fluent helpers to apply the BillingPlanStartDate field to query operations.

    • BILLING_PLAN_START_DATE_RULE

      public static final SalesOrderBillingPlanField<String> BILLING_PLAN_START_DATE_RULE
      Use with available fluent helpers to apply the BillingPlanStartDateRule field to query operations.

    • REFERENCE_BILLING_PLAN

      public static final SalesOrderBillingPlanField<String> REFERENCE_BILLING_PLAN
      Use with available fluent helpers to apply the ReferenceBillingPlan field to query operations.

    • BILLING_PLAN_CATEGORY

      public static final SalesOrderBillingPlanField<String> BILLING_PLAN_CATEGORY
      Use with available fluent helpers to apply the BillingPlanCategory field to query operations.

    • BILLING_PLAN_TYPE

      public static final SalesOrderBillingPlanField<String> BILLING_PLAN_TYPE
      Use with available fluent helpers to apply the BillingPlanType field to query operations.

    • BILLING_PLAN_END_DATE

      public static final SalesOrderBillingPlanField<LocalDateTime> BILLING_PLAN_END_DATE
      Use with available fluent helpers to apply the BillingPlanEndDate field to query operations.

    • BILLING_PLAN_END_DATE_RULE

      public static final SalesOrderBillingPlanField<String> BILLING_PLAN_END_DATE_RULE
      Use with available fluent helpers to apply the BillingPlanEndDateRule field to query operations.

    • BILLING_PLAN_SEARCH_TERM

      public static final SalesOrderBillingPlanField<String> BILLING_PLAN_SEARCH_TERM
      Use with available fluent helpers to apply the BillingPlanSearchTerm field to query operations.

    • TO_BILLING_PLAN_ITEM

      public static final SalesOrderBillingPlanLink<SalesOrderBillingPlanItem> TO_BILLING_PLAN_ITEM
      Use with available fluent helpers to apply the to_BillingPlanItem navigation property to query operations.

    • TO_SALES_ORDER

      public static final SalesOrderBillingPlanOneToOneLink<SalesOrder> TO_SALES_ORDER
      Use with available fluent helpers to apply the to_SalesOrder navigation property to query operations.

  • Constructor Details

    • SalesOrderBillingPlan

      public SalesOrderBillingPlan()

    • SalesOrderBillingPlan

      public SalesOrderBillingPlan(@Nullable String salesOrder, @Nullable String billingPlan, @Nullable LocalDateTime billingPlanStartDate, @Nullable String billingPlanStartDateRule, @Nullable String referenceBillingPlan, @Nullable String billingPlanCategory, @Nullable String billingPlanType, @Nullable LocalDateTime billingPlanEndDate, @Nullable String billingPlanEndDateRule, @Nullable String billingPlanSearchTerm, List<SalesOrderBillingPlanItem> toBillingPlanItem, @Nullable SalesOrder toSalesOrder)

  • Method Details

    • getType

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

    • setSalesOrder

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

      Original property name from the Odata EDM: SalesOrder

      Parameters:
      salesOrder - Sales Order

    • setBillingPlan

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

      Original property name from the Odata EDM: BillingPlan

      Parameters:
      billingPlan - Billing Plan Number / Invoicing Plan Number

    • setBillingPlanStartDate

      public void setBillingPlanStartDate(@Nullable LocalDateTime billingPlanStartDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: BillingPlanStartDate

      Parameters:
      billingPlanStartDate - Start Date for Billing Plan/Invoice Plan

    • setBillingPlanStartDateRule

      public void setBillingPlanStartDateRule(@Nullable String billingPlanStartDateRule)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: BillingPlanStartDateRule

      Parameters:
      billingPlanStartDateRule - Rule for Origin of Start Date of Billing/Invoicing Plan

    • setReferenceBillingPlan

      public void setReferenceBillingPlan(@Nullable String referenceBillingPlan)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: ReferenceBillingPlan

      Parameters:
      referenceBillingPlan - Reference Billing Plan Number / Invoicing Plan Number

    • setBillingPlanCategory

      public void setBillingPlanCategory(@Nullable String billingPlanCategory)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: BillingPlanCategory

      Parameters:
      billingPlanCategory - Billing plan category

    • setBillingPlanType

      public void setBillingPlanType(@Nullable String billingPlanType)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: BillingPlanType

      Parameters:
      billingPlanType - Billing/Invoicing Plan Type

    • setBillingPlanEndDate

      public void setBillingPlanEndDate(@Nullable LocalDateTime billingPlanEndDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: BillingPlanEndDate

      Parameters:
      billingPlanEndDate - End Date Billing Plan/Invoice Plan

    • setBillingPlanEndDateRule

      public void setBillingPlanEndDateRule(@Nullable String billingPlanEndDateRule)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: BillingPlanEndDateRule

      Parameters:
      billingPlanEndDateRule - Rule for Origin of End Date for Billing/Invoicing Plan

    • setBillingPlanSearchTerm

      public void setBillingPlanSearchTerm(@Nullable String billingPlanSearchTerm)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: BillingPlanSearchTerm

      Parameters:
      billingPlanSearchTerm - Sort Field

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> SalesOrderBillingPlanField<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> SalesOrderBillingPlanField<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<SalesOrderBillingPlan>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchBillingPlanItem

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

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

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

    • getBillingPlanItemOrFetch

      @Nonnull public List<SalesOrderBillingPlanItem> getBillingPlanItemOrFetch()
      Retrieval of associated SalesOrderBillingPlanItem entities (one to many). This corresponds to the OData navigation property to_BillingPlanItem.

      If the navigation property to_BillingPlanItem of a queried SalesOrderBillingPlan 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 SalesOrderBillingPlanItem 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.

    • getBillingPlanItemIfPresent

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

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

    • setBillingPlanItem

      public void setBillingPlanItem(@Nonnull List<SalesOrderBillingPlanItem> value)
      Overwrites the list of associated SalesOrderBillingPlanItem entities for the loaded navigation property to_BillingPlanItem.

      If the navigation property to_BillingPlanItem of a queried SalesOrderBillingPlan 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 SalesOrderBillingPlanItem entities.

    • addBillingPlanItem

      public void addBillingPlanItem(SalesOrderBillingPlanItem... entity)
      Adds elements to the list of associated SalesOrderBillingPlanItem entities. This corresponds to the OData navigation property to_BillingPlanItem.

      If the navigation property to_BillingPlanItem of a queried SalesOrderBillingPlan 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 SalesOrderBillingPlanItem entities.

    • fetchSalesOrder

      @Nullable public SalesOrder fetchSalesOrder()
      Fetches the SalesOrder entity (one to one) associated with this entity. This corresponds to the OData navigation property to_SalesOrder.

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

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

    • getSalesOrderOrFetch

      @Nullable public SalesOrder getSalesOrderOrFetch()
      Retrieval of associated SalesOrder entity (one to one). This corresponds to the OData navigation property to_SalesOrder.

      If the navigation property to_SalesOrder of a queried SalesOrderBillingPlan 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 SalesOrder 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.

    • getSalesOrderIfPresent

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

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

    • setSalesOrder

      public void setSalesOrder(SalesOrder value)
      Overwrites the associated SalesOrder entity for the loaded navigation property to_SalesOrder.
      Parameters:
      value - New SalesOrder entity.

    • builder

      @Nonnull public static SalesOrderBillingPlan.SalesOrderBillingPlanBuilder builder()

    • getSalesOrder

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

      Original property name from the Odata EDM: SalesOrder

      Returns:
      Sales Order

    • getBillingPlan

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

      Original property name from the Odata EDM: BillingPlan

      Returns:
      Billing Plan Number / Invoicing Plan Number

    • getBillingPlanStartDate

      @Nullable public LocalDateTime getBillingPlanStartDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: BillingPlanStartDate

      Returns:
      Start Date for Billing Plan/Invoice Plan

    • getBillingPlanStartDateRule

      @Nullable public String getBillingPlanStartDateRule()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: BillingPlanStartDateRule

      Returns:
      Rule for Origin of Start Date of Billing/Invoicing Plan

    • getReferenceBillingPlan

      @Nullable public String getReferenceBillingPlan()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: ReferenceBillingPlan

      Returns:
      Reference Billing Plan Number / Invoicing Plan Number

    • getBillingPlanCategory

      @Nullable public String getBillingPlanCategory()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: BillingPlanCategory

      Returns:
      Billing plan category

    • getBillingPlanType

      @Nullable public String getBillingPlanType()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: BillingPlanType

      Returns:
      Billing/Invoicing Plan Type

    • getBillingPlanEndDate

      @Nullable public LocalDateTime getBillingPlanEndDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: BillingPlanEndDate

      Returns:
      End Date Billing Plan/Invoice Plan

    • getBillingPlanEndDateRule

      @Nullable public String getBillingPlanEndDateRule()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: BillingPlanEndDateRule

      Returns:
      Rule for Origin of End Date for Billing/Invoicing Plan

    • getBillingPlanSearchTerm

      @Nullable public String getBillingPlanSearchTerm()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: BillingPlanSearchTerm

      Returns:
      Sort Field

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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