
com.sap.cloud.sdk.s4hana.datamodel.odata.services.JournalEntryItemService Maven / Gradle / Ivy
/*
* 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.journalentryitem.CompanyCodeByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.CompanyCodeFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.CostCenterByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.CostCenterFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.JournalEntryItemBasicByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.JournalEntryItemBasicFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.ProfitCenterByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.ProfitCenterFluentHelper;
/**
*
* This service can be consumed by external applications to integrate with financial actual data processing. The service
* is designed to provide all financial actual data and detail-level information about assigned company code, cost
* center and profit center.
*
*
*
* Reference: SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_JOURNALENTRYITEMBASIC_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 JournalEntryItemService
{
/**
* 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_JOURNALENTRYITEMBASIC_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
JournalEntryItemService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.CompanyCode
* CompanyCode} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.CompanyCode CompanyCode}
* 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.journalentryitem.CompanyCodeFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
CompanyCodeFluentHelper getAllCompanyCode();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.CompanyCode
* CompanyCode} entity using key fields.
*
* @param companyCode
* The company code is an organizational unit within financial accounting.
*
* Constraints: Not nullable, Maximum length: 4
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.CompanyCode CompanyCode}
* 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.journalentryitem.CompanyCodeByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
CompanyCodeByKeyFluentHelper getCompanyCodeByKey( final String companyCode );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.CostCenter CostCenter}
* entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.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.journalentryitem.CostCenterFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
CostCenterFluentHelper getAllCostCenter();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.CostCenter CostCenter}
* entity using key fields.
*
* @param costCenter
* A key that uniquely identifies a cost center.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param controllingArea
* Uniquely identifies a controlling area.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param validityEndDate
* Date indicating up to when an entry is valid.
*
* Constraints: Not nullable, Precision: 0
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.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.journalentryitem.CostCenterByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
CostCenterByKeyFluentHelper getCostCenterByKey(
final String controllingArea,
final String costCenter,
final LocalDateTime validityEndDate );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.JournalEntryItemBasic
* JournalEntryItemBasic} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.JournalEntryItemBasic
* JournalEntryItemBasic} 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.journalentryitem.JournalEntryItemBasicFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
JournalEntryItemBasicFluentHelper getAllJournalEntryItemBasic();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.JournalEntryItemBasic
* JournalEntryItemBasic} entity using key fields.
*
* @param iD
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.JournalEntryItemBasic
* JournalEntryItemBasic} 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.journalentryitem.JournalEntryItemBasicByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
JournalEntryItemBasicByKeyFluentHelper getJournalEntryItemBasicByKey( final String iD );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.ProfitCenter
* ProfitCenter} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.ProfitCenter ProfitCenter}
* 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.journalentryitem.ProfitCenterFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ProfitCenterFluentHelper getAllProfitCenter();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.ProfitCenter
* ProfitCenter} entity using key fields.
*
* @param controllingArea
* Uniquely identifies a controlling area.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param profitCenter
* Key which together with the controlling area uniquely identifies a profit center.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param validityEndDate
* Date indicating up to when an entry is valid.
*
* Constraints: Not nullable, Precision: 0
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.journalentryitem.ProfitCenter ProfitCenter}
* 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.journalentryitem.ProfitCenterByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ProfitCenterByKeyFluentHelper getProfitCenterByKey(
final String controllingArea,
final String profitCenter,
final LocalDateTime validityEndDate );
}