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

Interface KanbanControlCycleV2Service

All Superinterfaces:

BatchService<KanbanControlCycleV2ServiceBatch>

All Known Implementing Classes:

DefaultKanbanControlCycleV2Service

public interface KanbanControlCycleV2Service
extends BatchService<KanbanControlCycleV2ServiceBatch>

The kanban OData API enables you to create and retrieve kanban control cycles and their kanban container data. Additionally, it is possible to change control cycles, to set the status both on control cycle and on container level, and to lock/unlock containers. Furthermore, you can add new containers for event-driven kanban control cycles and you can report the withdrawal out of one or more containers. The service is based on the OData protocol and can be consumed by external systems and user interfaces..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_KANBAN_CONTROL_CYCLE_SRV_0002
API Version:	2
Communication Scenario:	Kanban Control Cycle Integration (SAP_COM_0330)
Scope Items:	Material Replenishment with Kanban - External Procurement (1E3), Material Replenishment with Kanban - In-House Production (4B3), Material Replenishment with Kanban - Stock Transfer (4B4)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	KanbanControlCycle

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
AddEventDrivenKanbanContainerFluentHelper	addEventDrivenKanbanContainer(String kanbanControlCycle, BigDecimal requestedQuantityInBaseUnit, ZonedDateTime requestedDeliveryDateTime, String packingInstruction, Short numberOfLoadCarriers) Creates a fluent helper for the AddEventDrivenKanbanContainer OData function import.
KanbanControlCycleCreateFluentHelper	createKanbanControlCycle(KanbanControlCycle kanbanControlCycle) Create a new KanbanControlCycle entity and save it to the S/4HANA system.
KanbanControlCycleDeleteFluentHelper	deleteKanbanControlCycle(KanbanControlCycle kanbanControlCycle) Deletes an existing KanbanControlCycle entity in the S/4HANA system.
KanbanContainerFluentHelper	getAllKanbanContainer() Fetch multiple KanbanContainer entities.
KanbanContainerDeliveryAddrFluentHelper	getAllKanbanContainerDeliveryAddr() Fetch multiple KanbanContainerDeliveryAddr entities.
KanbanControlCycleFluentHelper	getAllKanbanControlCycle() Fetch multiple KanbanControlCycle entities.
KanbanCtnDetailedQtyFluentHelper	getAllKanbanCtnDetailedQty() Fetch multiple KanbanCtnDetailedQty entities.
KanbanDeliveryFluentHelper	getAllKanbanDelivery() Fetch multiple KanbanDelivery entities.
KanbanContainerByKeyFluentHelper	getKanbanContainerByKey(String kanbanContainer) Fetch a single KanbanContainer entity using key fields.
KanbanContainerDeliveryAddrByKeyFluentHelper	getKanbanContainerDeliveryAddrByKey(String kanbanControlCycle) Fetch a single KanbanContainerDeliveryAddr entity using key fields.
KanbanControlCycleByKeyFluentHelper	getKanbanControlCycleByKey(String kanbanControlCycle) Fetch a single KanbanControlCycle entity using key fields.
KanbanCtnDetailedQtyByKeyFluentHelper	getKanbanCtnDetailedQtyByKey(String kanbanContainer, String batch) Fetch a single KanbanCtnDetailedQty entity using key fields.
KanbanDeliveryByKeyFluentHelper	getKanbanDeliveryByKey(String kanbanContainer) Fetch a single KanbanDelivery entity using key fields.
SetKanbanContainerLockFluentHelper	setKanbanContainerLock(String kanbanContainer, Boolean isLocked) Creates a fluent helper for the SetKanbanContainerLock OData function import.
SetKanbanContainerStatusFluentHelper	setKanbanContainerStatus(String kanbanContainer, String kanbanContainerStatus, BigDecimal actualQuantityInUnitOfEntry, String unitOfEntry, String batch, ZonedDateTime kanbanCtnStatusChangeDateTime, String deliveryNote) Creates a fluent helper for the SetKanbanContainerStatus OData function import.
SetKanbanControlCycleLifeCycleStatusFluentHelper	setKanbanControlCycleLifeCycleStatus(String kanbanControlCycle, String kanbanCtrlCycleLifeCycleStatus) Creates a fluent helper for the SetKanbanControlCycleLifeCycleStatus OData function import.
KanbanControlCycleUpdateFluentHelper	updateKanbanControlCycle(KanbanControlCycle kanbanControlCycle) Update an existing KanbanControlCycle entity and save it to the S/4HANA system.
WithdrawQuantityFromControlCycleFluentHelper	withdrawQuantityFromControlCycle(String kanbanControlCycle, BigDecimal kanbanCtrlCycWthdrwlQtyInBsUnt) Creates a fluent helper for the WithdrawQuantityFromControlCycle OData function import.
WithdrawQuantityFromKanbanContainerFluentHelper	withdrawQuantityFromKanbanContainer(String kanbanContainer, BigDecimal kanbanCtnWithdrawalQtyInBsUnt) Creates a fluent helper for the WithdrawQuantityFromKanbanContainer OData function import.
KanbanControlCycleV2Service	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
KanbanControlCycleV2Service 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.

