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

Interface FunctionalLocationService

All Superinterfaces:
BatchService<FunctionalLocationServiceBatch>
All Known Implementing Classes:
DefaultFunctionalLocationService
@Deprecated public interface FunctionalLocationService extends BatchService<FunctionalLocationServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

This service contains functional location, long text, partner function, warranty, class, characteristic, and characteristic value nodes. The information is sent in the request as a payload. The request payload contains all information required to create or update functional location. All the information in the payload is used to create or update functional location including appropriate checks for restricted values and authorizations. Once the functional location has been created, the functional location label is sent in the response with the data included in the functional location. If the input in the request is not as expected when you create or update a functional location, the system displays appropriate error or warning messages in the response..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_FUNCTIONALLOCATION
API Version: 1.1.0
Minimum ERP Version: 2302
Communication Scenario: Asset Management Master Data Integration(SAP_COM_0395)
Scope Items: Service Order Management and Monitoring(3D2), Service Contract Management(3MO), In-House Repair(3XK), Reactive Maintenance(4HH), Proactive Maintenance(4HI), Improvement Maintenance(4VT), Operational and Overhead Maintenance(4WM), Corrective Maintenance(BH1), Emergency Maintenance(BH2), Preventive Maintenance(BJ2), Reactive Maintenance(OHH), Proactive Maintenance(OHI), PSM: Preventive Maintenance(OJ2), Improvement Maintenance(OVT), Operational and Overhead Maintenance(OWM), Service Order Processing with SAP Field Service Management(49X), Service Quotation(4GA)
Authentication Methods: x509
Business Object: Functional Location

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull FunctionalLocationService 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.

    • getAllValue

      @Nonnull ValueFluentHelper getAllValue()
      Deprecated.
      Fetch multiple Value entities.
      Returns:
      A fluent helper to fetch multiple Value entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getValueByKey

      @Nonnull ValueByKeyFluentHelper getValueByKey(String functionalLocation, String classType, String charcValuePositionNumber, String charcInternalID)
      Deprecated.
      Fetch a single Value entity using key fields.
      Parameters:
      charcValuePositionNumber - Characteristic value counter

      Constraints: Not nullable, Maximum length: 3

      charcInternalID - Characteristic Internal ID

      Constraints: Not nullable, Maximum length: 10

      functionalLocation - Key of Object to be Classified

      Constraints: Not nullable, Maximum length: 90

      classType - Class Type

      Constraints: Not nullable, Maximum length: 3

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

    • createValue

      @Nonnull ValueCreateFluentHelper createValue(@Nonnull Value value)
      Deprecated.
      Create a new Value entity and save it to the S/4HANA system.
      Parameters:
      value - Value entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new Value entity. To perform execution, call the execute method on the fluent helper object.

    • updateValue

      @Nonnull ValueUpdateFluentHelper updateValue(@Nonnull Value value)
      Deprecated.
      Update an existing Value entity and save it to the S/4HANA system.
      Parameters:
      value - Value entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing Value entity. To perform execution, call the execute method on the fluent helper object.

    • getAllFunctionalLocationClass

      @Nonnull FunctionalLocationClassFluentHelper getAllFunctionalLocationClass()
      Deprecated.
      Fetch multiple FunctionalLocationClass entities.
      Returns:
      A fluent helper to fetch multiple FunctionalLocationClass entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getFunctionalLocationClassByKey

      @Nonnull FunctionalLocationClassByKeyFluentHelper getFunctionalLocationClassByKey(String functionalLocation, String classInternalID, String classType)
      Deprecated.
      Fetch a single FunctionalLocationClass entity using key fields.
      Parameters:
      classInternalID - Internal Class Number

      Constraints: Not nullable, Maximum length: 10

      functionalLocation - Key of Object to be Classified

      Constraints: Not nullable, Maximum length: 90

      classType - Class Type

      Constraints: Not nullable, Maximum length: 3

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

    • createFunctionalLocationClass

      @Nonnull FunctionalLocationClassCreateFluentHelper createFunctionalLocationClass(@Nonnull FunctionalLocationClass functionalLocationClass)
      Deprecated.
      Create a new FunctionalLocationClass entity and save it to the S/4HANA system.
      Parameters:
      functionalLocationClass - FunctionalLocationClass entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new FunctionalLocationClass entity. To perform execution, call the execute method on the fluent helper object.

    • updateFunctionalLocationClass

      @Nonnull FunctionalLocationClassUpdateFluentHelper updateFunctionalLocationClass(@Nonnull FunctionalLocationClass functionalLocationClass)
      Deprecated.
      Update an existing FunctionalLocationClass entity and save it to the S/4HANA system.
      Parameters:
      functionalLocationClass - FunctionalLocationClass entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing FunctionalLocationClass entity. To perform execution, call the execute method on the fluent helper object.

    • deleteFunctionalLocationClass

      @Nonnull FunctionalLocationClassDeleteFluentHelper deleteFunctionalLocationClass(@Nonnull FunctionalLocationClass functionalLocationClass)
      Deprecated.
      Deletes an existing FunctionalLocationClass entity in the S/4HANA system.
      Parameters:
      functionalLocationClass - FunctionalLocationClass entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing FunctionalLocationClass entity. To perform execution, call the execute method on the fluent helper object.

    • getAllCharacteristic

      @Nonnull CharacteristicFluentHelper getAllCharacteristic()
      Deprecated.
      Fetch multiple Characteristic entities.
      Returns:
      A fluent helper to fetch multiple Characteristic entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getCharacteristicByKey

      @Nonnull CharacteristicByKeyFluentHelper getCharacteristicByKey(String functionalLocation, String classInternalID, String charcInternalID)
      Deprecated.
      Fetch a single Characteristic entity using key fields.
      Parameters:
      charcInternalID - Characteristic Internal ID

      Constraints: Not nullable, Maximum length: 10

      classInternalID - Internal Class Number

      Constraints: Not nullable, Maximum length: 10

      functionalLocation - Key of Object to be Classified

      Constraints: Not nullable, Maximum length: 90

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

    • createCharacteristic

      @Nonnull CharacteristicCreateFluentHelper createCharacteristic(@Nonnull Characteristic characteristic)
      Deprecated.
      Create a new Characteristic entity and save it to the S/4HANA system.
      Parameters:
      characteristic - Characteristic entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new Characteristic entity. To perform execution, call the execute method on the fluent helper object.

    • getAllFunctionalLocationWarranty

      @Nonnull FunctionalLocationWarrantyFluentHelper getAllFunctionalLocationWarranty()
      Deprecated.
      Fetch multiple FunctionalLocationWarranty entities.
      Returns:
      A fluent helper to fetch multiple FunctionalLocationWarranty entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getFunctionalLocationWarrantyByKey

      @Nonnull FunctionalLocationWarrantyByKeyFluentHelper getFunctionalLocationWarrantyByKey(String functionalLocation, String warrantyType)
      Deprecated.
      Fetch a single FunctionalLocationWarranty entity using key fields.
      Parameters:
      functionalLocation - Functional location

      Constraints: Not nullable, Maximum length: 30

      warrantyType - Warranty type

      Constraints: Not nullable, Maximum length: 1

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

    • createFunctionalLocationWarranty

      @Nonnull FunctionalLocationWarrantyCreateFluentHelper createFunctionalLocationWarranty(@Nonnull FunctionalLocationWarranty functionalLocationWarranty)
      Deprecated.
      Create a new FunctionalLocationWarranty entity and save it to the S/4HANA system.
      Parameters:
      functionalLocationWarranty - FunctionalLocationWarranty entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new FunctionalLocationWarranty entity. To perform execution, call the execute method on the fluent helper object.

    • updateFunctionalLocationWarranty

      @Nonnull FunctionalLocationWarrantyUpdateFluentHelper updateFunctionalLocationWarranty(@Nonnull FunctionalLocationWarranty functionalLocationWarranty)
      Deprecated.
      Update an existing FunctionalLocationWarranty entity and save it to the S/4HANA system.
      Parameters:
      functionalLocationWarranty - FunctionalLocationWarranty entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing FunctionalLocationWarranty entity. To perform execution, call the execute method on the fluent helper object.

    • getAllFunctionalLocation

      @Nonnull FunctionalLocationFluentHelper getAllFunctionalLocation()
      Deprecated.
      Fetch multiple FunctionalLocation entities.
      Returns:
      A fluent helper to fetch multiple FunctionalLocation entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getFunctionalLocationByKey

      @Nonnull FunctionalLocationByKeyFluentHelper getFunctionalLocationByKey(String functionalLocation)
      Deprecated.
      Fetch a single FunctionalLocation entity using key fields.
      Parameters:
      functionalLocation - Functional location

      Constraints: Not nullable, Maximum length: 30

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

    • createFunctionalLocation

      @Nonnull FunctionalLocationCreateFluentHelper createFunctionalLocation(@Nonnull FunctionalLocation functionalLocation)
      Deprecated.
      Create a new FunctionalLocation entity and save it to the S/4HANA system.
      Parameters:
      functionalLocation - FunctionalLocation entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new FunctionalLocation entity. To perform execution, call the execute method on the fluent helper object.

    • updateFunctionalLocation

      @Nonnull FunctionalLocationUpdateFluentHelper updateFunctionalLocation(@Nonnull FunctionalLocation functionalLocation)
      Deprecated.
      Update an existing FunctionalLocation entity and save it to the S/4HANA system.
      Parameters:
      functionalLocation - FunctionalLocation entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing FunctionalLocation entity. To perform execution, call the execute method on the fluent helper object.

    • getAllFunctionalLocationLongText

      @Nonnull FunctionalLocationLongTextFluentHelper getAllFunctionalLocationLongText()
      Deprecated.
      Fetch multiple FunctionalLocationLongText entities.
      Returns:
      A fluent helper to fetch multiple FunctionalLocationLongText entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getFunctionalLocationLongTextByKey

      @Nonnull FunctionalLocationLongTextByKeyFluentHelper getFunctionalLocationLongTextByKey(String functionalLocation)
      Deprecated.
      Fetch a single FunctionalLocationLongText entity using key fields.
      Parameters:
      functionalLocation - Functional location

      Constraints: Not nullable, Maximum length: 30

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

    • createFunctionalLocationLongText

      @Nonnull FunctionalLocationLongTextCreateFluentHelper createFunctionalLocationLongText(@Nonnull FunctionalLocationLongText functionalLocationLongText)
      Deprecated.
      Create a new FunctionalLocationLongText entity and save it to the S/4HANA system.
      Parameters:
      functionalLocationLongText - FunctionalLocationLongText entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new FunctionalLocationLongText entity. To perform execution, call the execute method on the fluent helper object.

    • updateFunctionalLocationLongText

      @Nonnull FunctionalLocationLongTextUpdateFluentHelper updateFunctionalLocationLongText(@Nonnull FunctionalLocationLongText functionalLocationLongText)
      Deprecated.
      Update an existing FunctionalLocationLongText entity and save it to the S/4HANA system.
      Parameters:
      functionalLocationLongText - FunctionalLocationLongText entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing FunctionalLocationLongText entity. To perform execution, call the execute method on the fluent helper object.

    • getAllFunctionalLocationPartner

      @Nonnull FunctionalLocationPartnerFluentHelper getAllFunctionalLocationPartner()
      Deprecated.
      Fetch multiple FunctionalLocationPartner entities.
      Returns:
      A fluent helper to fetch multiple FunctionalLocationPartner entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getFunctionalLocationPartnerByKey

      @Nonnull FunctionalLocationPartnerByKeyFluentHelper getFunctionalLocationPartnerByKey(String functionalLocation, String partnerFunction, String funcnlLocPartnerObjectNmbr)
      Deprecated.
      Fetch a single FunctionalLocationPartner entity using key fields.
      Parameters:
      partnerFunction - Partner Function

      Constraints: Not nullable, Maximum length: 2

      functionalLocation - Functional location

      Constraints: Not nullable, Maximum length: 30

      funcnlLocPartnerObjectNmbr - Counter for differentiation 6-digit

      Constraints: Not nullable, Maximum length: 6

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

    • createFunctionalLocationPartner

      @Nonnull FunctionalLocationPartnerCreateFluentHelper createFunctionalLocationPartner(@Nonnull FunctionalLocationPartner functionalLocationPartner)
      Deprecated.
      Create a new FunctionalLocationPartner entity and save it to the S/4HANA system.
      Parameters:
      functionalLocationPartner - FunctionalLocationPartner entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new FunctionalLocationPartner entity. To perform execution, call the execute method on the fluent helper object.

    • updateFunctionalLocationPartner

      @Nonnull FunctionalLocationPartnerUpdateFluentHelper updateFunctionalLocationPartner(@Nonnull FunctionalLocationPartner functionalLocationPartner)
      Deprecated.
      Update an existing FunctionalLocationPartner entity and save it to the S/4HANA system.
      Parameters:
      functionalLocationPartner - FunctionalLocationPartner entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing FunctionalLocationPartner entity. To perform execution, call the execute method on the fluent helper object.

    • dismantleFunctionalLocation

      @Nonnull DismantleFunctionalLocationFluentHelper dismantleFunctionalLocation(@Nonnull String functionalLocation, @Nullable LocalDateTime funcLocDismantleDate, @Nullable LocalTime funcLocDismantleTime)
      Deprecated.

      Creates a fluent helper for the DismantleFunctionalLocation OData function import.

      Parameters:
      funcLocDismantleTime - Dismantle Time

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: FuncLocDismantleTime

      functionalLocation - Functional location

      Constraints: Not nullable, Maximum length: 30

      Original parameter name from the Odata EDM: FunctionalLocation

      funcLocDismantleDate - Dismantle Date

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: FuncLocDismantleDate

      Returns:
      A fluent helper object that will execute the DismantleFunctionalLocation OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

    • installFunctionalLocation

      @Nonnull InstallFunctionalLocationFluentHelper installFunctionalLocation(@Nonnull String functionalLocation, @Nullable String superiorFunctionalLocation, @Nullable String funcLocInstallationPosNmbr, @Nullable LocalDateTime funcLocInstallationDate, @Nullable LocalTime funcLocInstallationTime)
      Deprecated.

      Creates a fluent helper for the InstallFunctionalLocation OData function import.

      Parameters:
      funcLocInstallationTime - Install Time

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: FuncLocInstallationTime

      superiorFunctionalLocation - Superior FunctLoc.

      Constraints: Nullable, Maximum length: 40

      Original parameter name from the Odata EDM: SuperiorFunctionalLocation

      functionalLocation - Functional location

      Constraints: Not nullable, Maximum length: 30

      Original parameter name from the Odata EDM: FunctionalLocation

      funcLocInstallationPosNmbr - Position in object

      Constraints: Nullable, Maximum length: 4

      Original parameter name from the Odata EDM: FuncLocInstallationPosNmbr

      funcLocInstallationDate - Install Date

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: FuncLocInstallationDate

      Returns:
      A fluent helper object that will execute the InstallFunctionalLocation OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

    • rsetFuncLocFromMrkdForDeletion

      @Nonnull RsetFuncLocFromMrkdForDeletionFluentHelper rsetFuncLocFromMrkdForDeletion(@Nonnull String functionalLocation)
      Deprecated.

      Creates a fluent helper for the RsetFuncLocFromMrkdForDeletion OData function import.

      Parameters:
      functionalLocation - Functional location

      Constraints: Not nullable, Maximum length: 30

      Original parameter name from the Odata EDM: FunctionalLocation

      Returns:
      A fluent helper object that will execute the RsetFuncLocFromMrkdForDeletion OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

    • rsetFuncnlLocationFromInactive

      @Nonnull RsetFuncnlLocationFromInactiveFluentHelper rsetFuncnlLocationFromInactive(@Nonnull String functionalLocation)
      Deprecated.

      Creates a fluent helper for the RsetFuncnlLocationFromInactive OData function import.

      Parameters:
      functionalLocation - Functional location

      Constraints: Not nullable, Maximum length: 30

      Original parameter name from the Odata EDM: FunctionalLocation

      Returns:
      A fluent helper object that will execute the RsetFuncnlLocationFromInactive OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

    • setFuncLocToMarkedForDeletion

      @Nonnull SetFuncLocToMarkedForDeletionFluentHelper setFuncLocToMarkedForDeletion(@Nonnull String functionalLocation)
      Deprecated.

      Creates a fluent helper for the SetFuncLocToMarkedForDeletion OData function import.

      Parameters:
      functionalLocation - Functional location

      Constraints: Not nullable, Maximum length: 30

      Original parameter name from the Odata EDM: FunctionalLocation

      Returns:
      A fluent helper object that will execute the SetFuncLocToMarkedForDeletion OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

    • setFuncnlLocationToInactive

      @Nonnull SetFuncnlLocationToInactiveFluentHelper setFuncnlLocationToInactive(@Nonnull String functionalLocation)
      Deprecated.

      Creates a fluent helper for the SetFuncnlLocationToInactive OData function import.

      Parameters:
      functionalLocation - Functional location

      Constraints: Not nullable, Maximum length: 30

      Original parameter name from the Odata EDM: FunctionalLocation

      Returns:
      A fluent helper object that will execute the SetFuncnlLocationToInactive OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.