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

Class DefaultWarehouseTaskService

java.lang.Object

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

All Implemented Interfaces:

BatchService<WarehouseTaskServiceBatch>, WarehouseTaskService

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

In every API call, you can make use of the following operations: - You can retrieve warehouse orders and warehouse tasks. Apply any of the filters provided or retrieve all existing data. - For existing warehouse orders, you can update the corresponding warehouse tasks. - You can update existing warehouse tasks (confirm, confirm with exceptions, cancel). - You can update existing warehouse orders (assign or unassign warehouse order to warehouse resource)..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_WAREHOUSE_ORDER_TASK
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:	WarehouseOrder

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultWarehouseTaskService() Creates a service using WarehouseTaskService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
AssignWarehouseOrderFluentHelper	assignWarehouseOrder(String warehouse, String warehouseOrder, String warehouseResource) Creates a fluent helper for the AssignWarehouseOrder OData function import.
DefaultWarehouseTaskServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
CancelWarehouseTaskFluentHelper	cancelWarehouseTask(String warehouse, String warehouseTask, String warehouseTaskItem) Creates a fluent helper for the CancelWarehouseTask OData function import.
ConfirmWarehouseTaskExactFluentHelper	confirmWarehouseTaskExact(String warehouse, String warehouseTask, String warehouseTaskItem) Creates a fluent helper for the ConfirmWarehouseTaskExact OData function import.
ConfirmWarehouseTaskHUFluentHelper	confirmWarehouseTaskHU(String warehouse, String warehouseTask, String warehouseTaskItem, String destinationStorageBin, String whseTaskExCodeDestStorageBin) Creates a fluent helper for the ConfirmWarehouseTaskHU OData function import.
ConfirmWarehouseTaskProductFluentHelper	confirmWarehouseTaskProduct(String warehouse, String warehouseTask, String warehouseTaskItem, String alternativeUnit, BigDecimal actualQuantityInAltvUnit, BigDecimal differenceQuantityInAltvUnit, String whseTaskExceptionCodeQtyDiff, String destinationStorageBin, String whseTaskExCodeDestStorageBin, String sourceHandlingUnit) Creates a fluent helper for the ConfirmWarehouseTaskProduct OData function import.
WarehouseOrderFluentHelper	getAllWarehouseOrder() Fetch multiple WarehouseOrder entities.
WarehouseTaskFluentHelper	getAllWarehouseTask() Fetch multiple WarehouseTask entities.
WarehouseTaskExceptionCodeFluentHelper	getAllWarehouseTaskExceptionCode() Fetch multiple WarehouseTaskExceptionCode entities.
WarehouseOrderByKeyFluentHelper	getWarehouseOrderByKey(String warehouse, String warehouseOrder) Fetch a single WarehouseOrder entity using key fields.
WarehouseTaskByKeyFluentHelper	getWarehouseTaskByKey(String warehouse, String warehouseTask, String warehouseTaskItem) Fetch a single WarehouseTask entity using key fields.
WarehouseTaskExceptionCodeByKeyFluentHelper	getWarehouseTaskExceptionCodeByKey(String warehouse, String warehouseTask, String warehouseTaskItem, String warehouseTaskExceptionCode, String businessContext, String businessContextExecutionStep) Fetch a single WarehouseTaskExceptionCode entity using key fields.
SetInProcessWarehouseOrderFluentHelper	setInProcessWarehouseOrder(String warehouse, String warehouseOrder) Creates a fluent helper for the SetInProcessWarehouseOrder OData function import.
UnassignWarehouseOrderFluentHelper	unassignWarehouseOrder(String warehouse, String warehouseOrder) Creates a fluent helper for the UnassignWarehouseOrder OData function import.
DefaultWarehouseTaskService	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

DefaultWarehouseTaskService

public DefaultWarehouseTaskService()

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

Method Detail

withServicePath

@Nonnull
public DefaultWarehouseTaskService withServicePath(@Nonnull
                                                            String servicePath)

Description copied from interface: WarehouseTaskService

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 WarehouseTaskService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultWarehouseTaskServiceBatch batch()

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

Specified by:

batch in interface BatchService<WarehouseTaskServiceBatch>

Returns:

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

getAllWarehouseOrder

@Nonnull
public WarehouseOrderFluentHelper getAllWarehouseOrder()

Description copied from interface: WarehouseTaskService

Fetch multiple WarehouseOrder entities.

Specified by:

getAllWarehouseOrder in interface WarehouseTaskService

Returns:

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

