com.sap.cloud.sdk.s4hana.datamodel.odata.services.TreasuryPositionFlowService 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.util.UUID;

import javax.annotation.Nonnull;

import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.treasurypositionflow.TrsyPosFlowByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.treasurypositionflow.TrsyPosFlowFluentHelper;

/**
 * 
 * This inbound service enables you to read treasury position flows to get detailed information about the treasury
 * positions flows. 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_TRSYPOSFLOW_SRV
API Version: 1
Communication Scenario: Treasury Position Flow Integration (SAP_COM_0332)
Scope Items: Market Data for Treasury and Risk Management (1XN)
Authentication Methods: Basic, x509, OAuth2
 * 
 */
public interface TreasuryPositionFlowService
{

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

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

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.treasurypositionflow.TrsyPosFlow
     * TrsyPosFlow} entity using key fields.
     * 
     * @param businessTransactionDocUUID
     *            Business Transaction (GUID)
     *            
     *            Constraints: Not nullable
     *            
     * @param treasuryTransactionFlow
     *            Number of TRL Flow
     *            
     *            Constraints: Not nullable
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.treasurypositionflow.TrsyPosFlow TrsyPosFlow}
     *         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.treasurypositionflow.TrsyPosFlowByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    TrsyPosFlowByKeyFluentHelper
        getTrsyPosFlowByKey( final Integer treasuryTransactionFlow, final UUID businessTransactionDocUUID );

}
OData Service:	API_TRSYPOSFLOW_SRV
API Version:	1
Communication Scenario:	Treasury Position Flow Integration (SAP_COM_0332)
Scope Items:	Market Data for Treasury and Risk Management (1XN)
Authentication Methods:	Basic, x509, OAuth2