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

Class WhseDeliveryDocumentAddress

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<WhseDeliveryDocumentAddress>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseoutbounddeliveryorder.WhseDeliveryDocumentAddress
public class WhseDeliveryDocumentAddress extends VdmEntity<WhseDeliveryDocumentAddress>
Warehouse Delivery Document Address

Original entity name from the Odata EDM: WhseDeliveryDocumentAddressType

  • Field Details

  • Constructor Details

    • WhseDeliveryDocumentAddress

      public WhseDeliveryDocumentAddress()

    • WhseDeliveryDocumentAddress

      public WhseDeliveryDocumentAddress(@Nullable String outboundDeliveryOrder, @Nullable String outboundDeliveryOrderItem, @Nullable String businessPartnerRole, @Nullable String businessPartnerName1, @Nullable String businessPartnerName2, @Nullable String streetPrefixName, @Nullable String additionalStreetPrefixName, @Nullable String streetName, @Nullable String streetSuffixName, @Nullable String additionalStreetSuffixName, @Nullable String houseNumber, @Nullable String postalCode, @Nullable String cityName, @Nullable String region, @Nullable String country, @Nullable String phoneNumber, @Nullable String emailAddress, @Nullable String isBusinessPurposeCompleted, @Nullable WhseOutboundDeliveryOrderHead toWhseOutboundDeliveryOrderHead, @Nullable WhseOutboundDeliveryOrderItem toWhseOutboundDeliveryOrderItem)

  • Method Details

    • getType

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

    • setOutboundDeliveryOrder

      public void setOutboundDeliveryOrder(@Nullable String outboundDeliveryOrder)
      (Key Field) Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: OutboundDeliveryOrder

      Parameters:
      outboundDeliveryOrder - Document Number

    • setOutboundDeliveryOrderItem

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

      Original property name from the Odata EDM: OutboundDeliveryOrderItem

      Parameters:
      outboundDeliveryOrderItem - Item Number

    • setBusinessPartnerRole

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

      Original property name from the Odata EDM: BusinessPartnerRole

      Parameters:
      businessPartnerRole - Partner Role

    • setBusinessPartnerName1

      public void setBusinessPartnerName1(@Nullable String businessPartnerName1)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: BusinessPartnerName1

      Parameters:
      businessPartnerName1 - Name 1

    • setBusinessPartnerName2

      public void setBusinessPartnerName2(@Nullable String businessPartnerName2)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: BusinessPartnerName2

      Parameters:
      businessPartnerName2 - Name 2

    • setStreetPrefixName

      public void setStreetPrefixName(@Nullable String streetPrefixName)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: StreetPrefixName

      Parameters:
      streetPrefixName - Street 2

    • setAdditionalStreetPrefixName

      public void setAdditionalStreetPrefixName(@Nullable String additionalStreetPrefixName)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: AdditionalStreetPrefixName

      Parameters:
      additionalStreetPrefixName - Street 3

    • setStreetName

      public void setStreetName(@Nullable String streetName)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: StreetName

      Parameters:
      streetName - Street

    • setStreetSuffixName

      public void setStreetSuffixName(@Nullable String streetSuffixName)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: StreetSuffixName

      Parameters:
      streetSuffixName - Street 4

    • setAdditionalStreetSuffixName

      public void setAdditionalStreetSuffixName(@Nullable String additionalStreetSuffixName)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: AdditionalStreetSuffixName

      Parameters:
      additionalStreetSuffixName - Street 5

    • setHouseNumber

      public void setHouseNumber(@Nullable String houseNumber)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: HouseNumber

      Parameters:
      houseNumber - House Number

    • setPostalCode

      public void setPostalCode(@Nullable String postalCode)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: PostalCode

      Parameters:
      postalCode - City Postal Code

    • setCityName

      public void setCityName(@Nullable String cityName)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: CityName

      Parameters:
      cityName - City

    • setRegion

      public void setRegion(@Nullable String region)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: Region

      Parameters:
      region - Region (State, Province, County)

    • setCountry

      public void setCountry(@Nullable String country)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: Country

      Parameters:
      country - Country/Region Key

    • setPhoneNumber

      public void setPhoneNumber(@Nullable String phoneNumber)
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: PhoneNumber

      Parameters:
      phoneNumber - First Telephone No.: Dialing Code + Number

    • setEmailAddress

      public void setEmailAddress(@Nullable String emailAddress)
      Constraints: Not nullable, Maximum length: 241

      Original property name from the Odata EDM: EmailAddress

      Parameters:
      emailAddress - Email Address

    • setIsBusinessPurposeCompleted

      public void setIsBusinessPurposeCompleted(@Nullable String isBusinessPurposeCompleted)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: IsBusinessPurposeCompleted

      Parameters:
      isBusinessPurposeCompleted - Business Purpose Completed Flag

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> WhseDeliveryDocumentAddressField<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> WhseDeliveryDocumentAddressField<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<WhseDeliveryDocumentAddress>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchWhseOutboundDeliveryOrderHead

      @Nullable public WhseOutboundDeliveryOrderHead fetchWhseOutboundDeliveryOrderHead()
      Fetches the WhseOutboundDeliveryOrderHead entity (one to one) associated with this entity. This corresponds to the OData navigation property to_WhseOutboundDeliveryOrderHead.

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

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

    • getWhseOutboundDeliveryOrderHeadOrFetch

      @Nullable public WhseOutboundDeliveryOrderHead getWhseOutboundDeliveryOrderHeadOrFetch()
      Retrieval of associated WhseOutboundDeliveryOrderHead entity (one to one). This corresponds to the OData navigation property to_WhseOutboundDeliveryOrderHead.

      If the navigation property to_WhseOutboundDeliveryOrderHead of a queried WhseDeliveryDocumentAddress 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 WhseOutboundDeliveryOrderHead 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.

    • getWhseOutboundDeliveryOrderHeadIfPresent

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

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

    • setWhseOutboundDeliveryOrderHead

      public void setWhseOutboundDeliveryOrderHead(WhseOutboundDeliveryOrderHead value)
      Overwrites the associated WhseOutboundDeliveryOrderHead entity for the loaded navigation property to_WhseOutboundDeliveryOrderHead.
      Parameters:
      value - New WhseOutboundDeliveryOrderHead entity.

    • fetchWhseOutboundDeliveryOrderItem

      @Nullable public WhseOutboundDeliveryOrderItem fetchWhseOutboundDeliveryOrderItem()
      Fetches the WhseOutboundDeliveryOrderItem entity (one to one) associated with this entity. This corresponds to the OData navigation property to_WhseOutboundDeliveryOrderItem.

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

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

    • getWhseOutboundDeliveryOrderItemOrFetch

      @Nullable public WhseOutboundDeliveryOrderItem getWhseOutboundDeliveryOrderItemOrFetch()
      Retrieval of associated WhseOutboundDeliveryOrderItem entity (one to one). This corresponds to the OData navigation property to_WhseOutboundDeliveryOrderItem.

      If the navigation property to_WhseOutboundDeliveryOrderItem of a queried WhseDeliveryDocumentAddress 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 WhseOutboundDeliveryOrderItem 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.

    • getWhseOutboundDeliveryOrderItemIfPresent

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

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

    • setWhseOutboundDeliveryOrderItem

      public void setWhseOutboundDeliveryOrderItem(WhseOutboundDeliveryOrderItem value)
      Overwrites the associated WhseOutboundDeliveryOrderItem entity for the loaded navigation property to_WhseOutboundDeliveryOrderItem.
      Parameters:
      value - New WhseOutboundDeliveryOrderItem entity.

    • builder

      @Nonnull public static WhseDeliveryDocumentAddress.WhseDeliveryDocumentAddressBuilder builder()

    • getOutboundDeliveryOrder

      @Nullable public String getOutboundDeliveryOrder()
      (Key Field) Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: OutboundDeliveryOrder

      Returns:
      Document Number

    • getOutboundDeliveryOrderItem

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

      Original property name from the Odata EDM: OutboundDeliveryOrderItem

      Returns:
      Item Number

    • getBusinessPartnerRole

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

      Original property name from the Odata EDM: BusinessPartnerRole

      Returns:
      Partner Role

    • getBusinessPartnerName1

      @Nullable public String getBusinessPartnerName1()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: BusinessPartnerName1

      Returns:
      Name 1

    • getBusinessPartnerName2

      @Nullable public String getBusinessPartnerName2()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: BusinessPartnerName2

      Returns:
      Name 2

    • getStreetPrefixName

      @Nullable public String getStreetPrefixName()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: StreetPrefixName

      Returns:
      Street 2

    • getAdditionalStreetPrefixName

      @Nullable public String getAdditionalStreetPrefixName()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: AdditionalStreetPrefixName

      Returns:
      Street 3

    • getStreetName

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

      Original property name from the Odata EDM: StreetName

      Returns:
      Street

    • getStreetSuffixName

      @Nullable public String getStreetSuffixName()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: StreetSuffixName

      Returns:
      Street 4

    • getAdditionalStreetSuffixName

      @Nullable public String getAdditionalStreetSuffixName()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: AdditionalStreetSuffixName

      Returns:
      Street 5

    • getHouseNumber

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

      Original property name from the Odata EDM: HouseNumber

      Returns:
      House Number

    • getPostalCode

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

      Original property name from the Odata EDM: PostalCode

      Returns:
      City Postal Code

    • getCityName

      @Nullable public String getCityName()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: CityName

      Returns:
      City

    • getRegion

      @Nullable public String getRegion()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: Region

      Returns:
      Region (State, Province, County)

    • getCountry

      @Nullable public String getCountry()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: Country

      Returns:
      Country/Region Key

    • getPhoneNumber

      @Nullable public String getPhoneNumber()
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: PhoneNumber

      Returns:
      First Telephone No.: Dialing Code + Number

    • getEmailAddress

      @Nullable public String getEmailAddress()
      Constraints: Not nullable, Maximum length: 241

      Original property name from the Odata EDM: EmailAddress

      Returns:
      Email Address

    • getIsBusinessPurposeCompleted

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

      Original property name from the Odata EDM: IsBusinessPurposeCompleted

      Returns:
      Business Purpose Completed Flag

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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