com.sap.cloud.sdk.s4hana.datamodel.odata.services.WarehouseTaskService Maven / Gradle / Ivy
/*
* Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
*/
package com.sap.cloud.sdk.s4hana.datamodel.odata.services;
import java.math.BigDecimal;
import javax.annotation.Nonnull;
import com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.AssignWarehouseOrderFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.CancelWarehouseTaskFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.ConfirmWarehouseTaskExactFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.ConfirmWarehouseTaskHUFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.ConfirmWarehouseTaskProductFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.SetInProcessWarehouseOrderFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.UnassignWarehouseOrderFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseOrderByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseOrderFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTaskByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTaskExceptionCodeByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTaskExceptionCodeFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTaskFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.batch.WarehouseTaskServiceBatch;
/**
*
* You can use this service to integrate external applications with warehouse orders and warehouse tasks in SAP S/4HANA
* Cloud. 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)..
*
*
*
* 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
*
*
*
*/
public interface WarehouseTaskService extends BatchService
{
/**
* If no other path was provided via the {@link #withServicePath(String)} method, this is the default service path
* used to access the endpoint.
*
*/
String DEFAULT_SERVICE_PATH = "/sap/opu/odata/sap/API_WAREHOUSE_ORDER_TASK";
/**
* Overrides the default service path and returns a new service instance with the specified service path. Also
* adjusts the respective entity URLs.
*
* @param servicePath
* Service path that will override the default.
* @return A new service instance with the specified service path.
*/
@Nonnull
WarehouseTaskService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseOrder
* WarehouseOrder} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseOrder 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseOrderFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
WarehouseOrderFluentHelper getAllWarehouseOrder();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseOrder
* WarehouseOrder} entity using key fields.
*
* @param warehouse
* Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param warehouseOrder
* Warehouse Order Number
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseOrder 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseOrderByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
WarehouseOrderByKeyFluentHelper getWarehouseOrderByKey( final String warehouse, final String warehouseOrder );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTask
* WarehouseTask} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTask 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTaskFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
WarehouseTaskFluentHelper getAllWarehouseTask();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTask
* WarehouseTask} entity using key fields.
*
* @param warehouseTaskItem
* Uniquely identifes a movement within a warehouse task (WT)
*
* Constraints: Not nullable, Maximum length: 4
*
* @param warehouse
* Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param warehouseTask
* Number that uniquely identifies the warehouse task within a warehouse.
*
* Constraints: Not nullable, Maximum length: 12
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTask 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTaskByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
WarehouseTaskByKeyFluentHelper
getWarehouseTaskByKey( final String warehouse, final String warehouseTask, final String warehouseTaskItem );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTaskExceptionCode
* WarehouseTaskExceptionCode} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTaskExceptionCode
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTaskExceptionCodeFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
WarehouseTaskExceptionCodeFluentHelper getAllWarehouseTaskExceptionCode();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTaskExceptionCode
* WarehouseTaskExceptionCode} entity using key fields.
*
* @param businessContextExecutionStep
* Execution Step in Business Context
*
* Constraints: Not nullable, Maximum length: 2
*
* @param warehouseTaskItem
* Uniquely identifes a movement within a warehouse task (WT)
*
* Constraints: Not nullable, Maximum length: 4
*
* @param warehouseTaskExceptionCode
* Code with which an exception situation in the warehouse can be documented.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param businessContext
* Context in which special exception codes can be made available.
*
* Constraints: Not nullable, Maximum length: 3
*
* @param warehouse
* Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param warehouseTask
* Number that uniquely identifies the warehouse task within a warehouse.
*
* Constraints: Not nullable, Maximum length: 12
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTaskExceptionCode
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTaskExceptionCodeByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
WarehouseTaskExceptionCodeByKeyFluentHelper getWarehouseTaskExceptionCodeByKey(
final String warehouse,
final String warehouseTask,
final String warehouseTaskItem,
final String warehouseTaskExceptionCode,
final String businessContext,
final String businessContextExecutionStep );
/**
*
* Creates a fluent helper for the AssignWarehouseOrder OData function import.
*
*
* @param warehouseResource
* Resource
*
*
*
* Constraints: Nullable, Maximum length: 18
*
*
* Original parameter name from the Odata EDM: WarehouseResource
*
* @param warehouse
* Warehouse Number
*
*
*
* Constraints: Not nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: Warehouse
*
* @param warehouseOrder
* Warehouse Order
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: WarehouseOrder
*
* @return A fluent helper object that will execute the AssignWarehouseOrder OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.AssignWarehouseOrderFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
AssignWarehouseOrderFluentHelper
assignWarehouseOrder( final String warehouse, final String warehouseOrder, final String warehouseResource );
/**
*
* Creates a fluent helper for the SetInProcessWarehouseOrder OData function import.
*
*
* @param warehouse
* Warehouse Number
*
*
*
* Constraints: Not nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: Warehouse
*
* @param warehouseOrder
* Warehouse Order
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: WarehouseOrder
*
* @return A fluent helper object that will execute the SetInProcessWarehouseOrder OData function import with
* the provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.SetInProcessWarehouseOrderFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SetInProcessWarehouseOrderFluentHelper
setInProcessWarehouseOrder( final String warehouse, final String warehouseOrder );
/**
*
* Creates a fluent helper for the UnassignWarehouseOrder OData function import.
*
*
* @param warehouse
* Warehouse Number
*
*
*
* Constraints: Not nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: Warehouse
*
* @param warehouseOrder
* Warehouse Order
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: WarehouseOrder
*
* @return A fluent helper object that will execute the UnassignWarehouseOrder OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.UnassignWarehouseOrderFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
UnassignWarehouseOrderFluentHelper unassignWarehouseOrder( final String warehouse, final String warehouseOrder );
/**
*
* Creates a fluent helper for the CancelWarehouseTask OData function import.
*
*
* @param warehouseTaskItem
* WT Item
*
*
*
* Constraints: Not nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: WarehouseTaskItem
*
* @param warehouse
* Warehouse Number
*
*
*
* Constraints: Not nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: Warehouse
*
* @param warehouseTask
* Warehouse Task
*
*
*
* Constraints: Not nullable, Maximum length: 12
*
*
* Original parameter name from the Odata EDM: WarehouseTask
*
* @return A fluent helper object that will execute the CancelWarehouseTask OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.CancelWarehouseTaskFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
CancelWarehouseTaskFluentHelper
cancelWarehouseTask( final String warehouse, final String warehouseTask, final String warehouseTaskItem );
/**
*
* Creates a fluent helper for the ConfirmWarehouseTaskExact OData function import.
*
*
* @param warehouseTaskItem
* WT Item
*
*
*
* Constraints: Not nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: WarehouseTaskItem
*
* @param warehouse
* Warehouse Number
*
*
*
* Constraints: Not nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: Warehouse
*
* @param warehouseTask
* Warehouse Task
*
*
*
* Constraints: Not nullable, Maximum length: 12
*
*
* Original parameter name from the Odata EDM: WarehouseTask
*
* @return A fluent helper object that will execute the ConfirmWarehouseTaskExact OData function import with
* the provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.ConfirmWarehouseTaskExactFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ConfirmWarehouseTaskExactFluentHelper
confirmWarehouseTaskExact( final String warehouse, final String warehouseTask, final String warehouseTaskItem );
/**
*
* Creates a fluent helper for the ConfirmWarehouseTaskHU OData function import.
*
*
* @param warehouseTaskItem
* WT Item
*
*
*
* Constraints: Not nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: WarehouseTaskItem
*
* @param destinationStorageBin
* Destination Bin
*
*
*
* Constraints: Nullable, Maximum length: 18
*
*
* Original parameter name from the Odata EDM: DestinationStorageBin
*
* @param warehouse
* Warehouse Number
*
*
*
* Constraints: Not nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: Warehouse
*
* @param warehouseTask
* Warehouse Task
*
*
*
* Constraints: Not nullable, Maximum length: 12
*
*
* Original parameter name from the Odata EDM: WarehouseTask
*
* @param whseTaskExCodeDestStorageBin
* Exception Code
*
*
*
* Constraints: Nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: WhseTaskExCodeDestStorageBin
*
* @return A fluent helper object that will execute the ConfirmWarehouseTaskHU OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.ConfirmWarehouseTaskHUFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ConfirmWarehouseTaskHUFluentHelper confirmWarehouseTaskHU(
final String warehouse,
final String warehouseTask,
final String warehouseTaskItem,
final String destinationStorageBin,
final String whseTaskExCodeDestStorageBin );
/**
*
* Creates a fluent helper for the ConfirmWarehouseTaskProduct OData function import.
*
*
* @param sourceHandlingUnit
* Source Handling Unit
*
*
*
* Constraints: Nullable, Maximum length: 20
*
*
* Original parameter name from the Odata EDM: SourceHandlingUnit
*
* @param whseTaskExceptionCodeQtyDiff
* Exception Code
*
*
*
* Constraints: Nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: WhseTaskExceptionCodeQtyDiff
*
* @param warehouseTaskItem
* WT Item
*
*
*
* Constraints: Not nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: WarehouseTaskItem
*
* @param destinationStorageBin
* Destination Bin
*
*
*
* Constraints: Nullable, Maximum length: 18
*
*
* Original parameter name from the Odata EDM: DestinationStorageBin
*
* @param alternativeUnit
* Alt. Unit of Measure
*
*
*
* Constraints: Nullable, Maximum length: 3
*
*
* Original parameter name from the Odata EDM: AlternativeUnit
*
* @param differenceQuantityInAltvUnit
* Difference Quantity
*
*
*
* Constraints: Nullable, Precision: 31, Scale: 14
*
*
* Original parameter name from the Odata EDM: DifferenceQuantityInAltvUnit
*
* @param actualQuantityInAltvUnit
* Actual Quantity
*
*
*
* Constraints: Nullable, Precision: 31, Scale: 14
*
*
* Original parameter name from the Odata EDM: ActualQuantityInAltvUnit
*
* @param warehouse
* Warehouse Number
*
*
*
* Constraints: Not nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: Warehouse
*
* @param warehouseTask
* Warehouse Task
*
*
*
* Constraints: Not nullable, Maximum length: 12
*
*
* Original parameter name from the Odata EDM: WarehouseTask
*
* @param whseTaskExCodeDestStorageBin
* Exception Code
*
*
*
* Constraints: Nullable, Maximum length: 4
*
*
* Original parameter name from the Odata EDM: WhseTaskExCodeDestStorageBin
*
* @return A fluent helper object that will execute the ConfirmWarehouseTaskProduct OData function import
* with the provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.ConfirmWarehouseTaskProductFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ConfirmWarehouseTaskProductFluentHelper confirmWarehouseTaskProduct(
final String warehouse,
final String warehouseTask,
final String warehouseTaskItem,
final String alternativeUnit,
final BigDecimal actualQuantityInAltvUnit,
final BigDecimal differenceQuantityInAltvUnit,
final String whseTaskExceptionCodeQtyDiff,
final String destinationStorageBin,
final String whseTaskExCodeDestStorageBin,
final String sourceHandlingUnit );
}