com.sap.cloud.sdk.s4hana.datamodel.odata.services.KanbanControlCycleService 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 java.time.ZonedDateTime;
import javax.annotation.Nonnull;
import com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanContainerByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanContainerFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycle;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycleByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycleCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycleFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycleUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanCtnDetailedQtyByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanCtnDetailedQtyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanDeliveryByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanDeliveryFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.SetKanbanContainerLockFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.SetKanbanContainerStatusFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.SetKanbanControlCycleLifeCycleStatusFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.batch.KanbanControlCycleServiceBatch;
/**
*
* This service 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.
*
* The service is based on the OData protocol, and can be consumed by external systems and user interfaces..
*
*
*
* Reference: SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_KANBAN_CONTROL_CYCLE_SRV
*
*
* API Version:
* 2
*
*
* Communication Scenario:
* Kanban Control Cycle Integration (SAP_COM_0330)
*
*
* Scope Items:
* Manufacturing with Kanban Supply into Production
* (1E3)
*
*
* Authentication Methods:
* Basic, x509
*
*
*
*/
public interface KanbanControlCycleService 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_KANBAN_CONTROL_CYCLE_SRV;v=0002";
/**
* 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
KanbanControlCycleService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanContainer
* KanbanContainer} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanContainer
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanContainerFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
KanbanContainerFluentHelper getAllKanbanContainer();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanContainer
* KanbanContainer} entity using key fields.
*
* @param kanbanContainer
* Determines the Kanban number.
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanContainer
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanContainerByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
KanbanContainerByKeyFluentHelper getKanbanContainerByKey( final String kanbanContainer );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycle
* KanbanControlCycle} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycle
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycleFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
KanbanControlCycleFluentHelper getAllKanbanControlCycle();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycle
* KanbanControlCycle} entity using key fields.
*
* @param kanbanControlCycle
* Number, that specifically identifies the control cycle.
*
* Constraints: Not nullable, Maximum length: 7
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycle
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycleByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
KanbanControlCycleByKeyFluentHelper getKanbanControlCycleByKey( final String kanbanControlCycle );
/**
* Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycle
* KanbanControlCycle} entity and save it to the S/4HANA system.
*
* @param kanbanControlCycle
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycle
* KanbanControlCycle} entity object that will be created in the S/4HANA system.
* @return A fluent helper to create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycle
* KanbanControlCycle} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycleCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
KanbanControlCycleCreateFluentHelper
createKanbanControlCycle( @Nonnull final KanbanControlCycle kanbanControlCycle );
/**
* Update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycle
* KanbanControlCycle} entity and save it to the S/4HANA system.
*
* @param kanbanControlCycle
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycle
* KanbanControlCycle} entity object that will be updated in the S/4HANA system.
* @return A fluent helper to update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycle
* KanbanControlCycle} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanControlCycleUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
KanbanControlCycleUpdateFluentHelper
updateKanbanControlCycle( @Nonnull final KanbanControlCycle kanbanControlCycle );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanCtnDetailedQty
* KanbanCtnDetailedQty} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanCtnDetailedQty
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanCtnDetailedQtyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
KanbanCtnDetailedQtyFluentHelper getAllKanbanCtnDetailedQty();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanCtnDetailedQty
* KanbanCtnDetailedQty} entity using key fields.
*
* @param batch
* Assigns a material that is manufactured in batches or production lots to a specific batch.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param kanbanContainer
* Determines the Kanban number.
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanCtnDetailedQty
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanCtnDetailedQtyByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
KanbanCtnDetailedQtyByKeyFluentHelper
getKanbanCtnDetailedQtyByKey( final String kanbanContainer, final String batch );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanDelivery
* KanbanDelivery} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanDelivery
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanDeliveryFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
KanbanDeliveryFluentHelper getAllKanbanDelivery();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanDelivery
* KanbanDelivery} entity using key fields.
*
* @param kanbanContainer
* Determines the Kanban number.
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanDelivery
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanDeliveryByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
KanbanDeliveryByKeyFluentHelper getKanbanDeliveryByKey( final String kanbanContainer );
/**
* Set Kanban Container Status
*
*
*
* Creates a fluent helper for the SetKanbanContainerStatus OData function import.
*
*
* @param actualQuantityInUnitOfEntry
* Actual Quantity
*
*
*
* Constraints: Nullable, Precision: 13, Scale: 3
*
*
* Original parameter name from the Odata EDM: ActualQuantityInUnitOfEntry
*
* @param deliveryNote
* Delivery note
*
*
*
* Constraints: Nullable, Maximum length: 16
*
*
* Original parameter name from the Odata EDM: DeliveryNote
*
* @param kanbanContainerStatus
* Kanban Status
*
*
*
* Constraints: Nullable, Maximum length: 1
*
*
* Original parameter name from the Odata EDM: KanbanContainerStatus
*
* @param batch
* Batch
*
*
*
* Constraints: Nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: Batch
*
* @param kanbanCtnStatusChangeDateTime
* Time Stamp
*
*
*
* Constraints: Nullable, Precision: 7
*
*
* Original parameter name from the Odata EDM: KanbanCtnStatusChangeDateTime
*
* @param kanbanContainer
* Kanban ID
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: KanbanContainer
*
* @param unitOfEntry
* Unit
*
*
*
* Constraints: Nullable, Maximum length: 3
*
*
* Original parameter name from the Odata EDM: UnitOfEntry
*
* @return A fluent helper object that will execute the SetKanbanContainerStatus OData function import with
* the provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.SetKanbanContainerStatusFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SetKanbanContainerStatusFluentHelper setKanbanContainerStatus(
final String kanbanContainer,
final String kanbanContainerStatus,
final BigDecimal actualQuantityInUnitOfEntry,
final String unitOfEntry,
final String batch,
final ZonedDateTime kanbanCtnStatusChangeDateTime,
final String deliveryNote );
/**
* Set Kanban Container Lock
*
*
*
* Creates a fluent helper for the SetKanbanContainerLock OData function import.
*
*
* @param isLocked
* Kanban is Blocked
*
*
*
* Constraints: none
*
*
* Original parameter name from the Odata EDM: IsLocked
*
* @param kanbanContainer
* Kanban ID
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: KanbanContainer
*
* @return A fluent helper object that will execute the SetKanbanContainerLock OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.SetKanbanContainerLockFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SetKanbanContainerLockFluentHelper setKanbanContainerLock( final String kanbanContainer, final Boolean isLocked );
/**
* Set Kanban Control Cycle Life Cycle Status
*
*
*
* Creates a fluent helper for the SetKanbanControlCycleLifeCycleStatus OData function import.
*
*
* @param kanbanCtrlCycleLifeCycleStatus
* Lifecycle Stat.
*
*
*
* Constraints: Not nullable, Maximum length: 1
*
*
* Original parameter name from the Odata EDM: KanbanCtrlCycleLifeCycleStatus
*
* @param kanbanControlCycle
* Control Cycle
*
*
*
* Constraints: Not nullable, Maximum length: 7
*
*
* Original parameter name from the Odata EDM: KanbanControlCycle
*
* @return A fluent helper object that will execute the SetKanbanControlCycleLifeCycleStatus OData function
* import with the provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.SetKanbanControlCycleLifeCycleStatusFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SetKanbanControlCycleLifeCycleStatusFluentHelper setKanbanControlCycleLifeCycleStatus(
final String kanbanControlCycle,
final String kanbanCtrlCycleLifeCycleStatus );
}