com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface CommercialProjectService

All Superinterfaces:

BatchService<CommercialProjectServiceBatch>

All Known Implementing Classes:

DefaultCommercialProjectService

public interface CommercialProjectService
extends BatchService<CommercialProjectServiceBatch>

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 in an external system.

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 - Project-Based Services (1A8), Customer Project Management - Project-Based Services (J11)
Authentication Methods:	Basic, x509

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
CustProjSlsOrdCreateFluentHelper	createCustProjSlsOrd(CustProjSlsOrd custProjSlsOrd) Create a new CustProjSlsOrd entity and save it to the S/4HANA system.
DemandCreateFluentHelper	createDemand(Demand demand) Create a new Demand entity and save it to the S/4HANA system.
ProjectCreateFluentHelper	createProject(Project project) Create a new Project entity and save it to the S/4HANA system.
WorkItemCreateFluentHelper	createWorkItem(WorkItem workItem) Create a new WorkItem entity and save it to the S/4HANA system.
WorkPackageCreateFluentHelper	createWorkPackage(WorkPackage workPackage) Create a new WorkPackage entity and save it to the S/4HANA system.
DemandDeleteFluentHelper	deleteDemand(Demand demand) Deletes an existing Demand entity in the S/4HANA system.
WorkItemDeleteFluentHelper	deleteWorkItem(WorkItem workItem) Deletes an existing WorkItem entity in the S/4HANA system.
WorkPackageDeleteFluentHelper	deleteWorkPackage(WorkPackage workPackage) Deletes an existing WorkPackage entity in the S/4HANA system.
CustProjSlsOrdFluentHelper	getAllCustProjSlsOrd() Fetch multiple CustProjSlsOrd entities.
CustProjSlsOrdItemFluentHelper	getAllCustProjSlsOrdItem() Fetch multiple CustProjSlsOrdItem entities.
CustProjSlsOrdItemWorkPckgFluentHelper	getAllCustProjSlsOrdItemWorkPckg() Fetch multiple CustProjSlsOrdItemWorkPckg entities.
CustProjSlsOrdItmBillgPlnItmFluentHelper	getAllCustProjSlsOrdItmBillgPlnItm() Fetch multiple CustProjSlsOrdItmBillgPlnItm entities.
DemandFluentHelper	getAllDemand() Fetch multiple Demand entities.
ProjectFluentHelper	getAllProject() Fetch multiple Project entities.
WorkItemFluentHelper	getAllWorkItem() Fetch multiple WorkItem entities.
WorkPackageFluentHelper	getAllWorkPackage() Fetch multiple WorkPackage entities.
CustProjSlsOrdByKeyFluentHelper	getCustProjSlsOrdByKey(String customerProject) Fetch a single CustProjSlsOrd entity using key fields.
CustProjSlsOrdItemByKeyFluentHelper	getCustProjSlsOrdItemByKey(String customerProject, String salesOrderItem) Fetch a single CustProjSlsOrdItem entity using key fields.
CustProjSlsOrdItemWorkPckgByKeyFluentHelper	getCustProjSlsOrdItemWorkPckgByKey(String customerProject, String salesOrderItem, String workPackage) Fetch a single CustProjSlsOrdItemWorkPckg entity using key fields.
CustProjSlsOrdItmBillgPlnItmByKeyFluentHelper	getCustProjSlsOrdItmBillgPlnItmByKey(String customerProject, String salesOrderItem, String billingPlanItem) Fetch a single CustProjSlsOrdItmBillgPlnItm entity using key fields.
DemandByKeyFluentHelper	getDemandByKey(String projectID, String workPackageID, String workPackageName, String resType, String resourceId, String workitem, String delvryServOrg) Fetch a single Demand entity using key fields.
ProjectByKeyFluentHelper	getProjectByKey(String projectID) Fetch a single Project entity using key fields.
WorkItemByKeyFluentHelper	getWorkItemByKey(String projectID, String workitem, String workPackageID, String workPackageName) Fetch a single WorkItem entity using key fields.
WorkPackageByKeyFluentHelper	getWorkPackageByKey(String projectID, String workPackageID, String workPackageName) Fetch a single WorkPackage entity using key fields.
DemandUpdateFluentHelper	updateDemand(Demand demand) Update an existing Demand entity and save it to the S/4HANA system.
ProjectUpdateFluentHelper	updateProject(Project project) Update an existing Project entity and save it to the S/4HANA system.
WorkItemUpdateFluentHelper	updateWorkItem(WorkItem workItem) Update an existing WorkItem entity and save it to the S/4HANA system.
WorkPackageUpdateFluentHelper	updateWorkPackage(WorkPackage workPackage) Update an existing WorkPackage entity and save it to the S/4HANA system.
CommercialProjectService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
CommercialProjectService withServicePath(@Nonnull
                                                  String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllCustProjSlsOrd

@Nonnull
CustProjSlsOrdFluentHelper getAllCustProjSlsOrd()

Fetch multiple CustProjSlsOrd entities.

Returns:

A fluent helper to fetch multiple CustProjSlsOrd entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getCustProjSlsOrdByKey

@Nonnull
CustProjSlsOrdByKeyFluentHelper getCustProjSlsOrdByKey(String customerProject)

Fetch a single CustProjSlsOrd entity using key fields.

Parameters:

customerProject - Identifies a master project.

Constraints: Not nullable, Maximum length: 40

Returns:

A fluent helper to fetch a single CustProjSlsOrd 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 execute method on the fluent helper object.

createCustProjSlsOrd

@Nonnull
CustProjSlsOrdCreateFluentHelper createCustProjSlsOrd(@Nonnull
                                                               CustProjSlsOrd custProjSlsOrd)

Create a new CustProjSlsOrd entity and save it to the S/4HANA system.

Parameters:

custProjSlsOrd - CustProjSlsOrd entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new CustProjSlsOrd entity. To perform execution, call the execute method on the fluent helper object.

getAllCustProjSlsOrdItem

@Nonnull
CustProjSlsOrdItemFluentHelper getAllCustProjSlsOrdItem()

Fetch multiple CustProjSlsOrdItem entities.

Returns:

A fluent helper to fetch multiple CustProjSlsOrdItem entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getCustProjSlsOrdItemByKey

@Nonnull
CustProjSlsOrdItemByKeyFluentHelper getCustProjSlsOrdItemByKey(String customerProject,
                                                                        String salesOrderItem)

Fetch a single CustProjSlsOrdItem entity using key fields.

Parameters:

salesOrderItem - Sales Order Item

Constraints: Not nullable, Maximum length: 6

customerProject - Identifies a master project.

Constraints: Not nullable, Maximum length: 40

Returns:

A fluent helper to fetch a single CustProjSlsOrdItem 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 execute method on the fluent helper object.

getAllCustProjSlsOrdItemWorkPckg

@Nonnull
CustProjSlsOrdItemWorkPckgFluentHelper getAllCustProjSlsOrdItemWorkPckg()

Fetch multiple CustProjSlsOrdItemWorkPckg entities.

Returns:

A fluent helper to fetch multiple CustProjSlsOrdItemWorkPckg entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getCustProjSlsOrdItemWorkPckgByKey

@Nonnull
CustProjSlsOrdItemWorkPckgByKeyFluentHelper getCustProjSlsOrdItemWorkPckgByKey(String customerProject,
                                                                                        String salesOrderItem,
                                                                                        String workPackage)

Fetch a single CustProjSlsOrdItemWorkPckg entity using key fields.

Parameters:

salesOrderItem - Sales Order Item

Constraints: Not nullable, Maximum length: 6

customerProject - Identifies a master project.

Constraints: Not nullable, Maximum length: 40

workPackage - Plan Item

Constraints: Not nullable, Maximum length: 50

Returns:

A fluent helper to fetch a single CustProjSlsOrdItemWorkPckg 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 execute method on the fluent helper object.

getAllCustProjSlsOrdItmBillgPlnItm

@Nonnull
CustProjSlsOrdItmBillgPlnItmFluentHelper getAllCustProjSlsOrdItmBillgPlnItm()

Fetch multiple CustProjSlsOrdItmBillgPlnItm entities.

Returns:

A fluent helper to fetch multiple CustProjSlsOrdItmBillgPlnItm entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getCustProjSlsOrdItmBillgPlnItmByKey

@Nonnull
CustProjSlsOrdItmBillgPlnItmByKeyFluentHelper getCustProjSlsOrdItmBillgPlnItmByKey(String customerProject,
                                                                                            String salesOrderItem,
                                                                                            String billingPlanItem)

Fetch a single CustProjSlsOrdItmBillgPlnItm entity using key fields.

Parameters:

salesOrderItem - Sales Order Item

Constraints: Not nullable, Maximum length: 6

customerProject - Identifies a master project.

Constraints: Not nullable, Maximum length: 40

billingPlanItem - Item for billing plan/invoice plan/payment cards

Constraints: Not nullable, Maximum length: 6

Returns:

A fluent helper to fetch a single CustProjSlsOrdItmBillgPlnItm 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 execute method on the fluent helper object.

getAllProject

@Nonnull
ProjectFluentHelper getAllProject()

Fetch multiple Project entities.

Returns:

A fluent helper to fetch multiple Project entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getProjectByKey

@Nonnull
ProjectByKeyFluentHelper getProjectByKey(String projectID)

Fetch a single Project entity using key fields.

Parameters:

projectID - Identifies a master project.

Constraints: Not nullable, Maximum length: 40

Returns:

A fluent helper to fetch a single Project 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 execute method on the fluent helper object.

createProject

@Nonnull
ProjectCreateFluentHelper createProject(@Nonnull
                                                 Project project)

Create a new Project entity and save it to the S/4HANA system.

Parameters:

project - Project entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new Project entity. To perform execution, call the execute method on the fluent helper object.

updateProject

@Nonnull
ProjectUpdateFluentHelper updateProject(@Nonnull
                                                 Project project)

Update an existing Project entity and save it to the S/4HANA system.

Parameters:

project - Project entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing Project entity. To perform execution, call the execute method on the fluent helper object.

getAllWorkPackage

@Nonnull
WorkPackageFluentHelper getAllWorkPackage()

Fetch multiple WorkPackage entities.

Returns:

A fluent helper to fetch multiple WorkPackage entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getWorkPackageByKey

@Nonnull
WorkPackageByKeyFluentHelper getWorkPackageByKey(String projectID,
                                                          String workPackageID,
                                                          String workPackageName)

Fetch a single WorkPackage entity using key fields.

Parameters:

workPackageID - Plan Item

Constraints: Not nullable, Maximum length: 50

workPackageName - Plan Item Description

Constraints: Not nullable, Maximum length: 60

projectID - Identifies a master project.

Constraints: Not nullable, Maximum length: 40

Returns:

A fluent helper to fetch a single WorkPackage 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 execute method on the fluent helper object.

createWorkPackage

@Nonnull
WorkPackageCreateFluentHelper createWorkPackage(@Nonnull
                                                         WorkPackage workPackage)

Create a new WorkPackage entity and save it to the S/4HANA system.

Parameters:

workPackage - WorkPackage entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new WorkPackage entity. To perform execution, call the execute method on the fluent helper object.

updateWorkPackage

@Nonnull
WorkPackageUpdateFluentHelper updateWorkPackage(@Nonnull
                                                         WorkPackage workPackage)

Update an existing WorkPackage entity and save it to the S/4HANA system.

Parameters:

workPackage - WorkPackage entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing WorkPackage entity. To perform execution, call the execute method on the fluent helper object.

deleteWorkPackage

@Nonnull
WorkPackageDeleteFluentHelper deleteWorkPackage(@Nonnull
                                                         WorkPackage workPackage)

Deletes an existing WorkPackage entity in the S/4HANA system.

Parameters:

workPackage - WorkPackage entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing WorkPackage entity. To perform execution, call the execute method on the fluent helper object.

getAllWorkItem

@Nonnull
WorkItemFluentHelper getAllWorkItem()

Fetch multiple WorkItem entities.

Returns:

A fluent helper to fetch multiple WorkItem entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getWorkItemByKey

@Nonnull
WorkItemByKeyFluentHelper getWorkItemByKey(String projectID,
                                                    String workitem,
                                                    String workPackageID,
                                                    String workPackageName)

Fetch a single WorkItem entity using key fields.

Parameters:

workPackageID - Plan Item

Constraints: Not nullable, Maximum length: 50

workPackageName - Plan Item Description

Constraints: Not nullable, Maximum length: 60

workitem - Work Item ID

Constraints: Not nullable, Maximum length: 10

projectID - Identifies a master project.

Constraints: Not nullable, Maximum length: 40

Returns:

A fluent helper to fetch a single WorkItem 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 execute method on the fluent helper object.

createWorkItem

@Nonnull
WorkItemCreateFluentHelper createWorkItem(@Nonnull
                                                   WorkItem workItem)

Create a new WorkItem entity and save it to the S/4HANA system.

Parameters:

workItem - WorkItem entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new WorkItem entity. To perform execution, call the execute method on the fluent helper object.

updateWorkItem

@Nonnull
WorkItemUpdateFluentHelper updateWorkItem(@Nonnull
                                                   WorkItem workItem)

Update an existing WorkItem entity and save it to the S/4HANA system.

Parameters:

workItem - WorkItem entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing WorkItem entity. To perform execution, call the execute method on the fluent helper object.

deleteWorkItem

@Nonnull
WorkItemDeleteFluentHelper deleteWorkItem(@Nonnull
                                                   WorkItem workItem)

Deletes an existing WorkItem entity in the S/4HANA system.

Parameters:

workItem - WorkItem entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing WorkItem entity. To perform execution, call the execute method on the fluent helper object.

getAllDemand

@Nonnull
DemandFluentHelper getAllDemand()

Fetch multiple Demand entities.

Returns:

A fluent helper to fetch multiple Demand entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getDemandByKey

@Nonnull
DemandByKeyFluentHelper getDemandByKey(String projectID,
                                                String workPackageID,
                                                String workPackageName,
                                                String resType,
                                                String resourceId,
                                                String workitem,
                                                String delvryServOrg)

Fetch a single Demand entity using key fields.

Parameters:

delvryServOrg - This field links master project data with the company code and plant.

Constraints: Not nullable, Maximum length: 5

resourceId - Used to uniquely identify a resource.

Constraints: Not nullable, Maximum length: 40

workPackageID - Plan Item

Constraints: Not nullable, Maximum length: 50

workPackageName - Plan Item Description

Constraints: Not nullable, Maximum length: 60

resType - Used to uniquely identify the resource type.

Constraints: Not nullable, Maximum length: 4

workitem - Work Item ID

Constraints: Not nullable, Maximum length: 10

projectID - Identifies a master project.

Constraints: Not nullable, Maximum length: 40

Returns:

A fluent helper to fetch a single Demand 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 execute method on the fluent helper object.

createDemand

@Nonnull
DemandCreateFluentHelper createDemand(@Nonnull
                                               Demand demand)

Create a new Demand entity and save it to the S/4HANA system.

Parameters:

demand - Demand entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new Demand entity. To perform execution, call the execute method on the fluent helper object.

updateDemand

@Nonnull
DemandUpdateFluentHelper updateDemand(@Nonnull
                                               Demand demand)

Update an existing Demand entity and save it to the S/4HANA system.

Parameters:

demand - Demand entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing Demand entity. To perform execution, call the execute method on the fluent helper object.

deleteDemand

@Nonnull
DemandDeleteFluentHelper deleteDemand(@Nonnull
                                               Demand demand)

Deletes an existing Demand entity in the S/4HANA system.

Parameters:

demand - Demand entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing Demand entity. To perform execution, call the execute method on the fluent helper object.