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

Class ShipToParty

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<ShipToParty>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.masterdataforgroupreporting.ShipToParty
public class ShipToParty extends VdmEntity<ShipToParty>
Combined Ship to Party

Original entity name from the Odata EDM: ShipToPartyType

  • Field Details

    • ALL_FIELDS

      public static final ShipToPartySelectable ALL_FIELDS
      Selector for all available fields of ShipToParty.

    • CUSTOMER

      public static final ShipToPartyField<String> CUSTOMER
      Use with available fluent helpers to apply the Customer field to query operations.

    • CUSTOMER_TEXT

      public static final ShipToPartyField<String> CUSTOMER_TEXT
      Use with available fluent helpers to apply the Customer_Text field to query operations.

    • ADDITIONAL_MASTER_DATA_SOURCE

      public static final ShipToPartyField<String> ADDITIONAL_MASTER_DATA_SOURCE
      Use with available fluent helpers to apply the AdditionalMasterDataSource field to query operations.

    • TO_CNSLDTN_SHIP_TO_PARTY_T

      public static final ShipToPartyLink<ShipToPartyText> TO_CNSLDTN_SHIP_TO_PARTY_T
      Use with available fluent helpers to apply the to_CnsldtnShipToPartyT navigation property to query operations.

  • Constructor Details

    • ShipToParty

      public ShipToParty()

    • ShipToParty

      public ShipToParty(@Nullable String customer, @Nullable String customer_Text, @Nullable String additionalMasterDataSource, List<ShipToPartyText> toCnsldtnShipToPartyT)

  • Method Details

    • getType

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

    • setCustomer

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

      Original property name from the Odata EDM: Customer

      Parameters:
      customer - Consolidation Customer

    • setCustomer_Text

      public void setCustomer_Text(@Nullable String customer_Text)
      Constraints: Not nullable, Maximum length: 80

      Original property name from the Odata EDM: Customer_Text

      Parameters:
      customer_Text - Ship-To Party Description

    • setAdditionalMasterDataSource

      public void setAdditionalMasterDataSource(@Nullable String additionalMasterDataSource)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: AdditionalMasterDataSource

      Parameters:
      additionalMasterDataSource - Consolidation Additional Master Data Source

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> ShipToPartyField<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> ShipToPartyField<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<ShipToParty>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchCnsldtnShipToPartyT

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

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

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

    • getCnsldtnShipToPartyTOrFetch

      @Nonnull public List<ShipToPartyText> getCnsldtnShipToPartyTOrFetch()
      Retrieval of associated ShipToPartyText entities (one to many). This corresponds to the OData navigation property to_CnsldtnShipToPartyT.

      If the navigation property to_CnsldtnShipToPartyT of a queried ShipToParty 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 ShipToPartyText 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.

    • getCnsldtnShipToPartyTIfPresent

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

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

    • setCnsldtnShipToPartyT

      public void setCnsldtnShipToPartyT(@Nonnull List<ShipToPartyText> value)
      Overwrites the list of associated ShipToPartyText entities for the loaded navigation property to_CnsldtnShipToPartyT.

      If the navigation property to_CnsldtnShipToPartyT of a queried ShipToParty 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 ShipToPartyText entities.

    • addCnsldtnShipToPartyT

      public void addCnsldtnShipToPartyT(ShipToPartyText... entity)
      Adds elements to the list of associated ShipToPartyText entities. This corresponds to the OData navigation property to_CnsldtnShipToPartyT.

      If the navigation property to_CnsldtnShipToPartyT of a queried ShipToParty 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 ShipToPartyText entities.

    • builder

      @Nonnull public static ShipToParty.ShipToPartyBuilder builder()

    • getCustomer

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

      Original property name from the Odata EDM: Customer

      Returns:
      Consolidation Customer

    • getCustomer_Text

      @Nullable public String getCustomer_Text()
      Constraints: Not nullable, Maximum length: 80

      Original property name from the Odata EDM: Customer_Text

      Returns:
      Ship-To Party Description

    • getAdditionalMasterDataSource

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

      Original property name from the Odata EDM: AdditionalMasterDataSource

      Returns:
      Consolidation Additional Master Data Source

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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