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

Interface WarehouseService

All Superinterfaces:

BatchService<WarehouseServiceBatch>

All Known Implementing Classes:

DefaultWarehouseService

public interface WarehouseService
extends BatchService<WarehouseServiceBatch>

This allows you to integrate input help (F4 help) for warehouse numbers in your mobile apps.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_WAREHOUSE
API Version:	1
Communication Scenario:	Warehousing - Master Data Integration (SAP_COM_0374)
Scope Items:	Resource Management in Warehousing (3W0)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	Warehouse

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
WarehouseFluentHelper	getAllWarehouse() Fetch multiple Warehouse entities.
WarehouseStorageTypeFluentHelper	getAllWarehouseStorageType() Fetch multiple WarehouseStorageType entities.
WarehouseStorageTypeTextFluentHelper	getAllWarehouseStorageTypeText() Fetch multiple WarehouseStorageTypeText entities.
WarehouseTextFluentHelper	getAllWarehouseText() Fetch multiple WarehouseText entities.
WarehouseByKeyFluentHelper	getWarehouseByKey(String warehouse) Fetch a single Warehouse entity using key fields.
WarehouseStorageTypeByKeyFluentHelper	getWarehouseStorageTypeByKey(String warehouse, String storageType) Fetch a single WarehouseStorageType entity using key fields.
WarehouseStorageTypeTextByKeyFluentHelper	getWarehouseStorageTypeTextByKey(String language, String warehouse, String storageType) Fetch a single WarehouseStorageTypeText entity using key fields.
WarehouseTextByKeyFluentHelper	getWarehouseTextByKey(String language, String warehouse) Fetch a single WarehouseText entity using key fields.
WarehouseService	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
WarehouseService 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.

getAllWarehouse

@Nonnull
WarehouseFluentHelper getAllWarehouse()

Fetch multiple Warehouse entities.

Returns:

A fluent helper to fetch multiple Warehouse 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.

getWarehouseByKey

@Nonnull
WarehouseByKeyFluentHelper getWarehouseByKey(String warehouse)

Fetch a single Warehouse entity using key fields.

Parameters:

warehouse - Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single Warehouse 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.

getAllWarehouseStorageType

@Nonnull
WarehouseStorageTypeFluentHelper getAllWarehouseStorageType()

Fetch multiple WarehouseStorageType entities.

Returns:

A fluent helper to fetch multiple WarehouseStorageType 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.

getWarehouseStorageTypeByKey

@Nonnull
WarehouseStorageTypeByKeyFluentHelper getWarehouseStorageTypeByKey(String warehouse,
                                                                            String storageType)

Fetch a single WarehouseStorageType entity using key fields.

Parameters:

storageType - Breakdown of a complex physical warehouse. Storage types differ in their storage techniques, their organizational form, or their function.

Constraints: Not nullable, Maximum length: 4

warehouse - Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single WarehouseStorageType 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.

getAllWarehouseStorageTypeText

@Nonnull
WarehouseStorageTypeTextFluentHelper getAllWarehouseStorageTypeText()

Fetch multiple WarehouseStorageTypeText entities.

Returns:

A fluent helper to fetch multiple WarehouseStorageTypeText 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.

getWarehouseStorageTypeTextByKey

@Nonnull
WarehouseStorageTypeTextByKeyFluentHelper getWarehouseStorageTypeTextByKey(String language,
                                                                                    String warehouse,
                                                                                    String storageType)

Fetch a single WarehouseStorageTypeText entity using key fields.

Parameters:

storageType - Breakdown of a complex physical warehouse. Storage types differ in their storage techniques, their organizational form, or their function.

Constraints: Not nullable, Maximum length: 4

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

warehouse - Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single WarehouseStorageTypeText 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.

getAllWarehouseText

@Nonnull
WarehouseTextFluentHelper getAllWarehouseText()

Fetch multiple WarehouseText entities.

Returns:

A fluent helper to fetch multiple WarehouseText 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.

getWarehouseTextByKey

@Nonnull
WarehouseTextByKeyFluentHelper getWarehouseTextByKey(String language,
                                                              String warehouse)

Fetch a single WarehouseText entity using key fields.

Parameters:

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

warehouse - Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single WarehouseText 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.