Package com.sap.cloud.sdk.s4hana.datamodel.odatav4.services

Interface LocationService

All Known Implementing Classes:
DefaultLocationService
@Deprecated public interface LocationService
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

The service enables you to create, read, update, and delete locations through an API call. You can perform these activities from a source system outside SAP S/4HANA Cloud. The service is based on the OData protocol..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: CE_MANAGELOCATION_0001
API Version: 1.0.0
Minimum ERP Version: 2302
Communication Scenario: Location Integration(SAP_COM_0425)
Scope Items: Order-Based Transportation Consolidation – Outbound(3EP), Order-Based Transportation Consolidation - Inbound(5VV), Stock Transport Order-Based Transportation Consolidation(5XC)
Authentication Methods: x509
Service Group Name: API_MANAGELOCATION
Business Object: Location

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull LocationService withServicePath(@Nonnull String servicePath)
      Deprecated.
      Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.
      Parameters:
      servicePath - Service path that will override the default.
      Returns:
      A new service instance with the specified service path.

    • batch

      @Nonnull BatchRequestBuilder batch()
      Deprecated.
      Creates a batch request builder object.
      Returns:
      A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

    • getAllLocation

      @Nonnull GetAllRequestBuilder<Location> getAllLocation()
      Deprecated.
      Fetch multiple Location entities.
      Returns:
      A request builder to fetch multiple Location entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

    • countLocation

      @Nonnull CountRequestBuilder<Location> countLocation()
      Deprecated.
      Fetch the number of entries from the Location entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of Location entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

    • getLocationByKey

      @Nonnull GetByKeyRequestBuilder<Location> getLocationByKey(UUID locationUUID)
      Deprecated.
      Fetch a single Location entity using key fields.
      Parameters:
      locationUUID - Internal Location Number (Customer, Supplier, or Plant)

      Constraints: Not nullable

      Returns:
      A request builder to fetch a single Location entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

    • createLocation

      @Nonnull CreateRequestBuilder<Location> createLocation(@Nonnull Location location)
      Deprecated.
      Create a new Location entity and save it to the S/4HANA system.
      Parameters:
      location - Location entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new Location entity. To perform execution, call the execute method on the request builder object.

    • updateLocation

      @Nonnull UpdateRequestBuilder<Location> updateLocation(@Nonnull Location location)
      Deprecated.
      Update an existing Location entity and save it to the S/4HANA system.
      Parameters:
      location - Location entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing Location entity. To perform execution, call the execute method on the request builder object.

    • deleteLocation

      @Nonnull DeleteRequestBuilder<Location> deleteLocation(@Nonnull Location location)
      Deprecated.
      Deletes an existing Location entity in the S/4HANA system.
      Parameters:
      location - Location entity object that will be deleted in the S/4HANA system.
      Returns:
      A request builder to delete an existing Location entity. To perform execution, call the execute method on the request builder object.

    • getAllLocationAddress

      @Nonnull GetAllRequestBuilder<LocationAddress> getAllLocationAddress()
      Deprecated.
      Fetch multiple LocationAddress entities.
      Returns:
      A request builder to fetch multiple LocationAddress entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

    • countLocationAddress

      @Nonnull CountRequestBuilder<LocationAddress> countLocationAddress()
      Deprecated.
      Fetch the number of entries from the LocationAddress entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of LocationAddress entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

    • getLocationAddressByKey

      @Nonnull GetByKeyRequestBuilder<LocationAddress> getLocationAddressByKey(UUID locationUUID, String addressPersonID, String addressRepresentationCode)
      Deprecated.
      Fetch a single LocationAddress entity using key fields.
      Parameters:
      addressRepresentationCode - Version ID for International Addresses

      Constraints: Not nullable, Maximum length: 1

      locationUUID - Internal Location Number (Customer, Supplier, or Plant)

      Constraints: Not nullable

      addressPersonID - Person Number

      Constraints: Not nullable, Maximum length: 10

      Returns:
      A request builder to fetch a single LocationAddress entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

    • updateLocationAddress

      @Nonnull UpdateRequestBuilder<LocationAddress> updateLocationAddress(@Nonnull LocationAddress locationAddress)
      Deprecated.
      Update an existing LocationAddress entity and save it to the S/4HANA system.
      Parameters:
      locationAddress - LocationAddress entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing LocationAddress entity. To perform execution, call the execute method on the request builder object.

    • getAllLocationText

      @Nonnull GetAllRequestBuilder<LocationText> getAllLocationText()
      Deprecated.
      Fetch multiple LocationText entities.
      Returns:
      A request builder to fetch multiple LocationText entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

    • countLocationText

      @Nonnull CountRequestBuilder<LocationText> countLocationText()
      Deprecated.
      Fetch the number of entries from the LocationText entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of LocationText entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

    • getLocationTextByKey

      @Nonnull GetByKeyRequestBuilder<LocationText> getLocationTextByKey(UUID locationUUID, String language)
      Deprecated.
      Fetch a single LocationText entity using key fields.
      Parameters:
      locationUUID - Internal Location Number (Customer, Supplier, or Plant)

      Constraints: Not nullable

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      Returns:
      A request builder to fetch a single LocationText entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

    • updateLocationText

      @Nonnull UpdateRequestBuilder<LocationText> updateLocationText(@Nonnull LocationText locationText)
      Deprecated.
      Update an existing LocationText entity and save it to the S/4HANA system.
      Parameters:
      locationText - LocationText entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing LocationText entity. To perform execution, call the execute method on the request builder object.

    • deleteLocationText

      @Nonnull DeleteRequestBuilder<LocationText> deleteLocationText(@Nonnull LocationText locationText)
      Deprecated.
      Deletes an existing LocationText entity in the S/4HANA system.
      Parameters:
      locationText - LocationText entity object that will be deleted in the S/4HANA system.
      Returns:
      A request builder to delete an existing LocationText entity. To perform execution, call the execute method on the request builder object.