com.sap.cloud.sdk.s4hana.datamodel.odata.services.CostCenterTestService 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.time.LocalDateTime;

import javax.annotation.Nonnull;

import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costcentertest.CostCenterByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costcentertest.CostCenterFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costcentertest.CostCenterTextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costcentertest.CostCenterTextFluentHelper;

/**
 * 
 * Cost Center Data Provider.
 * 
 * 
 * Reference: SAP API
 * Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: FCO_PI_COST_CENTER
API Version: 1
 * 
 */
public interface CostCenterTestService
{

    /**
     * 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/FCO_PI_COST_CENTER";

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

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costcentertest.CostCenter CostCenter}
     * entity using key fields.
     * 
     * @param companyCode
     *            Company Code
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param costCenterID
     *            Cost Center
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param validityEndDate
     *            Valid To
     *            
     *            Constraints: Not nullable, Precision: 0
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costcentertest.CostCenter CostCenter} 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.costcentertest.CostCenterByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CostCenterByKeyFluentHelper
        getCostCenterByKey( final String companyCode, final String costCenterID, final LocalDateTime validityEndDate );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costcentertest.CostCenterText
     * CostCenterText} entity using key fields.
     * 
     * @param companyCode
     *            Company Code
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param costCenterID
     *            Cost Center
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param language
     *            Language Key
     *            
     *            Constraints: Not nullable, Maximum length: 2
     *            
     * @param validityEndDate
     *            Valid To
     *            
     *            Constraints: Not nullable, Precision: 0
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costcentertest.CostCenterText CostCenterText}
     *         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.costcentertest.CostCenterTextByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CostCenterTextByKeyFluentHelper getCostCenterTextByKey(
        final String companyCode,
        final String costCenterID,
        final LocalDateTime validityEndDate,
        final String language );

}