com.sap.cloud.sdk.s4hana.datamodel.odata.services.WarehouseResourceService 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 javax.annotation.Nonnull;

import com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.LogoffFromWarehouseResourceFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.LogonToWarehouseResourceFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResource;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResourceByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResourceCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResourceDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResourceFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.batch.WarehouseResourceServiceBatch;

/**
 * 
 * You can use this service to integrate external applications with warehouse resources in SAP S/4HANA Cloud. In every
 * API call, you can make use of the following operations: - You can retrieve warehouse resources. Apply any of the
 * filters provided or retrieve all existing data. - You can create and delete warehouse resources. - You can update
 * existing warehouse resources (log on, log off)..
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_WAREHOUSE_RESOURCE
API Version: 1
Communication Scenario: Warehousing - Process Warehouse Task Integration (SAP_COM_0353)
Scope Items: Resource Management in Warehousing (3W0)
Authentication Methods: Basic, x509, OAuth2
Business Object: WarehouseResource
 * 
 */
public interface WarehouseResourceService 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_WAREHOUSE_RESOURCE";

    /**
     * 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
    WarehouseResourceService withServicePath( @Nonnull final String servicePath );

    /**
     * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResource
     * WarehouseResource} entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResource
     *         WarehouseResource} 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.warehouseresource.WarehouseResourceFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    WarehouseResourceFluentHelper getAllWarehouseResource();

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResource
     * WarehouseResource} entity using key fields.
     * 
     * @param warehouseResource
     *            Resource (Means of Transportation or User)
     *            
     *            Constraints: Not nullable, Maximum length: 18
     *            
     * @param warehouse
     *            Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResource
     *         WarehouseResource} 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.warehouseresource.WarehouseResourceByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    WarehouseResourceByKeyFluentHelper
        getWarehouseResourceByKey( final String warehouse, final String warehouseResource );

    /**
     * Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResource
     * WarehouseResource} entity and save it to the S/4HANA system.
     * 
     * @param warehouseResource
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResource
     *            WarehouseResource} 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.warehouseresource.WarehouseResource
     *         WarehouseResource} entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResourceCreateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    WarehouseResourceCreateFluentHelper createWarehouseResource( @Nonnull final WarehouseResource warehouseResource );

    /**
     * Deletes an existing
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResource WarehouseResource}
     * entity in the S/4HANA system.
     * 
     * @param warehouseResource
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResource
     *            WarehouseResource} entity object that will be deleted in the S/4HANA system.
     * @return A fluent helper to delete an existing
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResource
     *         WarehouseResource} entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.WarehouseResourceDeleteFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    WarehouseResourceDeleteFluentHelper deleteWarehouseResource( @Nonnull final WarehouseResource warehouseResource );

    /**
     * 
     * Creates a fluent helper for the LogoffFromWarehouseResource OData function import.
     * 
     * 
     * @param warehouseResource
     *            Resource
     *            
     *            
     *            
     *            Constraints: Not nullable, Maximum length: 18
     *            
     *            
     *            Original parameter name from the Odata EDM: WarehouseResource
     *            
     * @param warehouse
     *            Warehouse Number
     *            
     *            
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     *            
     *            Original parameter name from the Odata EDM: Warehouse
     *            
     * @return A fluent helper object that will execute the LogoffFromWarehouseResource OData function import
     *         with the provided parameters. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.LogoffFromWarehouseResourceFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    LogoffFromWarehouseResourceFluentHelper
        logoffFromWarehouseResource( final String warehouse, final String warehouseResource );

    /**
     * 
     * Creates a fluent helper for the LogonToWarehouseResource OData function import.
     * 
     * 
     * @param warehouseResource
     *            Resource
     *            
     *            
     *            
     *            Constraints: Not nullable, Maximum length: 18
     *            
     *            
     *            Original parameter name from the Odata EDM: WarehouseResource
     *            
     * @param warehouse
     *            Warehouse Number
     *            
     *            
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     *            
     *            Original parameter name from the Odata EDM: Warehouse
     *            
     * @return A fluent helper object that will execute the LogonToWarehouseResource OData function import with
     *         the provided parameters. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseresource.LogonToWarehouseResourceFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    LogonToWarehouseResourceFluentHelper
        logonToWarehouseResource( final String warehouse, final String warehouseResource );

}
OData Service:	API_WAREHOUSE_RESOURCE
API Version:	1
Communication Scenario:	Warehousing - Process Warehouse Task Integration (SAP_COM_0353)
Scope Items:	Resource Management in Warehousing (3W0)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	WarehouseResource