@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultCommercialProjectDetailService") public class DefaultCommercialProjectDetailService extends Object implements CommercialProjectDetailService
The service is designed to provide all header and detail-level information about a project, and can be used as a data provider for integration with third-party tools or applications that support activities such as resource management, staffing, or time recording.
Reference: SAP API Business Hub
OData Service: | _CPD_SC_EXTERNAL_SERVICES_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, OAuth2 |
Business Object: | CommercialProject |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultCommercialProjectDetailService()
Creates a service using
CommercialProjectDetailService.DEFAULT_SERVICE_PATH to send the requests. |
Modifier and Type | Method and Description |
---|---|
DefaultCommercialProjectDetailServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
PlanDataFluentHelper |
getAllPlanData()
Fetch multiple
PlanData entities. |
ProjectFluentHelper |
getAllProject()
Fetch multiple
Project entities. |
StaffingDataFluentHelper |
getAllStaffingData()
Fetch multiple
StaffingData entities. |
WorkItemFluentHelper |
getAllWorkItem()
Fetch multiple
WorkItem entities. |
WorkpackageFluentHelper |
getAllWorkpackage()
Fetch multiple
Workpackage entities. |
PlanDataByKeyFluentHelper |
getPlanDataByKey(String projectID,
String resType,
String workPackageID,
String resourceId,
String version,
String employee,
String confirmed,
String workitemId,
String delvryServOrg)
Fetch a single
PlanData entity using key fields. |
ProjectByKeyFluentHelper |
getProjectByKey(String projectID)
Fetch a single
Project entity using key fields. |
StaffingDataByKeyFluentHelper |
getStaffingDataByKey(String projectID,
String workPackageID,
String resType,
String resourceId,
String workitemId)
Fetch a single
StaffingData entity using key fields. |
WorkItemByKeyFluentHelper |
getWorkItemByKey(String workitem,
String workpackageID)
Fetch a single
WorkItem entity using key fields. |
WorkpackageByKeyFluentHelper |
getWorkpackageByKey(String workPackageID)
Fetch a single
Workpackage entity using key fields. |
DefaultCommercialProjectDetailService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
public DefaultCommercialProjectDetailService()
CommercialProjectDetailService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultCommercialProjectDetailService withServicePath(@Nonnull String servicePath)
CommercialProjectDetailService
withServicePath
in interface CommercialProjectDetailService
servicePath
- Service path that will override the default.@Nonnull public DefaultCommercialProjectDetailServiceBatch batch()
batch
in interface BatchService<CommercialProjectDetailServiceBatch>
@Nonnull public ProjectFluentHelper getAllProject()
CommercialProjectDetailService
Project
entities.getAllProject
in interface CommercialProjectDetailService
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.@Nonnull public ProjectByKeyFluentHelper getProjectByKey(String projectID)
CommercialProjectDetailService
Project
entity using key fields.getProjectByKey
in interface CommercialProjectDetailService
projectID
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
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.@Nonnull public WorkpackageFluentHelper getAllWorkpackage()
CommercialProjectDetailService
Workpackage
entities.getAllWorkpackage
in interface CommercialProjectDetailService
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.@Nonnull public WorkpackageByKeyFluentHelper getWorkpackageByKey(String workPackageID)
CommercialProjectDetailService
Workpackage
entity using key fields.getWorkpackageByKey
in interface CommercialProjectDetailService
workPackageID
- Plan Item
Constraints: Not nullable, Maximum length: 50
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.@Nonnull public PlanDataFluentHelper getAllPlanData()
CommercialProjectDetailService
PlanData
entities.getAllPlanData
in interface CommercialProjectDetailService
PlanData
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.@Nonnull public PlanDataByKeyFluentHelper getPlanDataByKey(String projectID, String resType, String workPackageID, String resourceId, String version, String employee, String confirmed, String workitemId, String delvryServOrg)
CommercialProjectDetailService
PlanData
entity using key fields.getPlanDataByKey
in interface CommercialProjectDetailService
projectID
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
resType
- Used to uniquely identify the resource type.
Constraints: Not nullable, Maximum length: 4
workPackageID
- Plan Item
Constraints: Not nullable, Maximum length: 50
resourceId
- Used to uniquely identify a resource.
Constraints: Not nullable, Maximum length: 40
version
- A plan version is used to create different types of project estimates. Each version is associated with
different version types that categorize versions into quote, baseline, current, and forecast.
Constraints: Not nullable, Maximum length: 28
employee
- Contains a unique eight-digit numerical code that represents a specific object (for example, an
organizational unit, qualification or business event).
Constraints: Not nullable, Maximum length: 8
confirmed
- Confirmation of staffed Employee
Constraints: Not nullable, Maximum length: 1
workitemId
- Work Item ID
Constraints: Not nullable, Maximum length: 10
delvryServOrg
- This field links master project data with the company code and plant.
Constraints: Not nullable, Maximum length: 5
PlanData
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.@Nonnull public WorkItemFluentHelper getAllWorkItem()
CommercialProjectDetailService
WorkItem
entities.getAllWorkItem
in interface CommercialProjectDetailService
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.@Nonnull public WorkItemByKeyFluentHelper getWorkItemByKey(String workitem, String workpackageID)
CommercialProjectDetailService
WorkItem
entity using key fields.getWorkItemByKey
in interface CommercialProjectDetailService
workitem
- Work Item ID
Constraints: Not nullable, Maximum length: 10
workpackageID
- Plan Item
Constraints: Not nullable, Maximum length: 50
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.@Nonnull public StaffingDataFluentHelper getAllStaffingData()
CommercialProjectDetailService
StaffingData
entities.getAllStaffingData
in interface CommercialProjectDetailService
StaffingData
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.@Nonnull public StaffingDataByKeyFluentHelper getStaffingDataByKey(String projectID, String workPackageID, String resType, String resourceId, String workitemId)
CommercialProjectDetailService
StaffingData
entity using key fields.getStaffingDataByKey
in interface CommercialProjectDetailService
projectID
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
workPackageID
- Plan Item
Constraints: Not nullable, Maximum length: 50
resType
- Used to uniquely identify the resource type.
Constraints: Not nullable, Maximum length: 4
resourceId
- Used to uniquely identify a resource.
Constraints: Not nullable, Maximum length: 40
workitemId
- Work Item ID
Constraints: Not nullable, Maximum length: 10
StaffingData
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.Copyright © 2019 SAP SE. All rights reserved.