@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultKanbanControlCycleV2Service") public class DefaultKanbanControlCycleV2Service extends Object implements KanbanControlCycleV2Service
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..
Reference: SAP API Business Hub
| OData Service: | OP_API_KANBAN_CONTROL_CYCLE_SRV_0002 |
| API Version: | 2 |
| Minimum ERP Version: | 2020 |
| Authentication Methods: | Basic, x509 |
| Business Object: | Kanban Control Cycle |
DEFAULT_SERVICE_PATH| Constructor and Description |
|---|
DefaultKanbanControlCycleV2Service()
Creates a service using
KanbanControlCycleV2Service.DEFAULT_SERVICE_PATH to send the requests. |
| 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.
|
DefaultKanbanControlCycleV2ServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
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.
|
DefaultKanbanControlCycleV2Service |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
public DefaultKanbanControlCycleV2Service()
KanbanControlCycleV2Service.DEFAULT_SERVICE_PATH to send the requests.@Nonnull public DefaultKanbanControlCycleV2Service withServicePath(@Nonnull String servicePath)
KanbanControlCycleV2ServicewithServicePath in interface KanbanControlCycleV2ServiceservicePath - Service path that will override the default.@Nonnull public DefaultKanbanControlCycleV2ServiceBatch batch()
batch in interface BatchService<KanbanControlCycleV2ServiceBatch>@Nonnull public KanbanContainerFluentHelper getAllKanbanContainer()
KanbanControlCycleV2ServiceKanbanContainer entities.getAllKanbanContainer in interface KanbanControlCycleV2ServiceKanbanContainer 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.@Nonnull public KanbanContainerByKeyFluentHelper getKanbanContainerByKey(String kanbanContainer)
KanbanControlCycleV2ServiceKanbanContainer entity using key fields.getKanbanContainerByKey in interface KanbanControlCycleV2ServicekanbanContainer - Kanban Container
Constraints: Not nullable, Maximum length: 10
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.@Nonnull public KanbanContainerDeliveryAddrFluentHelper getAllKanbanContainerDeliveryAddr()
KanbanControlCycleV2ServiceKanbanContainerDeliveryAddr entities.getAllKanbanContainerDeliveryAddr in interface KanbanControlCycleV2ServiceKanbanContainerDeliveryAddr 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.@Nonnull public KanbanContainerDeliveryAddrByKeyFluentHelper getKanbanContainerDeliveryAddrByKey(String kanbanControlCycle)
KanbanControlCycleV2ServiceKanbanContainerDeliveryAddr entity using key fields.getKanbanContainerDeliveryAddrByKey in interface KanbanControlCycleV2ServicekanbanControlCycle - Kanban Control Cycle
Constraints: Not nullable, Maximum length: 7
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.@Nonnull public KanbanControlCycleFluentHelper getAllKanbanControlCycle()
KanbanControlCycleV2ServiceKanbanControlCycle entities.getAllKanbanControlCycle in interface KanbanControlCycleV2ServiceKanbanControlCycle 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.@Nonnull public KanbanControlCycleByKeyFluentHelper getKanbanControlCycleByKey(String kanbanControlCycle)
KanbanControlCycleV2ServiceKanbanControlCycle entity using key fields.getKanbanControlCycleByKey in interface KanbanControlCycleV2ServicekanbanControlCycle - Kanban Control Cycle
Constraints: Not nullable, Maximum length: 7
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.@Nonnull public KanbanControlCycleCreateFluentHelper createKanbanControlCycle(@Nonnull KanbanControlCycle kanbanControlCycle)
KanbanControlCycleV2ServiceKanbanControlCycle entity and save it to the S/4HANA system.createKanbanControlCycle in interface KanbanControlCycleV2ServicekanbanControlCycle - KanbanControlCycle entity object that will be created in the S/4HANA system.KanbanControlCycle entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public KanbanControlCycleUpdateFluentHelper updateKanbanControlCycle(@Nonnull KanbanControlCycle kanbanControlCycle)
KanbanControlCycleV2ServiceKanbanControlCycle entity and save it to the S/4HANA system.updateKanbanControlCycle in interface KanbanControlCycleV2ServicekanbanControlCycle - KanbanControlCycle entity object that will be updated in the S/4HANA system.KanbanControlCycle entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public KanbanControlCycleDeleteFluentHelper deleteKanbanControlCycle(@Nonnull KanbanControlCycle kanbanControlCycle)
KanbanControlCycleV2ServiceKanbanControlCycle entity in the S/4HANA system.deleteKanbanControlCycle in interface KanbanControlCycleV2ServicekanbanControlCycle - KanbanControlCycle entity object that will be deleted in the S/4HANA system.KanbanControlCycle entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public KanbanCtnDetailedQtyFluentHelper getAllKanbanCtnDetailedQty()
KanbanControlCycleV2ServiceKanbanCtnDetailedQty entities.getAllKanbanCtnDetailedQty in interface KanbanControlCycleV2ServiceKanbanCtnDetailedQty 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.@Nonnull public KanbanCtnDetailedQtyByKeyFluentHelper getKanbanCtnDetailedQtyByKey(String kanbanContainer, String batch)
KanbanControlCycleV2ServiceKanbanCtnDetailedQty entity using key fields.getKanbanCtnDetailedQtyByKey in interface KanbanControlCycleV2ServicekanbanContainer - Kanban Identification Number
Constraints: Not nullable, Maximum length: 10
batch - Batch Number
Constraints: Not nullable, Maximum length: 10
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.@Nonnull public KanbanDeliveryFluentHelper getAllKanbanDelivery()
KanbanControlCycleV2ServiceKanbanDelivery entities.getAllKanbanDelivery in interface KanbanControlCycleV2ServiceKanbanDelivery 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.@Nonnull public KanbanDeliveryByKeyFluentHelper getKanbanDeliveryByKey(String kanbanContainer)
KanbanControlCycleV2ServiceKanbanDelivery entity using key fields.getKanbanDeliveryByKey in interface KanbanControlCycleV2ServicekanbanContainer - Kanban Identification Number
Constraints: Not nullable, Maximum length: 10
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.@Nonnull public SetKanbanContainerStatusFluentHelper setKanbanContainerStatus(String kanbanContainer, String kanbanContainerStatus, BigDecimal actualQuantityInUnitOfEntry, String unitOfEntry, String batch, ZonedDateTime kanbanCtnStatusChangeDateTime, String deliveryNote)
KanbanControlCycleV2ServiceCreates a fluent helper for the SetKanbanContainerStatus OData function import.
setKanbanContainerStatus in interface KanbanControlCycleV2ServicekanbanContainer - Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: KanbanContainer
kanbanContainerStatus - Constraints: Nullable, Maximum length: 1
Original parameter name from the Odata EDM: KanbanContainerStatus
actualQuantityInUnitOfEntry - Constraints: Nullable, Precision: 13, Scale: 3
Original parameter name from the Odata EDM: ActualQuantityInUnitOfEntry
unitOfEntry - Constraints: Nullable, Maximum length: 3
Original parameter name from the Odata EDM: UnitOfEntry
batch - Constraints: Nullable, Maximum length: 10
Original parameter name from the Odata EDM: Batch
kanbanCtnStatusChangeDateTime - Constraints: Nullable, Precision: 7
Original parameter name from the Odata EDM: KanbanCtnStatusChangeDateTime
deliveryNote - Constraints: Nullable, Maximum length: 16
Original parameter name from the Odata EDM: DeliveryNote
execute method on the fluent helper object.@Nonnull public SetKanbanContainerLockFluentHelper setKanbanContainerLock(String kanbanContainer, Boolean isLocked)
KanbanControlCycleV2ServiceCreates a fluent helper for the SetKanbanContainerLock OData function import.
setKanbanContainerLock in interface KanbanControlCycleV2ServicekanbanContainer - Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: KanbanContainer
isLocked - Constraints: none
Original parameter name from the Odata EDM: IsLocked
execute method on the fluent helper object.@Nonnull public SetKanbanControlCycleLifeCycleStatusFluentHelper setKanbanControlCycleLifeCycleStatus(String kanbanControlCycle, String kanbanCtrlCycleLifeCycleStatus)
KanbanControlCycleV2ServiceCreates a fluent helper for the SetKanbanControlCycleLifeCycleStatus OData function import.
setKanbanControlCycleLifeCycleStatus in interface KanbanControlCycleV2ServicekanbanControlCycle - Constraints: Not nullable, Maximum length: 7
Original parameter name from the Odata EDM: KanbanControlCycle
kanbanCtrlCycleLifeCycleStatus - Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: KanbanCtrlCycleLifeCycleStatus
execute method on the fluent helper object.@Nonnull public AddEventDrivenKanbanContainerFluentHelper addEventDrivenKanbanContainer(String kanbanControlCycle, BigDecimal requestedQuantityInBaseUnit, ZonedDateTime requestedDeliveryDateTime, String packingInstruction, Short numberOfLoadCarriers)
KanbanControlCycleV2ServiceCreates a fluent helper for the AddEventDrivenKanbanContainer OData function import.
addEventDrivenKanbanContainer in interface KanbanControlCycleV2ServicekanbanControlCycle - Constraints: Not nullable, Maximum length: 7
Original parameter name from the Odata EDM: KanbanControlCycle
requestedQuantityInBaseUnit - Constraints: Nullable, Precision: 13, Scale: 3
Original parameter name from the Odata EDM: RequestedQuantityInBaseUnit
requestedDeliveryDateTime - Constraints: Nullable, Precision: 7
Original parameter name from the Odata EDM: RequestedDeliveryDateTime
packingInstruction - Constraints: Nullable, Maximum length: 20
Original parameter name from the Odata EDM: PackingInstruction
numberOfLoadCarriers - Constraints: Nullable
Original parameter name from the Odata EDM: NumberOfLoadCarriers
execute method on the fluent helper object.@Nonnull public WithdrawQuantityFromControlCycleFluentHelper withdrawQuantityFromControlCycle(String kanbanControlCycle, BigDecimal kanbanCtrlCycWthdrwlQtyInBsUnt)
KanbanControlCycleV2ServiceCreates a fluent helper for the WithdrawQuantityFromControlCycle OData function import.
withdrawQuantityFromControlCycle in interface KanbanControlCycleV2ServicekanbanControlCycle - Constraints: Not nullable, Maximum length: 7
Original parameter name from the Odata EDM: KanbanControlCycle
kanbanCtrlCycWthdrwlQtyInBsUnt - Constraints: Not nullable, Precision: 13, Scale: 3
Original parameter name from the Odata EDM: KanbanCtrlCycWthdrwlQtyInBsUnt
execute method on the fluent helper object.@Nonnull public WithdrawQuantityFromKanbanContainerFluentHelper withdrawQuantityFromKanbanContainer(String kanbanContainer, BigDecimal kanbanCtnWithdrawalQtyInBsUnt)
KanbanControlCycleV2ServiceCreates a fluent helper for the WithdrawQuantityFromKanbanContainer OData function import.
withdrawQuantityFromKanbanContainer in interface KanbanControlCycleV2ServicekanbanContainer - Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: KanbanContainer
kanbanCtnWithdrawalQtyInBsUnt - Constraints: Not nullable, Precision: 13, Scale: 3
Original parameter name from the Odata EDM: KanbanCtnWithdrawalQtyInBsUnt
execute method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.