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

Class DefaultWarehouseResourceService

java.lang.Object

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

All Implemented Interfaces:

BatchService<WarehouseResourceServiceBatch>, WarehouseResourceService

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

You can use this service to integrate external applications with warehouse resources in SAP S/4HANA Cloud. In every API call, you can make use of the following operations: - You can retrieve warehouse resources. Apply any of the filters provided or retrieve all existing data. - You can create and delete warehouse resources. - You can update existing warehouse resources (log on, log off)..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_WAREHOUSE_RESOURCE
API Version:	1
Communication Scenario:	Warehousing - Process Warehouse Task Integration (SAP_COM_0353)
Scope Items:	Resource Management in Warehousing (3W0)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	WarehouseResource

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.WarehouseResourceService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultWarehouseResourceService() Creates a service using WarehouseResourceService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultWarehouseResourceServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
WarehouseResourceCreateFluentHelper	createWarehouseResource(WarehouseResource warehouseResource) Create a new WarehouseResource entity and save it to the S/4HANA system.
WarehouseResourceDeleteFluentHelper	deleteWarehouseResource(WarehouseResource warehouseResource) Deletes an existing WarehouseResource entity in the S/4HANA system.
WarehouseResourceFluentHelper	getAllWarehouseResource() Fetch multiple WarehouseResource entities.
WarehouseResourceByKeyFluentHelper	getWarehouseResourceByKey(String warehouse, String warehouseResource) Fetch a single WarehouseResource entity using key fields.
LogoffFromWarehouseResourceFluentHelper	logoffFromWarehouseResource(String warehouse, String warehouseResource) Creates a fluent helper for the LogoffFromWarehouseResource OData function import.
LogonToWarehouseResourceFluentHelper	logonToWarehouseResource(String warehouse, String warehouseResource) Creates a fluent helper for the LogonToWarehouseResource OData function import.
DefaultWarehouseResourceService	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

DefaultWarehouseResourceService

public DefaultWarehouseResourceService()

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

Method Detail

withServicePath

@Nonnull
public DefaultWarehouseResourceService withServicePath(@Nonnull
                                                                String servicePath)

Description copied from interface: WarehouseResourceService

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 WarehouseResourceService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultWarehouseResourceServiceBatch batch()

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

Specified by:

batch in interface BatchService<WarehouseResourceServiceBatch>

Returns:

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

getAllWarehouseResource

@Nonnull
public WarehouseResourceFluentHelper getAllWarehouseResource()

Description copied from interface: WarehouseResourceService

Fetch multiple WarehouseResource entities.

Specified by:

getAllWarehouseResource in interface WarehouseResourceService

Returns:

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

getWarehouseResourceByKey

@Nonnull
public WarehouseResourceByKeyFluentHelper getWarehouseResourceByKey(String warehouse,
                                                                             String warehouseResource)

Description copied from interface: WarehouseResourceService

Fetch a single WarehouseResource entity using key fields.

Specified by:

getWarehouseResourceByKey in interface WarehouseResourceService

Parameters:

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

Constraints: Not nullable, Maximum length: 4

warehouseResource - Resource (Means of Transportation or User)

Constraints: Not nullable, Maximum length: 18

Returns:

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

createWarehouseResource

@Nonnull
public WarehouseResourceCreateFluentHelper createWarehouseResource(@Nonnull
                                                                            WarehouseResource warehouseResource)

Description copied from interface: WarehouseResourceService

Create a new WarehouseResource entity and save it to the S/4HANA system.

Specified by:

createWarehouseResource in interface WarehouseResourceService

Parameters:

warehouseResource - WarehouseResource entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new WarehouseResource entity. To perform execution, call the execute method on the fluent helper object.

deleteWarehouseResource

@Nonnull
public WarehouseResourceDeleteFluentHelper deleteWarehouseResource(@Nonnull
                                                                            WarehouseResource warehouseResource)

Description copied from interface: WarehouseResourceService

Deletes an existing WarehouseResource entity in the S/4HANA system.

Specified by:

deleteWarehouseResource in interface WarehouseResourceService

Parameters:

warehouseResource - WarehouseResource entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing WarehouseResource entity. To perform execution, call the execute method on the fluent helper object.

logoffFromWarehouseResource

@Nonnull
public LogoffFromWarehouseResourceFluentHelper logoffFromWarehouseResource(String warehouse,
                                                                                    String warehouseResource)

Description copied from interface: WarehouseResourceService

Creates a fluent helper for the LogoffFromWarehouseResource OData function import.

Specified by:

logoffFromWarehouseResource in interface WarehouseResourceService

Parameters:

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseResource - Resource

Constraints: Not nullable, Maximum length: 18

Original parameter name from the Odata EDM: WarehouseResource

Returns:

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

logonToWarehouseResource

@Nonnull
public LogonToWarehouseResourceFluentHelper logonToWarehouseResource(String warehouse,
                                                                              String warehouseResource)

Description copied from interface: WarehouseResourceService

Creates a fluent helper for the LogonToWarehouseResource OData function import.

Specified by:

logonToWarehouseResource in interface WarehouseResourceService

Parameters:

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseResource - Resource

Constraints: Not nullable, Maximum length: 18

Original parameter name from the Odata EDM: WarehouseResource

Returns:

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