• Home
• com.sap.cloud.s4hana.datamodel
• odata-api
• 2.12.0
• source code
• CommercialProjectService.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.sap.cloud.sdk.s4hana.datamodel.odata.services.CommercialProjectService 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 javax.annotation.Nonnull;

import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.Demand;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.DemandCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.DemandDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.DemandUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.Project;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.ProjectCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.ProjectUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkItem;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkItemCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkItemDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkPackage;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkPackageCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkPackageDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkPackageUpdateFluentHelper;

/**
 * 

 * This service enables you to create and update commercial projects in a SAP S/4HANA Cloud system. For example, you can
 * use this service to create a customer or internal project based on an opportunity or a quotation.
 * 
 * 

 * Business
 * Documentation
 * 
 * 

 * Reference: SAP
 * API Business Hub
 * 
 * 
Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
OData Service:
_CPD_SC_PROJ_ENGMT_CREATE_UPD_SRV
API Version:
1
Communication Scenario:
Commercial Project Integration (SAP_COM_0054)
Scope Items:
Internal Project Management (1A8),
 * Customer Project Management (J11)
 * 
 */
public interface CommercialProjectService
{

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

    /**
     * Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.Project Project} entity
     * and save it to the S/4HANA system.
     * 
     * @param project
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.Project Project} 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.commercialproject.Project Project} entity. To
     *         perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.ProjectCreateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProjectCreateFluentHelper createProject( @Nonnull final Project project );

    /**
     * Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.Project Project}
     * entity and save it to the S/4HANA system.
     * 
     * @param project
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.Project Project} 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.commercialproject.Project Project} entity. To
     *         perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.ProjectUpdateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProjectUpdateFluentHelper updateProject( @Nonnull final Project project );

    /**
     * Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkPackage
     * WorkPackage} entity and save it to the S/4HANA system.
     * 
     * @param workPackage
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkPackage WorkPackage}
     *            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.commercialproject.WorkPackage WorkPackage}
     *         entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkPackageCreateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    WorkPackageCreateFluentHelper createWorkPackage( @Nonnull final WorkPackage workPackage );

    /**
     * Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkPackage
     * WorkPackage} entity and save it to the S/4HANA system.
     * 
     * @param workPackage
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkPackage WorkPackage}
     *            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.commercialproject.WorkPackage WorkPackage}
     *         entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkPackageUpdateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    WorkPackageUpdateFluentHelper updateWorkPackage( @Nonnull final WorkPackage workPackage );

    /**
     * Deletes an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkPackage
     * WorkPackage} entity in the S/4HANA system.
     * 
     * @param workPackage
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkPackage WorkPackage}
     *            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.commercialproject.WorkPackage WorkPackage}
     *         entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkPackageDeleteFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    WorkPackageDeleteFluentHelper deleteWorkPackage( @Nonnull final WorkPackage workPackage );

    /**
     * Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkItem WorkItem}
     * entity and save it to the S/4HANA system.
     * 
     * @param workItem
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkItem WorkItem} 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.commercialproject.WorkItem WorkItem} entity.
     *         To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkItemCreateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    WorkItemCreateFluentHelper createWorkItem( @Nonnull final WorkItem workItem );

    /**
     * Deletes an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkItem
     * WorkItem} entity in the S/4HANA system.
     * 
     * @param workItem
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkItem WorkItem} 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.commercialproject.WorkItem WorkItem} entity.
     *         To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.WorkItemDeleteFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    WorkItemDeleteFluentHelper deleteWorkItem( @Nonnull final WorkItem workItem );

    /**
     * Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.Demand Demand} entity
     * and save it to the S/4HANA system.
     * 
     * @param demand
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.Demand Demand} 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.commercialproject.Demand Demand} entity. To
     *         perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.DemandCreateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    DemandCreateFluentHelper createDemand( @Nonnull final Demand demand );

    /**
     * Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.Demand Demand}
     * entity and save it to the S/4HANA system.
     * 
     * @param demand
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.Demand Demand} 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.commercialproject.Demand Demand} entity. To
     *         perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.DemandUpdateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    DemandUpdateFluentHelper updateDemand( @Nonnull final Demand demand );

    /**
     * Deletes an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.Demand Demand}
     * entity in the S/4HANA system.
     * 
     * @param demand
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.Demand Demand} 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.commercialproject.Demand Demand} entity. To
     *         perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialproject.DemandDeleteFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    DemandDeleteFluentHelper deleteDemand( @Nonnull final Demand demand );

}