getWarehouseOrderByKey

@Nonnull
public WarehouseOrderByKeyFluentHelper getWarehouseOrderByKey(String warehouse,
                                                                       String warehouseOrder)

Description copied from interface: WarehouseTaskService

Fetch a single WarehouseOrder entity using key fields.

Specified by:

getWarehouseOrderByKey in interface WarehouseTaskService

Parameters:

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

Constraints: Not nullable, Maximum length: 4

warehouseOrder - Warehouse Order Number

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllWarehouseTask

@Nonnull
public WarehouseTaskFluentHelper getAllWarehouseTask()

Description copied from interface: WarehouseTaskService

Fetch multiple WarehouseTask entities.

Specified by:

getAllWarehouseTask in interface WarehouseTaskService

Returns:

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

getWarehouseTaskByKey

@Nonnull
public WarehouseTaskByKeyFluentHelper getWarehouseTaskByKey(String warehouse,
                                                                     String warehouseTask,
                                                                     String warehouseTaskItem)

Description copied from interface: WarehouseTaskService

Fetch a single WarehouseTask entity using key fields.

Specified by:

getWarehouseTaskByKey in interface WarehouseTaskService

Parameters:

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

Constraints: Not nullable, Maximum length: 4

warehouseTask - Number that uniquely identifies the warehouse task within a warehouse.

Constraints: Not nullable, Maximum length: 12

warehouseTaskItem - Uniquely identifes a movement within a warehouse task (WT)

Constraints: Not nullable, Maximum length: 4

Returns:

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

getAllWarehouseTaskExceptionCode

@Nonnull
public WarehouseTaskExceptionCodeFluentHelper getAllWarehouseTaskExceptionCode()

Description copied from interface: WarehouseTaskService

Fetch multiple WarehouseTaskExceptionCode entities.

Specified by:

getAllWarehouseTaskExceptionCode in interface WarehouseTaskService

Returns:

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

getWarehouseTaskExceptionCodeByKey

@Nonnull
public WarehouseTaskExceptionCodeByKeyFluentHelper getWarehouseTaskExceptionCodeByKey(String warehouse,
                                                                                               String warehouseTask,
                                                                                               String warehouseTaskItem,
                                                                                               String warehouseTaskExceptionCode,
                                                                                               String businessContext,
                                                                                               String businessContextExecutionStep)

Description copied from interface: WarehouseTaskService

Fetch a single WarehouseTaskExceptionCode entity using key fields.

Specified by:

getWarehouseTaskExceptionCodeByKey in interface WarehouseTaskService

Parameters:

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

Constraints: Not nullable, Maximum length: 4

warehouseTask - Number that uniquely identifies the warehouse task within a warehouse.

Constraints: Not nullable, Maximum length: 12

warehouseTaskItem - Uniquely identifes a movement within a warehouse task (WT)

Constraints: Not nullable, Maximum length: 4

warehouseTaskExceptionCode - Code with which an exception situation in the warehouse can be documented.

Constraints: Not nullable, Maximum length: 4

businessContext - Context in which special exception codes can be made available.

Constraints: Not nullable, Maximum length: 3

businessContextExecutionStep - Execution Step in Business Context

Constraints: Not nullable, Maximum length: 2

Returns:

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

assignWarehouseOrder

@Nonnull
public AssignWarehouseOrderFluentHelper assignWarehouseOrder(String warehouse,
                                                                      String warehouseOrder,
                                                                      String warehouseResource)

Description copied from interface: WarehouseTaskService

Creates a fluent helper for the AssignWarehouseOrder OData function import.

Specified by:

assignWarehouseOrder in interface WarehouseTaskService

Parameters:

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseOrder - Warehouse Order

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: WarehouseOrder

warehouseResource - Resource

Constraints: Nullable, Maximum length: 18

Original parameter name from the Odata EDM: WarehouseResource

Returns:

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

setInProcessWarehouseOrder

@Nonnull
public SetInProcessWarehouseOrderFluentHelper setInProcessWarehouseOrder(String warehouse,
                                                                                  String warehouseOrder)

Description copied from interface: WarehouseTaskService

Creates a fluent helper for the SetInProcessWarehouseOrder OData function import.

Specified by:

setInProcessWarehouseOrder in interface WarehouseTaskService

Parameters:

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseOrder - Warehouse Order

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: WarehouseOrder

Returns:

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

unassignWarehouseOrder

@Nonnull
public UnassignWarehouseOrderFluentHelper unassignWarehouseOrder(String warehouse,
                                                                          String warehouseOrder)

