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

Class DefaultLocationService

java.lang.Object
com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultLocationService
All Implemented Interfaces:
OperationsOnEntityCollections, ServiceWithNavigableEntities, LocationService
@Named("com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultLocationService") @Deprecated public class DefaultLocationService extends Object implements ServiceWithNavigableEntities, 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

  • Constructor Details

  • Method Details

    • withServicePath

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

    • batch

      @Nonnull public BatchRequestBuilder batch()
      Deprecated.
      Description copied from interface: LocationService
      Creates a batch request builder object.
      Specified by:
      batch in interface LocationService
      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 public GetAllRequestBuilder<Location> getAllLocation()
      Deprecated.
      Description copied from interface: LocationService
      Fetch multiple Location entities.
      Specified by:
      getAllLocation in interface LocationService
      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 public CountRequestBuilder<Location> countLocation()
      Deprecated.
      Description copied from interface: LocationService
      Fetch the number of entries from the Location entity collection matching the filter and search expressions.
      Specified by:
      countLocation in interface LocationService
      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 public GetByKeyRequestBuilder<Location> getLocationByKey(UUID locationUUID)
      Deprecated.
      Description copied from interface: LocationService
      Fetch a single Location entity using key fields.
      Specified by:
      getLocationByKey in interface LocationService
      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 public CreateRequestBuilder<Location> createLocation(@Nonnull Location location)
      Deprecated.
      Description copied from interface: LocationService
      Create a new Location entity and save it to the S/4HANA system.
      Specified by:
      createLocation in interface LocationService
      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 public UpdateRequestBuilder<Location> updateLocation(@Nonnull Location location)
      Deprecated.
      Description copied from interface: LocationService
      Update an existing Location entity and save it to the S/4HANA system.
      Specified by:
      updateLocation in interface LocationService
      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 public DeleteRequestBuilder<Location> deleteLocation(@Nonnull Location location)
      Deprecated.
      Description copied from interface: LocationService
      Deletes an existing Location entity in the S/4HANA system.
      Specified by:
      deleteLocation in interface LocationService
      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 public GetAllRequestBuilder<LocationAddress> getAllLocationAddress()
      Deprecated.
      Description copied from interface: LocationService
      Fetch multiple LocationAddress entities.
      Specified by:
      getAllLocationAddress in interface LocationService
      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 public CountRequestBuilder<LocationAddress> countLocationAddress()
      Deprecated.
      Description copied from interface: LocationService
      Fetch the number of entries from the LocationAddress entity collection matching the filter and search expressions.
      Specified by:
      countLocationAddress in interface LocationService
      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 public GetByKeyRequestBuilder<LocationAddress> getLocationAddressByKey(UUID locationUUID, String addressPersonID, String addressRepresentationCode)
      Deprecated.
      Description copied from interface: LocationService
      Fetch a single LocationAddress entity using key fields.
      Specified by:
      getLocationAddressByKey in interface LocationService
      Parameters:
      locationUUID - Internal Location Number (Customer, Supplier, or Plant)

      Constraints: Not nullable

      addressPersonID - Person Number

      Constraints: Not nullable, Maximum length: 10

      addressRepresentationCode - Version ID for International Addresses

      Constraints: Not nullable, Maximum length: 1

      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 public UpdateRequestBuilder<LocationAddress> updateLocationAddress(@Nonnull LocationAddress locationAddress)
      Deprecated.
      Description copied from interface: LocationService
      Update an existing LocationAddress entity and save it to the S/4HANA system.
      Specified by:
      updateLocationAddress in interface LocationService
      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 public GetAllRequestBuilder<LocationText> getAllLocationText()
      Deprecated.
      Description copied from interface: LocationService
      Fetch multiple LocationText entities.
      Specified by:
      getAllLocationText in interface LocationService
      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 public CountRequestBuilder<LocationText> countLocationText()
      Deprecated.
      Description copied from interface: LocationService
      Fetch the number of entries from the LocationText entity collection matching the filter and search expressions.
      Specified by:
      countLocationText in interface LocationService
      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 public GetByKeyRequestBuilder<LocationText> getLocationTextByKey(UUID locationUUID, String language)
      Deprecated.
      Description copied from interface: LocationService
      Fetch a single LocationText entity using key fields.
      Specified by:
      getLocationTextByKey in interface LocationService
      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 public UpdateRequestBuilder<LocationText> updateLocationText(@Nonnull LocationText locationText)
      Deprecated.
      Description copied from interface: LocationService
      Update an existing LocationText entity and save it to the S/4HANA system.
      Specified by:
      updateLocationText in interface LocationService
      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 public DeleteRequestBuilder<LocationText> deleteLocationText(@Nonnull LocationText locationText)
      Deprecated.
      Description copied from interface: LocationService
      Deletes an existing LocationText entity in the S/4HANA system.
      Specified by:
      deleteLocationText in interface LocationService
      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.

    • getServicePath

      @Nonnull public String getServicePath()
      Deprecated.
      Specified by:
      getServicePath in interface ServiceWithNavigableEntities