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

Class DefaultWarehouseService

java.lang.Object

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

All Implemented Interfaces:

BatchService<WarehouseServiceBatch>, WarehouseService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultWarehouseService")
public class DefaultWarehouseService
extends Object
implements WarehouseService

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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.WarehouseService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultWarehouseService() Creates a service using WarehouseService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultWarehouseServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultWarehouseService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultWarehouseService

public DefaultWarehouseService()

Creates a service using WarehouseService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultWarehouseService withServicePath(@Nonnull
                                                        String servicePath)

Description copied from interface: WarehouseService

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 WarehouseService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultWarehouseServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<WarehouseServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllWarehouse

@Nonnull
public WarehouseFluentHelper getAllWarehouse()

Description copied from interface: WarehouseService

Fetch multiple Warehouse entities.

Specified by:

getAllWarehouse in interface WarehouseService

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
public WarehouseByKeyFluentHelper getWarehouseByKey(String warehouse)

Description copied from interface: WarehouseService

Fetch a single Warehouse entity using key fields.

Specified by:

getWarehouseByKey in interface WarehouseService

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
public WarehouseStorageTypeFluentHelper getAllWarehouseStorageType()

Description copied from interface: WarehouseService

Fetch multiple WarehouseStorageType entities.

Specified by:

getAllWarehouseStorageType in interface WarehouseService

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
public WarehouseStorageTypeByKeyFluentHelper getWarehouseStorageTypeByKey(String warehouse,
                                                                                   String storageType)

Description copied from interface: WarehouseService

Fetch a single WarehouseStorageType entity using key fields.

Specified by:

getWarehouseStorageTypeByKey in interface WarehouseService

Parameters:

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

Constraints: Not nullable, Maximum length: 4

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

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
public WarehouseStorageTypeTextFluentHelper getAllWarehouseStorageTypeText()

Description copied from interface: WarehouseService

Fetch multiple WarehouseStorageTypeText entities.

Specified by:

getAllWarehouseStorageTypeText in interface WarehouseService

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
public WarehouseStorageTypeTextByKeyFluentHelper getWarehouseStorageTypeTextByKey(String language,
                                                                                           String warehouse,
                                                                                           String storageType)

Description copied from interface: WarehouseService

Fetch a single WarehouseStorageTypeText entity using key fields.

Specified by:

getWarehouseStorageTypeTextByKey in interface WarehouseService

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

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

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
public WarehouseTextFluentHelper getAllWarehouseText()

Description copied from interface: WarehouseService

Fetch multiple WarehouseText entities.

Specified by:

getAllWarehouseText in interface WarehouseService

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
public WarehouseTextByKeyFluentHelper getWarehouseTextByKey(String language,
                                                                     String warehouse)

Description copied from interface: WarehouseService

Fetch a single WarehouseText entity using key fields.

Specified by:

getWarehouseTextByKey in interface WarehouseService

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.