Description copied from interface: WarehouseTaskService

Creates a fluent helper for the UnassignWarehouseOrder OData function import.

Specified by:

unassignWarehouseOrder in interface WarehouseTaskService

Parameters:

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseOrder - Warehouse Order

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: WarehouseOrder

Returns:

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

cancelWarehouseTask

@Nonnull
public CancelWarehouseTaskFluentHelper cancelWarehouseTask(String warehouse,
                                                                    String warehouseTask,
                                                                    String warehouseTaskItem)

Description copied from interface: WarehouseTaskService

Creates a fluent helper for the CancelWarehouseTask OData function import.

Specified by:

cancelWarehouseTask in interface WarehouseTaskService

Parameters:

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseTask - Warehouse Task

Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: WarehouseTask

warehouseTaskItem - WT Item

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: WarehouseTaskItem

Returns:

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

confirmWarehouseTaskExact

@Nonnull
public ConfirmWarehouseTaskExactFluentHelper confirmWarehouseTaskExact(String warehouse,
                                                                                String warehouseTask,
                                                                                String warehouseTaskItem)

Description copied from interface: WarehouseTaskService

Creates a fluent helper for the ConfirmWarehouseTaskExact OData function import.

Specified by:

confirmWarehouseTaskExact in interface WarehouseTaskService

Parameters:

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseTask - Warehouse Task

Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: WarehouseTask

warehouseTaskItem - WT Item

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: WarehouseTaskItem

Returns:

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

confirmWarehouseTaskHU

@Nonnull
public ConfirmWarehouseTaskHUFluentHelper confirmWarehouseTaskHU(String warehouse,
                                                                          String warehouseTask,
                                                                          String warehouseTaskItem,
                                                                          String destinationStorageBin,
                                                                          String whseTaskExCodeDestStorageBin)

Description copied from interface: WarehouseTaskService

Creates a fluent helper for the ConfirmWarehouseTaskHU OData function import.

Specified by:

confirmWarehouseTaskHU in interface WarehouseTaskService

Parameters:

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseTask - Warehouse Task

Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: WarehouseTask

warehouseTaskItem - WT Item

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: WarehouseTaskItem

destinationStorageBin - Destination Bin

Constraints: Nullable, Maximum length: 18

Original parameter name from the Odata EDM: DestinationStorageBin

whseTaskExCodeDestStorageBin - Exception Code

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: WhseTaskExCodeDestStorageBin

Returns:

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

confirmWarehouseTaskProduct

@Nonnull
public ConfirmWarehouseTaskProductFluentHelper confirmWarehouseTaskProduct(String warehouse,
                                                                                    String warehouseTask,
                                                                                    String warehouseTaskItem,
                                                                                    String alternativeUnit,
                                                                                    BigDecimal actualQuantityInAltvUnit,
                                                                                    BigDecimal differenceQuantityInAltvUnit,
                                                                                    String whseTaskExceptionCodeQtyDiff,
                                                                                    String destinationStorageBin,
                                                                                    String whseTaskExCodeDestStorageBin,
                                                                                    String sourceHandlingUnit)

Description copied from interface: WarehouseTaskService

Creates a fluent helper for the ConfirmWarehouseTaskProduct OData function import.

Specified by:

confirmWarehouseTaskProduct in interface WarehouseTaskService

Parameters:

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseTask - Warehouse Task

Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: WarehouseTask

warehouseTaskItem - WT Item

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: WarehouseTaskItem

alternativeUnit - Alt. Unit of Measure

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: AlternativeUnit

actualQuantityInAltvUnit - Actual Quantity

Constraints: Nullable, Precision: 31, Scale: 14

Original parameter name from the Odata EDM: ActualQuantityInAltvUnit

differenceQuantityInAltvUnit - Difference Quantity

Constraints: Nullable, Precision: 31, Scale: 14

Original parameter name from the Odata EDM: DifferenceQuantityInAltvUnit

whseTaskExceptionCodeQtyDiff - Exception Code

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: WhseTaskExceptionCodeQtyDiff

destinationStorageBin - Destination Bin

Constraints: Nullable, Maximum length: 18

Original parameter name from the Odata EDM: DestinationStorageBin

whseTaskExCodeDestStorageBin - Exception Code

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: WhseTaskExCodeDestStorageBin

sourceHandlingUnit - Source Handling Unit

Constraints: Nullable, Maximum length: 20

Original parameter name from the Odata EDM: SourceHandlingUnit

Returns:

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