com.sap.cloud.sdk.s4hana.datamodel.odata.services.EnterpriseProjectService 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.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.enterpriseproject.EntProjectElementJVA;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EntProjectElementJVAByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EntProjectElementJVAFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EntProjectElementJVAUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElementByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElementCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElementDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElementFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElementUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectJVA;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectJVAByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectJVAFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectJVAUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.SetProcessingStatusFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.SetProjElemProcessingStatusFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.batch.EnterpriseProjectServiceBatch;
/**
*
* This service enables you to read, create, update and delete the project definition and to read the project elements
* of enterprise projects.
*
*
*
* Reference: SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_ENTERPRISE_PROJECT_SRV
*
*
* API Version:
* 1
*
*
* Communication Scenario:
* Enterprise Project - Create, Read, Update, Delete Integration (SAP_COM_0308)
*
*
* Scope Items:
* Project Financial Control (1NT),
* Project Review (1YF)
*
*
* Authentication Methods:
* Basic, x509
*
*
*
*/
public interface EnterpriseProjectService 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/API_ENTERPRISE_PROJECT_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
EnterpriseProjectService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject
* EnterpriseProject} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject
* EnterpriseProject} 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.enterpriseproject.EnterpriseProjectFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EnterpriseProjectFluentHelper getAllEnterpriseProject();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject
* EnterpriseProject} entity using key fields.
*
* @param projectUUID
* Entity Guid
*
* Constraints: Not nullable
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject
* EnterpriseProject} 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.enterpriseproject.EnterpriseProjectByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EnterpriseProjectByKeyFluentHelper getEnterpriseProjectByKey( final UUID projectUUID );
/**
* Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject
* EnterpriseProject} entity and save it to the S/4HANA system.
*
* @param enterpriseProject
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject
* EnterpriseProject} entity object that will be created in the S/4HANA system.
* @return A fluent helper to create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject
* EnterpriseProject} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EnterpriseProjectCreateFluentHelper createEnterpriseProject( @Nonnull final EnterpriseProject enterpriseProject );
/**
* Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject
* EnterpriseProject} entity and save it to the S/4HANA system.
*
* @param enterpriseProject
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject
* EnterpriseProject} entity object that will be updated in the S/4HANA system.
* @return A fluent helper to update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject
* EnterpriseProject} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EnterpriseProjectUpdateFluentHelper updateEnterpriseProject( @Nonnull final EnterpriseProject enterpriseProject );
/**
* Deletes an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject EnterpriseProject}
* entity in the S/4HANA system.
*
* @param enterpriseProject
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject
* EnterpriseProject} entity object that will be deleted in the S/4HANA system.
* @return A fluent helper to delete an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProject
* EnterpriseProject} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectDeleteFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EnterpriseProjectDeleteFluentHelper deleteEnterpriseProject( @Nonnull final EnterpriseProject enterpriseProject );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement
* EnterpriseProjectElement} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement
* EnterpriseProjectElement} 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.enterpriseproject.EnterpriseProjectElementFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EnterpriseProjectElementFluentHelper getAllEnterpriseProjectElement();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement
* EnterpriseProjectElement} entity using key fields.
*
* @param projectElementUUID
* Entity Guid
*
* Constraints: Not nullable
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement
* EnterpriseProjectElement} 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.enterpriseproject.EnterpriseProjectElementByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EnterpriseProjectElementByKeyFluentHelper getEnterpriseProjectElementByKey( final UUID projectElementUUID );
/**
* Create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement
* EnterpriseProjectElement} entity and save it to the S/4HANA system.
*
* @param enterpriseProjectElement
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement
* EnterpriseProjectElement} entity object that will be created in the S/4HANA system.
* @return A fluent helper to create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement
* EnterpriseProjectElement} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElementCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EnterpriseProjectElementCreateFluentHelper
createEnterpriseProjectElement( @Nonnull final EnterpriseProjectElement enterpriseProjectElement );
/**
* Update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement
* EnterpriseProjectElement} entity and save it to the S/4HANA system.
*
* @param enterpriseProjectElement
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement
* EnterpriseProjectElement} entity object that will be updated in the S/4HANA system.
* @return A fluent helper to update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement
* EnterpriseProjectElement} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElementUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EnterpriseProjectElementUpdateFluentHelper
updateEnterpriseProjectElement( @Nonnull final EnterpriseProjectElement enterpriseProjectElement );
/**
* Deletes an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement
* EnterpriseProjectElement} entity in the S/4HANA system.
*
* @param enterpriseProjectElement
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement
* EnterpriseProjectElement} entity object that will be deleted in the S/4HANA system.
* @return A fluent helper to delete an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElement
* EnterpriseProjectElement} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectElementDeleteFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EnterpriseProjectElementDeleteFluentHelper
deleteEnterpriseProjectElement( @Nonnull final EnterpriseProjectElement enterpriseProjectElement );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectJVA
* EnterpriseProjectJVA} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectJVA
* EnterpriseProjectJVA} 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.enterpriseproject.EnterpriseProjectJVAFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EnterpriseProjectJVAFluentHelper getAllEnterpriseProjectJVA();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectJVA
* EnterpriseProjectJVA} entity using key fields.
*
* @param projectUUID
* Entity Guid
*
* Constraints: Not nullable
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectJVA
* EnterpriseProjectJVA} 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.enterpriseproject.EnterpriseProjectJVAByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EnterpriseProjectJVAByKeyFluentHelper getEnterpriseProjectJVAByKey( final UUID projectUUID );
/**
* Update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectJVA
* EnterpriseProjectJVA} entity and save it to the S/4HANA system.
*
* @param enterpriseProjectJVA
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectJVA
* EnterpriseProjectJVA} entity object that will be updated in the S/4HANA system.
* @return A fluent helper to update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectJVA
* EnterpriseProjectJVA} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EnterpriseProjectJVAUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EnterpriseProjectJVAUpdateFluentHelper
updateEnterpriseProjectJVA( @Nonnull final EnterpriseProjectJVA enterpriseProjectJVA );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EntProjectElementJVA
* EntProjectElementJVA} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EntProjectElementJVA
* EntProjectElementJVA} 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.enterpriseproject.EntProjectElementJVAFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EntProjectElementJVAFluentHelper getAllEntProjectElementJVA();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EntProjectElementJVA
* EntProjectElementJVA} entity using key fields.
*
* @param projectElementUUID
* Entity Guid
*
* Constraints: Not nullable
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EntProjectElementJVA
* EntProjectElementJVA} 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.enterpriseproject.EntProjectElementJVAByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EntProjectElementJVAByKeyFluentHelper getEntProjectElementJVAByKey( final UUID projectElementUUID );
/**
* Update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EntProjectElementJVA
* EntProjectElementJVA} entity and save it to the S/4HANA system.
*
* @param entProjectElementJVA
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EntProjectElementJVA
* EntProjectElementJVA} entity object that will be updated in the S/4HANA system.
* @return A fluent helper to update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EntProjectElementJVA
* EntProjectElementJVA} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.EntProjectElementJVAUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
EntProjectElementJVAUpdateFluentHelper
updateEntProjectElementJVA( @Nonnull final EntProjectElementJVA entProjectElementJVA );
/**
*
* Creates a fluent helper for the SetProcessingStatus OData function import.
*
*
* @param processingStatus
* Processing Status
*
*
*
* Constraints: Nullable, Maximum length: 2
*
*
* Original parameter name from the Odata EDM: ProcessingStatus
*
* @param projectUUID
* Entity GUID
*
*
*
* Constraints: none
*
*
* Original parameter name from the Odata EDM: ProjectUUID
*
* @return A fluent helper object that will execute the SetProcessingStatus OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.SetProcessingStatusFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SetProcessingStatusFluentHelper setProcessingStatus( final UUID projectUUID, final String processingStatus );
/**
*
* Creates a fluent helper for the SetProjElemProcessingStatus OData function import.
*
*
* @param processingStatus
* Processing Status
*
*
*
* Constraints: Nullable, Maximum length: 2
*
*
* Original parameter name from the Odata EDM: ProcessingStatus
*
* @param projectElementUUID
* Entity GUID
*
*
*
* Constraints: none
*
*
* Original parameter name from the Odata EDM: ProjectElementUUID
*
* @return A fluent helper object that will execute the SetProjElemProcessingStatus OData function import
* with the provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.enterpriseproject.SetProjElemProcessingStatusFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SetProjElemProcessingStatusFluentHelper
setProjElemProcessingStatus( final UUID projectElementUUID, final String processingStatus );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy