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

Class DefaultKanbanControlCycleV2Service

java.lang.Object
com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultKanbanControlCycleV2Service
All Implemented Interfaces:
BatchService<KanbanControlCycleV2ServiceBatch>, KanbanControlCycleV2Service
@Named("com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultKanbanControlCycleV2Service") @Deprecated public class DefaultKanbanControlCycleV2Service extends Object implements KanbanControlCycleV2Service
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

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 Business Accelerator Hub

Details:

OData Service: API_KANBAN_CONTROL_CYCLE_SRV_0002
API Version: 2.1.0
Minimum ERP Version: 2302
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: x509
Business Object: Kanban Control Cycle

  • Constructor Details

  • Method Details

    • withServicePath

      @Nonnull public DefaultKanbanControlCycleV2Service withServicePath(@Nonnull String servicePath)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      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 KanbanControlCycleV2Service
      Parameters:
      servicePath - Service path that will override the default.
      Returns:
      A new service instance with the specified service path.

    • batch

      @Nonnull public DefaultKanbanControlCycleV2ServiceBatch batch()
      Deprecated.
      Specified by:
      batch in interface BatchService<KanbanControlCycleV2ServiceBatch>

    • getAllKanbanContainer

      @Nonnull public KanbanContainerFluentHelper getAllKanbanContainer()
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      Fetch multiple KanbanContainer entities.
      Specified by:
      getAllKanbanContainer in interface KanbanControlCycleV2Service
      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 public KanbanContainerByKeyFluentHelper getKanbanContainerByKey(String kanbanContainer)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      Fetch a single KanbanContainer entity using key fields.
      Specified by:
      getKanbanContainerByKey in interface KanbanControlCycleV2Service
      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 public KanbanContainerDeliveryAddrFluentHelper getAllKanbanContainerDeliveryAddr()
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      Fetch multiple KanbanContainerDeliveryAddr entities.
      Specified by:
      getAllKanbanContainerDeliveryAddr in interface KanbanControlCycleV2Service
      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 public KanbanContainerDeliveryAddrByKeyFluentHelper getKanbanContainerDeliveryAddrByKey(String kanbanControlCycle)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      Fetch a single KanbanContainerDeliveryAddr entity using key fields.
      Specified by:
      getKanbanContainerDeliveryAddrByKey in interface KanbanControlCycleV2Service
      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 public KanbanControlCycleFluentHelper getAllKanbanControlCycle()
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      Fetch multiple KanbanControlCycle entities.
      Specified by:
      getAllKanbanControlCycle in interface KanbanControlCycleV2Service
      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 public KanbanControlCycleByKeyFluentHelper getKanbanControlCycleByKey(String kanbanControlCycle)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      Fetch a single KanbanControlCycle entity using key fields.
      Specified by:
      getKanbanControlCycleByKey in interface KanbanControlCycleV2Service
      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 public KanbanControlCycleCreateFluentHelper createKanbanControlCycle(@Nonnull KanbanControlCycle kanbanControlCycle)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      Create a new KanbanControlCycle entity and save it to the S/4HANA system.
      Specified by:
      createKanbanControlCycle in interface KanbanControlCycleV2Service
      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 public KanbanControlCycleUpdateFluentHelper updateKanbanControlCycle(@Nonnull KanbanControlCycle kanbanControlCycle)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      Update an existing KanbanControlCycle entity and save it to the S/4HANA system.
      Specified by:
      updateKanbanControlCycle in interface KanbanControlCycleV2Service
      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 public KanbanControlCycleDeleteFluentHelper deleteKanbanControlCycle(@Nonnull KanbanControlCycle kanbanControlCycle)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      Deletes an existing KanbanControlCycle entity in the S/4HANA system.
      Specified by:
      deleteKanbanControlCycle in interface KanbanControlCycleV2Service
      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 public KanbanCtnDetailedQtyFluentHelper getAllKanbanCtnDetailedQty()
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      Fetch multiple KanbanCtnDetailedQty entities.
      Specified by:
      getAllKanbanCtnDetailedQty in interface KanbanControlCycleV2Service
      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 public KanbanCtnDetailedQtyByKeyFluentHelper getKanbanCtnDetailedQtyByKey(String kanbanContainer, String batch)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      Fetch a single KanbanCtnDetailedQty entity using key fields.
      Specified by:
      getKanbanCtnDetailedQtyByKey in interface KanbanControlCycleV2Service
      Parameters:
      kanbanContainer - Kanban Identification Number

      Constraints: Not nullable, Maximum length: 10

      batch - Batch 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 public KanbanDeliveryFluentHelper getAllKanbanDelivery()
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      Fetch multiple KanbanDelivery entities.
      Specified by:
      getAllKanbanDelivery in interface KanbanControlCycleV2Service
      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 public KanbanDeliveryByKeyFluentHelper getKanbanDeliveryByKey(String kanbanContainer)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service
      Fetch a single KanbanDelivery entity using key fields.
      Specified by:
      getKanbanDeliveryByKey in interface KanbanControlCycleV2Service
      Parameters:
      kanbanContainer - Kanban Identification 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 public SetKanbanContainerStatusFluentHelper setKanbanContainerStatus(@Nonnull String kanbanContainer, @Nullable String kanbanContainerStatus, @Nullable BigDecimal actualQuantityInUnitOfEntry, @Nullable String unitOfEntry, @Nullable String batch, @Nullable ZonedDateTime kanbanCtnStatusChangeDateTime, @Nullable String deliveryNote)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service

      Creates a fluent helper for the SetKanbanContainerStatus OData function import.

      Specified by:
      setKanbanContainerStatus in interface KanbanControlCycleV2Service
      Parameters:
      kanbanContainer - Kanban ID

      Constraints: Not nullable, Maximum length: 10

      Original parameter name from the Odata EDM: KanbanContainer

      kanbanContainerStatus - Kanban Status

      Constraints: Nullable, Maximum length: 1

      Original parameter name from the Odata EDM: KanbanContainerStatus

      actualQuantityInUnitOfEntry - Actual Quantity

      Constraints: Nullable, Precision: 13, Scale: 3

      Original parameter name from the Odata EDM: ActualQuantityInUnitOfEntry

      unitOfEntry - Unit

      Constraints: Nullable, Maximum length: 3

      Original parameter name from the Odata EDM: UnitOfEntry

      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

      deliveryNote - Delivery note

      Constraints: Nullable, Maximum length: 16

      Original parameter name from the Odata EDM: DeliveryNote

      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 public SetKanbanContainerLockFluentHelper setKanbanContainerLock(@Nonnull String kanbanContainer, @Nonnull Boolean isLocked)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service

      Creates a fluent helper for the SetKanbanContainerLock OData function import.

      Specified by:
      setKanbanContainerLock in interface KanbanControlCycleV2Service
      Parameters:
      kanbanContainer - Kanban ID

      Constraints: Not nullable, Maximum length: 10

      Original parameter name from the Odata EDM: KanbanContainer

      isLocked - Kanban is Locked

      Constraints: none

      Original parameter name from the Odata EDM: IsLocked

      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 public SetKanbanControlCycleLifeCycleStatusFluentHelper setKanbanControlCycleLifeCycleStatus(@Nonnull String kanbanControlCycle, @Nonnull String kanbanCtrlCycleLifeCycleStatus)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service

      Creates a fluent helper for the SetKanbanControlCycleLifeCycleStatus OData function import.

      Specified by:
      setKanbanControlCycleLifeCycleStatus in interface KanbanControlCycleV2Service
      Parameters:
      kanbanControlCycle - Control Cycle

      Constraints: Not nullable, Maximum length: 7

      Original parameter name from the Odata EDM: KanbanControlCycle

      kanbanCtrlCycleLifeCycleStatus - Lifecycle Status

      Constraints: Not nullable, Maximum length: 1

      Original parameter name from the Odata EDM: KanbanCtrlCycleLifeCycleStatus

      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 public AddEventDrivenKanbanContainerFluentHelper addEventDrivenKanbanContainer(@Nonnull String kanbanControlCycle, @Nullable BigDecimal requestedQuantityInBaseUnit, @Nullable ZonedDateTime requestedDeliveryDateTime, @Nullable String packingInstruction, @Nullable Short numberOfLoadCarriers)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service

      Creates a fluent helper for the AddEventDrivenKanbanContainer OData function import.

      Specified by:
      addEventDrivenKanbanContainer in interface KanbanControlCycleV2Service
      Parameters:
      kanbanControlCycle - Control Cycle

      Constraints: Not nullable, Maximum length: 7

      Original parameter name from the Odata EDM: KanbanControlCycle

      requestedQuantityInBaseUnit - Requested Quantity

      Constraints: Nullable, Precision: 13, Scale: 3

      Original parameter name from the Odata EDM: RequestedQuantityInBaseUnit

      requestedDeliveryDateTime - Time Stamp

      Constraints: Nullable, Precision: 7

      Original parameter name from the Odata EDM: RequestedDeliveryDateTime

      packingInstruction - Packing instruction

      Constraints: Nullable, Maximum length: 20

      Original parameter name from the Odata EDM: PackingInstruction

      numberOfLoadCarriers - No.Load Carriers

      Constraints: Nullable

      Original parameter name from the Odata EDM: NumberOfLoadCarriers

      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 public WithdrawQuantityFromControlCycleFluentHelper withdrawQuantityFromControlCycle(@Nonnull String kanbanControlCycle, @Nonnull BigDecimal kanbanCtrlCycWthdrwlQtyInBsUnt)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service

      Creates a fluent helper for the WithdrawQuantityFromControlCycle OData function import.

      Specified by:
      withdrawQuantityFromControlCycle in interface KanbanControlCycleV2Service
      Parameters:
      kanbanControlCycle - Control Cycle

      Constraints: Not nullable, Maximum length: 7

      Original parameter name from the Odata EDM: KanbanControlCycle

      kanbanCtrlCycWthdrwlQtyInBsUnt - Withdrawal quantity

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

      Original parameter name from the Odata EDM: KanbanCtrlCycWthdrwlQtyInBsUnt

      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 public WithdrawQuantityFromKanbanContainerFluentHelper withdrawQuantityFromKanbanContainer(@Nonnull String kanbanContainer, @Nonnull BigDecimal kanbanCtnWithdrawalQtyInBsUnt)
      Deprecated.
      Description copied from interface: KanbanControlCycleV2Service

      Creates a fluent helper for the WithdrawQuantityFromKanbanContainer OData function import.

      Specified by:
      withdrawQuantityFromKanbanContainer in interface KanbanControlCycleV2Service
      Parameters:
      kanbanContainer - Kanban ID

      Constraints: Not nullable, Maximum length: 10

      Original parameter name from the Odata EDM: KanbanContainer

      kanbanCtnWithdrawalQtyInBsUnt - Withdrawal quantity

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

      Original parameter name from the Odata EDM: KanbanCtnWithdrawalQtyInBsUnt

      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.