getAllKanbanContainer

@Nonnull
KanbanContainerFluentHelper getAllKanbanContainer()

Fetch multiple KanbanContainer entities.

Returns:

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

getKanbanContainerByKey

@Nonnull
KanbanContainerByKeyFluentHelper getKanbanContainerByKey(String kanbanContainer)

Fetch a single KanbanContainer entity using key fields.

Parameters:

kanbanContainer - Kanban Container

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllKanbanContainerDeliveryAddr

@Nonnull
KanbanContainerDeliveryAddrFluentHelper getAllKanbanContainerDeliveryAddr()

Fetch multiple KanbanContainerDeliveryAddr entities.

Returns:

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

getKanbanContainerDeliveryAddrByKey

@Nonnull
KanbanContainerDeliveryAddrByKeyFluentHelper getKanbanContainerDeliveryAddrByKey(String kanbanControlCycle)

Fetch a single KanbanContainerDeliveryAddr entity using key fields.

Parameters:

kanbanControlCycle - Kanban Control Cycle

Constraints: Not nullable, Maximum length: 7

Returns:

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

getAllKanbanControlCycle

@Nonnull
KanbanControlCycleFluentHelper getAllKanbanControlCycle()

Fetch multiple KanbanControlCycle entities.

Returns:

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

getKanbanControlCycleByKey

@Nonnull
KanbanControlCycleByKeyFluentHelper getKanbanControlCycleByKey(String kanbanControlCycle)

Fetch a single KanbanControlCycle entity using key fields.

Parameters:

kanbanControlCycle - Kanban Control Cycle

Constraints: Not nullable, Maximum length: 7

Returns:

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

createKanbanControlCycle

@Nonnull
KanbanControlCycleCreateFluentHelper createKanbanControlCycle(@Nonnull
                                                                       KanbanControlCycle kanbanControlCycle)

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

Parameters:

kanbanControlCycle - KanbanControlCycle entity object that will be created in the S/4HANA system.

Returns:

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

updateKanbanControlCycle

@Nonnull
KanbanControlCycleUpdateFluentHelper updateKanbanControlCycle(@Nonnull
                                                                       KanbanControlCycle kanbanControlCycle)

Update an existing KanbanControlCycle entity and save it to the S/4HANA system.

Parameters:

kanbanControlCycle - KanbanControlCycle entity object that will be updated in the S/4HANA system.

Returns:

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

deleteKanbanControlCycle

@Nonnull
KanbanControlCycleDeleteFluentHelper deleteKanbanControlCycle(@Nonnull
                                                                       KanbanControlCycle kanbanControlCycle)

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

Parameters:

kanbanControlCycle - KanbanControlCycle entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllKanbanCtnDetailedQty

@Nonnull
KanbanCtnDetailedQtyFluentHelper getAllKanbanCtnDetailedQty()

Fetch multiple KanbanCtnDetailedQty entities.

Returns:

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

getKanbanCtnDetailedQtyByKey

@Nonnull
KanbanCtnDetailedQtyByKeyFluentHelper getKanbanCtnDetailedQtyByKey(String kanbanContainer,
                                                                            String batch)

Fetch a single KanbanCtnDetailedQty entity using key fields.

Parameters:

batch - Assigns a material that is manufactured in batches or production lots to a specific batch.

Constraints: Not nullable, Maximum length: 10

kanbanContainer - Determines the Kanban number.

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllKanbanDelivery

@Nonnull
KanbanDeliveryFluentHelper getAllKanbanDelivery()

Fetch multiple KanbanDelivery entities.

Returns:

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

getKanbanDeliveryByKey

@Nonnull
KanbanDeliveryByKeyFluentHelper getKanbanDeliveryByKey(String kanbanContainer)

Fetch a single KanbanDelivery entity using key fields.

Parameters:

kanbanContainer - Determines the Kanban number.

Constraints: Not nullable, Maximum length: 10

Returns:

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

setKanbanContainerStatus

@Nonnull
SetKanbanContainerStatusFluentHelper setKanbanContainerStatus(String kanbanContainer,
                                                                       String kanbanContainerStatus,
                                                                       BigDecimal actualQuantityInUnitOfEntry,
                                                                       String unitOfEntry,
                                                                       String batch,
                                                                       ZonedDateTime kanbanCtnStatusChangeDateTime,
                                                                       String deliveryNote)

Creates a fluent helper for the SetKanbanContainerStatus OData function import.

Parameters:

actualQuantityInUnitOfEntry - Actual Quantity

Constraints: Nullable, Precision: 13, Scale: 3

