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

Class SalesOrderHeaderPartner

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

Original entity name from the Odata EDM: A_SalesOrderHeaderPartnerType

  • Field Details

  • Constructor Details

    • SalesOrderHeaderPartner

      public SalesOrderHeaderPartner()

    • SalesOrderHeaderPartner

      public SalesOrderHeaderPartner(@Nullable String salesOrder, @Nullable String partnerFunction, @Nullable String customer, @Nullable String supplier, @Nullable String personnel, @Nullable String contactPerson, @Nullable String addressID, @Nullable String vATRegistration, List<SalesOrderPartnerAddress> toAddress, @Nullable SalesOrder toSalesOrder)

  • Method Details

    • getType

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

    • 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

    • setPartnerFunction

      public void setPartnerFunction(@Nullable String partnerFunction)
      (Key Field) Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: PartnerFunction

      Parameters:
      partnerFunction - Partner Function

    • setCustomer

      public void setCustomer(@Nullable String customer)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: Customer

      Parameters:
      customer - Customer Number

    • setSupplier

      public void setSupplier(@Nullable String supplier)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: Supplier

      Parameters:
      supplier - Account Number of Supplier

    • setPersonnel

      public void setPersonnel(@Nullable String personnel)
      Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: Personnel

      Parameters:
      personnel - Personnel Number

    • setContactPerson

      public void setContactPerson(@Nullable String contactPerson)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: ContactPerson

      Parameters:
      contactPerson - Number of Contact Person

    • setAddressID

      public void setAddressID(@Nullable String addressID)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: AddressID

      Parameters:
      addressID - Address Number

    • setVATRegistration

      public void setVATRegistration(@Nullable String vATRegistration)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: VATRegistration

      Parameters:
      vATRegistration - VAT Registration Number

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> SalesOrderHeaderPartnerField<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> SalesOrderHeaderPartnerField<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<SalesOrderHeaderPartner>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchAddress

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

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

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

    • getAddressOrFetch

      @Nonnull public List<SalesOrderPartnerAddress> getAddressOrFetch()
      Retrieval of associated SalesOrderPartnerAddress entities (one to many). This corresponds to the OData navigation property to_Address.

      If the navigation property to_Address of a queried SalesOrderHeaderPartner 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 SalesOrderPartnerAddress 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.

    • getAddressIfPresent

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

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

    • setAddress

      public void setAddress(@Nonnull List<SalesOrderPartnerAddress> value)
      Overwrites the list of associated SalesOrderPartnerAddress entities for the loaded navigation property to_Address.

      If the navigation property to_Address of a queried SalesOrderHeaderPartner 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 SalesOrderPartnerAddress entities.

    • addAddress

      public void addAddress(SalesOrderPartnerAddress... entity)
      Adds elements to the list of associated SalesOrderPartnerAddress entities. This corresponds to the OData navigation property to_Address.

      If the navigation property to_Address of a queried SalesOrderHeaderPartner 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 SalesOrderPartnerAddress 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 SalesOrderHeaderPartner 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 SalesOrderHeaderPartner 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 SalesOrderHeaderPartner.SalesOrderHeaderPartnerBuilder 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

    • getPartnerFunction

      @Nullable public String getPartnerFunction()
      (Key Field) Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: PartnerFunction

      Returns:
      Partner Function

    • getCustomer

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

      Original property name from the Odata EDM: Customer

      Returns:
      Customer Number

    • getSupplier

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

      Original property name from the Odata EDM: Supplier

      Returns:
      Account Number of Supplier

    • getPersonnel

      @Nullable public String getPersonnel()
      Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: Personnel

      Returns:
      Personnel Number

    • getContactPerson

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

      Original property name from the Odata EDM: ContactPerson

      Returns:
      Number of Contact Person

    • getAddressID

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

      Original property name from the Odata EDM: AddressID

      Returns:
      Address Number

    • getVATRegistration

      @Nullable public String getVATRegistration()
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: VATRegistration

      Returns:
      VAT Registration Number

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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