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

Interface FunctionalLocationService

All Superinterfaces:

BatchService<FunctionalLocationServiceBatch>

All Known Implementing Classes:

DefaultFunctionalLocationService

public interface FunctionalLocationService
extends BatchService<FunctionalLocationServiceBatch>

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 API Business Hub

Details:

OData Service:	API_FUNCTIONALLOCATION
API Version:	1
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), Service Order processing with SAP Field service management (49X), Service Quotation (4GA), Reactive Maintenance (4HH), Proactive Maintenance (4HI), Improvement Maintenance (4VT), Operational and Overhead Maintenance (4WM), Corrective Maintenance (BH1), Emergency Maintenance (BH2), Preventive Maintenance (BJ2)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	FunctionalLocation

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
CharacteristicCreateFluentHelper	createCharacteristic(Characteristic characteristic) Create a new Characteristic entity and save it to the S/4HANA system.
FunctionalLocationCreateFluentHelper	createFunctionalLocation(FunctionalLocation functionalLocation) Create a new FunctionalLocation entity and save it to the S/4HANA system.
FunctionalLocationClassCreateFluentHelper	createFunctionalLocationClass(FunctionalLocationClass functionalLocationClass) Create a new FunctionalLocationClass entity and save it to the S/4HANA system.
FunctionalLocationLongTextCreateFluentHelper	createFunctionalLocationLongText(FunctionalLocationLongText functionalLocationLongText) Create a new FunctionalLocationLongText entity and save it to the S/4HANA system.
FunctionalLocationPartnerCreateFluentHelper	createFunctionalLocationPartner(FunctionalLocationPartner functionalLocationPartner) Create a new FunctionalLocationPartner entity and save it to the S/4HANA system.
FunctionalLocationWarrantyCreateFluentHelper	createFunctionalLocationWarranty(FunctionalLocationWarranty functionalLocationWarranty) Create a new FunctionalLocationWarranty entity and save it to the S/4HANA system.
ValueCreateFluentHelper	createValue(Value value) Create a new Value entity and save it to the S/4HANA system.
FunctionalLocationClassDeleteFluentHelper	deleteFunctionalLocationClass(FunctionalLocationClass functionalLocationClass) Deletes an existing FunctionalLocationClass entity in the S/4HANA system.
CharacteristicFluentHelper	getAllCharacteristic() Fetch multiple Characteristic entities.
FunctionalLocationFluentHelper	getAllFunctionalLocation() Fetch multiple FunctionalLocation entities.
FunctionalLocationClassFluentHelper	getAllFunctionalLocationClass() Fetch multiple FunctionalLocationClass entities.
FunctionalLocationLongTextFluentHelper	getAllFunctionalLocationLongText() Fetch multiple FunctionalLocationLongText entities.
FunctionalLocationPartnerFluentHelper	getAllFunctionalLocationPartner() Fetch multiple FunctionalLocationPartner entities.
FunctionalLocationWarrantyFluentHelper	getAllFunctionalLocationWarranty() Fetch multiple FunctionalLocationWarranty entities.
ValueFluentHelper	getAllValue() Fetch multiple Value entities.
CharacteristicByKeyFluentHelper	getCharacteristicByKey(String functionalLocation, String classInternalID, String charcInternalID) Fetch a single Characteristic entity using key fields.
FunctionalLocationByKeyFluentHelper	getFunctionalLocationByKey(String functionalLocation) Fetch a single FunctionalLocation entity using key fields.
FunctionalLocationClassByKeyFluentHelper	getFunctionalLocationClassByKey(String functionalLocation, String classInternalID, String classType) Fetch a single FunctionalLocationClass entity using key fields.
FunctionalLocationLongTextByKeyFluentHelper	getFunctionalLocationLongTextByKey(String functionalLocation) Fetch a single FunctionalLocationLongText entity using key fields.
FunctionalLocationPartnerByKeyFluentHelper	getFunctionalLocationPartnerByKey(String functionalLocation, String partnerFunction, String funcnlLocPartnerObjectNmbr) Fetch a single FunctionalLocationPartner entity using key fields.
FunctionalLocationWarrantyByKeyFluentHelper	getFunctionalLocationWarrantyByKey(String functionalLocation, String warrantyType) Fetch a single FunctionalLocationWarranty entity using key fields.
ValueByKeyFluentHelper	getValueByKey(String functionalLocation, String classType, String charcValuePositionNumber, String charcInternalID) Fetch a single Value entity using key fields.
FunctionalLocationUpdateFluentHelper	updateFunctionalLocation(FunctionalLocation functionalLocation) Update an existing FunctionalLocation entity and save it to the S/4HANA system.
FunctionalLocationClassUpdateFluentHelper	updateFunctionalLocationClass(FunctionalLocationClass functionalLocationClass) Update an existing FunctionalLocationClass entity and save it to the S/4HANA system.
FunctionalLocationLongTextUpdateFluentHelper	updateFunctionalLocationLongText(FunctionalLocationLongText functionalLocationLongText) Update an existing FunctionalLocationLongText entity and save it to the S/4HANA system.
FunctionalLocationPartnerUpdateFluentHelper	updateFunctionalLocationPartner(FunctionalLocationPartner functionalLocationPartner) Update an existing FunctionalLocationPartner entity and save it to the S/4HANA system.
FunctionalLocationWarrantyUpdateFluentHelper	updateFunctionalLocationWarranty(FunctionalLocationWarranty functionalLocationWarranty) Update an existing FunctionalLocationWarranty entity and save it to the S/4HANA system.
ValueUpdateFluentHelper	updateValue(Value value) Update an existing Value entity and save it to the S/4HANA system.
FunctionalLocationService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
FunctionalLocationService withServicePath(@Nonnull
                                                   String servicePath)

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()

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)

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 - Uniquely identifies the 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)

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)

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()

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)

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 - Uniquely identifies the 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)

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)

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)

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()

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)

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)

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()

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)

Fetch a single FunctionalLocationWarranty entity using key fields.

Parameters:

functionalLocation - Label that uniquely identifies a funtional location.

Constraints: Not nullable, Maximum length: 30

warrantyType - Key that describes the warranty type. The warranty type is assigned to an internal warranty category that specifies whether you are the warrantee or the guarantor.

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)

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)

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()

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)

Fetch a single FunctionalLocation entity using key fields.

Parameters:

functionalLocation - Label that uniquely identifies a funtional 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)

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)

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()

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)

Fetch a single FunctionalLocationLongText entity using key fields.

Parameters:

functionalLocation - Label that uniquely identifies a funtional 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)

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)

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()

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)

Fetch a single FunctionalLocationPartner entity using key fields.

Parameters:

partnerFunction - You can convert the keys that identify the partner functions in the original German system to language-specific keys. The converted keys then appear according to the language in which the user logs on.

Constraints: Not nullable, Maximum length: 2

functionalLocation - Label that uniquely identifies a funtional 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)

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)

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.