Original parameter name from the Odata EDM: ActualQuantityInUnitOfEntry

deliveryNote - Delivery note

Constraints: Nullable, Maximum length: 16

Original parameter name from the Odata EDM: DeliveryNote

kanbanContainerStatus - Kanban Status

Constraints: Nullable, Maximum length: 1

Original parameter name from the Odata EDM: KanbanContainerStatus

batch - Batch

Constraints: Nullable, Maximum length: 10

Original parameter name from the Odata EDM: Batch

kanbanCtnStatusChangeDateTime - Time Stamp

Constraints: Nullable, Precision: 7

Original parameter name from the Odata EDM: KanbanCtnStatusChangeDateTime

kanbanContainer - Kanban ID

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: KanbanContainer

unitOfEntry - Unit

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: UnitOfEntry

Returns:

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

setKanbanContainerLock

@Nonnull
SetKanbanContainerLockFluentHelper setKanbanContainerLock(String kanbanContainer,
                                                                   Boolean isLocked)

Creates a fluent helper for the SetKanbanContainerLock OData function import.

Parameters:

isLocked - Kanban is Blocked

Constraints: none

Original parameter name from the Odata EDM: IsLocked

kanbanContainer - Kanban ID

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: KanbanContainer

Returns:

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

setKanbanControlCycleLifeCycleStatus

@Nonnull
SetKanbanControlCycleLifeCycleStatusFluentHelper setKanbanControlCycleLifeCycleStatus(String kanbanControlCycle,
                                                                                               String kanbanCtrlCycleLifeCycleStatus)

Creates a fluent helper for the SetKanbanControlCycleLifeCycleStatus OData function import.

Parameters:

kanbanCtrlCycleLifeCycleStatus - Lifecycle Status

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: KanbanCtrlCycleLifeCycleStatus

kanbanControlCycle - Control Cycle

Constraints: Not nullable, Maximum length: 7

Original parameter name from the Odata EDM: KanbanControlCycle

Returns:

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

addEventDrivenKanbanContainer

@Nonnull
AddEventDrivenKanbanContainerFluentHelper addEventDrivenKanbanContainer(String kanbanControlCycle,
                                                                                 BigDecimal requestedQuantityInBaseUnit,
                                                                                 ZonedDateTime requestedDeliveryDateTime,
                                                                                 String packingInstruction,
                                                                                 Short numberOfLoadCarriers)

Creates a fluent helper for the AddEventDrivenKanbanContainer OData function import.

Parameters:

requestedDeliveryDateTime - Time Stamp

Constraints: Nullable, Precision: 7

Original parameter name from the Odata EDM: RequestedDeliveryDateTime

numberOfLoadCarriers - No.Load Carriers

Constraints: Nullable

Original parameter name from the Odata EDM: NumberOfLoadCarriers

packingInstruction - Packing instruction

Constraints: Nullable, Maximum length: 20

Original parameter name from the Odata EDM: PackingInstruction

requestedQuantityInBaseUnit - Requested Quantity

Constraints: Nullable, Precision: 13, Scale: 3

Original parameter name from the Odata EDM: RequestedQuantityInBaseUnit

kanbanControlCycle - Control Cycle

Constraints: Not nullable, Maximum length: 7

Original parameter name from the Odata EDM: KanbanControlCycle

Returns:

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

withdrawQuantityFromControlCycle

@Nonnull
WithdrawQuantityFromControlCycleFluentHelper withdrawQuantityFromControlCycle(String kanbanControlCycle,
                                                                                       BigDecimal kanbanCtrlCycWthdrwlQtyInBsUnt)

Creates a fluent helper for the WithdrawQuantityFromControlCycle OData function import.

Parameters:

kanbanCtrlCycWthdrwlQtyInBsUnt - Withdrawal quantity

Constraints: Not nullable, Precision: 13, Scale: 3

Original parameter name from the Odata EDM: KanbanCtrlCycWthdrwlQtyInBsUnt

kanbanControlCycle - Control Cycle

Constraints: Not nullable, Maximum length: 7

Original parameter name from the Odata EDM: KanbanControlCycle

Returns:

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

withdrawQuantityFromKanbanContainer

@Nonnull
WithdrawQuantityFromKanbanContainerFluentHelper withdrawQuantityFromKanbanContainer(String kanbanContainer,
                                                                                             BigDecimal kanbanCtnWithdrawalQtyInBsUnt)

Creates a fluent helper for the WithdrawQuantityFromKanbanContainer OData function import.

Parameters:

kanbanCtnWithdrawalQtyInBsUnt - Withdrawal quantity

Constraints: Not nullable, Precision: 13, Scale: 3

Original parameter name from the Odata EDM: KanbanCtnWithdrawalQtyInBsUnt

kanbanContainer - Kanban ID

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: KanbanContainer

Returns:

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