com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultKanbanControlCycleService Maven / Gradle / Ivy

Go to download
/*
 * 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 javax.inject.Named;

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.DefaultKanbanControlCycleServiceBatch;

/**
 * 
 * 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..
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * 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
 * 
 */
@Named( "com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultKanbanControlCycleService" )
public class DefaultKanbanControlCycleService implements KanbanControlCycleService
{

    @Nonnull
    private final String servicePath;

    /**
     * Creates a service using {@link KanbanControlCycleService#DEFAULT_SERVICE_PATH} to send the requests.
     * 
     */
    public DefaultKanbanControlCycleService()
    {
        servicePath = KanbanControlCycleService.DEFAULT_SERVICE_PATH;
    }

    /**
     * Creates a service using the provided service path to send the requests.
     * 
     * Used by the fluent {@link #withServicePath(String)} method.
     * 
     */
    private DefaultKanbanControlCycleService( @Nonnull final String servicePath )
    {
        this.servicePath = servicePath;
    }

    @Override
    @Nonnull
    public DefaultKanbanControlCycleService withServicePath( @Nonnull final String servicePath )
    {
        return new DefaultKanbanControlCycleService(servicePath);
    }

    /**
     * {@inheritDoc}
     * 
     */
    @Override
    @Nonnull
    public DefaultKanbanControlCycleServiceBatch batch()
    {
        return new DefaultKanbanControlCycleServiceBatch(this);
    }

    @Override
    @Nonnull
    public KanbanContainerFluentHelper getAllKanbanContainer()
    {
        return new KanbanContainerFluentHelper(servicePath);
    }

    @Override
    @Nonnull
    public KanbanContainerByKeyFluentHelper getKanbanContainerByKey( final String kanbanContainer )
    {
        return new KanbanContainerByKeyFluentHelper(servicePath, kanbanContainer);
    }

    @Override
    @Nonnull
    public KanbanControlCycleFluentHelper getAllKanbanControlCycle()
    {
        return new KanbanControlCycleFluentHelper(servicePath);
    }

    @Override
    @Nonnull
    public KanbanControlCycleByKeyFluentHelper getKanbanControlCycleByKey( final String kanbanControlCycle )
    {
        return new KanbanControlCycleByKeyFluentHelper(servicePath, kanbanControlCycle);
    }

    @Override
    @Nonnull
    public KanbanControlCycleCreateFluentHelper createKanbanControlCycle(
        @Nonnull final KanbanControlCycle kanbanControlCycle )
    {
        return new KanbanControlCycleCreateFluentHelper(servicePath, kanbanControlCycle);
    }

    @Override
    @Nonnull
    public KanbanControlCycleUpdateFluentHelper updateKanbanControlCycle(
        @Nonnull final KanbanControlCycle kanbanControlCycle )
    {
        return new KanbanControlCycleUpdateFluentHelper(servicePath, kanbanControlCycle);
    }

    @Override
    @Nonnull
    public KanbanCtnDetailedQtyFluentHelper getAllKanbanCtnDetailedQty()
    {
        return new KanbanCtnDetailedQtyFluentHelper(servicePath);
    }

    @Override
    @Nonnull
    public
        KanbanCtnDetailedQtyByKeyFluentHelper
        getKanbanCtnDetailedQtyByKey( final String kanbanContainer, final String batch )
    {
        return new KanbanCtnDetailedQtyByKeyFluentHelper(servicePath, kanbanContainer, batch);
    }

    @Override
    @Nonnull
    public KanbanDeliveryFluentHelper getAllKanbanDelivery()
    {
        return new KanbanDeliveryFluentHelper(servicePath);
    }

    @Override
    @Nonnull
    public KanbanDeliveryByKeyFluentHelper getKanbanDeliveryByKey( final String kanbanContainer )
    {
        return new KanbanDeliveryByKeyFluentHelper(servicePath, kanbanContainer);
    }

    @Override
    @Nonnull
    public SetKanbanContainerStatusFluentHelper setKanbanContainerStatus(
        final String kanbanContainer,
        final String kanbanContainerStatus,
        final BigDecimal actualQuantityInUnitOfEntry,
        final String unitOfEntry,
        final String batch,
        final ZonedDateTime kanbanCtnStatusChangeDateTime,
        final String deliveryNote )
    {
        return new SetKanbanContainerStatusFluentHelper(
            servicePath,
            kanbanContainer,
            kanbanContainerStatus,
            actualQuantityInUnitOfEntry,
            unitOfEntry,
            batch,
            kanbanCtnStatusChangeDateTime,
            deliveryNote);
    }

    @Override
    @Nonnull
    public
        SetKanbanContainerLockFluentHelper
        setKanbanContainerLock( final String kanbanContainer, final Boolean isLocked )
    {
        return new SetKanbanContainerLockFluentHelper(servicePath, kanbanContainer, isLocked);
    }

    @Override
    @Nonnull
    public SetKanbanControlCycleLifeCycleStatusFluentHelper setKanbanControlCycleLifeCycleStatus(
        final String kanbanControlCycle,
        final String kanbanCtrlCycleLifeCycleStatus )
    {
        return new SetKanbanControlCycleLifeCycleStatusFluentHelper(
            servicePath,
            kanbanControlCycle,
            kanbanCtrlCycleLifeCycleStatus);
    }

}
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