com.sap.cloud.sdk.s4hana.datamodel.odata.services.LineItemOfTreasuryPostingJournalEntryService 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.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.lineitemoftreasurypostingjournalentry.TrsyPostgJrnlEntrItmByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.lineitemoftreasurypostingjournalentry.TrsyPostgJrnlEntrItmFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.lineitemoftreasurypostingjournalentry.batch.LineItemOfTreasuryPostingJournalEntryServiceBatch;

/**
 * 
 * This inbound service enables you to read line items belonging to treasury posting journal entries. This gives you
 * detailed information about the posted and reversed flows of financial transactions and treasury positions. 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_TRSYPOSTGJRNLENTRITM_SRV
API Version: 1
Communication Scenario: Treasury Posting Journal Integration (SAP_COM_0333)
Scope Items: Market Data for Treasury and Risk Management (1XN)
Authentication Methods: Basic, x509, OAuth2
 * 
 */
public interface LineItemOfTreasuryPostingJournalEntryService
    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/A_TRSYPOSTGJRNLENTRITM_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
    LineItemOfTreasuryPostingJournalEntryService withServicePath( @Nonnull final String servicePath );

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.lineitemoftreasurypostingjournalentry.TrsyPostgJrnlEntrItm
     * TrsyPostgJrnlEntrItm} entity using key fields.
     * 
     * @param trsyPositionContextUUID
     *            Object Identity in Database Format
     *            
     *            Constraints: Not nullable
     *            
     * @param trsyAccountingDocumentUUID
     *            Object Identity in Database Format
     *            
     *            Constraints: Not nullable
     *            
     * @param accountingDocumentItemRef
     *            Line item number of the accounting document.
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.lineitemoftreasurypostingjournalentry.TrsyPostgJrnlEntrItm
     *         TrsyPostgJrnlEntrItm} 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.lineitemoftreasurypostingjournalentry.TrsyPostgJrnlEntrItmByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    TrsyPostgJrnlEntrItmByKeyFluentHelper getTrsyPostgJrnlEntrItmByKey(
        final UUID trsyAccountingDocumentUUID,
        final String accountingDocumentItemRef,
        final UUID trsyPositionContextUUID );

}
OData Service:	API_TRSYPOSTGJRNLENTRITM_SRV
API Version:	1
Communication Scenario:	Treasury Posting Journal Integration (SAP_COM_0333)
Scope Items:	Market Data for Treasury and Risk Management (1XN)
Authentication Methods:	Basic, x509, OAuth2