com.sap.cloud.sdk.s4hana.datamodel.odata.services.SegmentService 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.segment.SegmentByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.segment.SegmentFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.segment.SegmentTextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.segment.SegmentTextFluentHelper;

/**
 * 
 * This service enables you to read segment 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_SEGMENT_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 SegmentService
{

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

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.segment.Segment Segment} entity using
     * key fields.
     * 
     * @param segment
     *            Segment for Segmental Reporting
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.segment.Segment Segment} 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.segment.SegmentByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    SegmentByKeyFluentHelper getSegmentByKey( final String segment );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.segment.SegmentText SegmentText} entity
     * using key fields.
     * 
     * @param segment
     *            Segment for Segmental Reporting
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param language
     *            The language key indicates
     *            
     *            Constraints: Not nullable, Maximum length: 2
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.segment.SegmentText SegmentText} 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.segment.SegmentTextByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    SegmentTextByKeyFluentHelper getSegmentTextByKey( final String language, final String segment );

}
OData Service:	API_SEGMENT_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)