com.sap.cloud.sdk.s4hana.datamodel.odata.services.TradingPartnerService 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.namespaces.tradingpartner.PartnerCompanyByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.tradingpartner.PartnerCompanyFluentHelper;

/**
 * 
 * This service enables you to read trading partner master data in an API call. It is based on the OData protocol, and
 * can be consumed in Fiori apps and on other user interfaces.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_PARTNERCOMPANY_SRV
API Version: 1
Communication Scenario: SAP Business Objects Cloud for Planning Integration (SAP_COM_0087)
Scope Items: oData Integration with SAP Business Objects Cloud for
 * Planning (1YB)
 * 
 */
public interface TradingPartnerService
{

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

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

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.tradingpartner.PartnerCompany
     * PartnerCompany} entity using key fields.
     * 
     * @param partnerCompany
     *            Unique company ID of a company within your corporate group.
     *            
     *            Constraints: Not nullable, Maximum length: 6
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.tradingpartner.PartnerCompany PartnerCompany}
     *         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.tradingpartner.PartnerCompanyByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    PartnerCompanyByKeyFluentHelper getPartnerCompanyByKey( final String partnerCompany );

}
OData Service:	API_PARTNERCOMPANY_SRV
API Version:	1
Communication Scenario:	SAP Business Objects Cloud for Planning Integration (SAP_COM_0087)
Scope Items:	oData Integration with SAP Business Objects Cloud for * Planning (1YB)