com.sap.cloud.sdk.s4hana.datamodel.odata.services.CommercialProjectDetailService 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.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.PlanDataByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.PlanDataFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.ProjectByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.ProjectFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.StaffingDataByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.StaffingDataFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.WorkItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.WorkItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.WorkpackageByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.WorkpackageFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.batch.CommercialProjectDetailServiceBatch;
/**
*
* You can use this service to extract information related to customer or internal projects, created in your SAP S/4HANA
* Cloud. 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
*
* Details:
*
*
* 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
*
*
* Business Object:
* CommercialProject
*
*
*
*/
public interface CommercialProjectDetailService 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/cpd/SC_EXTERNAL_SERVICES_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
CommercialProjectDetailService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.Project
* Project} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.Project 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.ProjectFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ProjectFluentHelper getAllProject();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.Project
* Project} entity using key fields.
*
* @param projectID
* Identifies a master project.
*
* Constraints: Not nullable, Maximum length: 40
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.Project 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.ProjectByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ProjectByKeyFluentHelper getProjectByKey( final String projectID );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.Workpackage
* Workpackage} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.Workpackage
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.WorkpackageFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
WorkpackageFluentHelper getAllWorkpackage();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.Workpackage
* Workpackage} entity using key fields.
*
* @param workPackageID
* Plan Item
*
* Constraints: Not nullable, Maximum length: 50
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.Workpackage
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.WorkpackageByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
WorkpackageByKeyFluentHelper getWorkpackageByKey( final String workPackageID );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.PlanData
* PlanData} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.PlanData 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.PlanDataFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PlanDataFluentHelper getAllPlanData();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.PlanData
* PlanData} entity using key fields.
*
* @param workitemId
* Work Item ID
*
* Constraints: Not nullable, Maximum length: 10
*
* @param delvryServOrg
* This field links master project data with the company code and plant.
*
* Constraints: Not nullable, Maximum length: 5
*
* @param resourceId
* Used to uniquely identify a resource.
*
* Constraints: Not nullable, Maximum length: 40
*
* @param workPackageID
* Plan Item
*
* Constraints: Not nullable, Maximum length: 50
*
* @param resType
* Used to uniquely identify the resource type.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param 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
*
* @param projectID
* Identifies a master project.
*
* Constraints: Not nullable, Maximum length: 40
*
* @param 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
*
* @param confirmed
* Confirmation of staffed Employee
*
* Constraints: Not nullable, Maximum length: 1
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.PlanData 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.PlanDataByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PlanDataByKeyFluentHelper getPlanDataByKey(
final String projectID,
final String resType,
final String workPackageID,
final String resourceId,
final String version,
final String employee,
final String confirmed,
final String workitemId,
final String delvryServOrg );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.WorkItem
* WorkItem} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.WorkItem 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.WorkItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
WorkItemFluentHelper getAllWorkItem();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.WorkItem
* WorkItem} entity using key fields.
*
* @param workpackageID
* Plan Item
*
* Constraints: Not nullable, Maximum length: 50
*
* @param workitem
* Work Item ID
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.WorkItem 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.WorkItemByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
WorkItemByKeyFluentHelper getWorkItemByKey( final String workitem, final String workpackageID );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.StaffingData
* StaffingData} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.StaffingData
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.StaffingDataFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
StaffingDataFluentHelper getAllStaffingData();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.StaffingData
* StaffingData} entity using key fields.
*
* @param workitemId
* Work Item ID
*
* Constraints: Not nullable, Maximum length: 10
*
* @param resourceId
* Used to uniquely identify a resource.
*
* Constraints: Not nullable, Maximum length: 40
*
* @param workPackageID
* Plan Item
*
* Constraints: Not nullable, Maximum length: 50
*
* @param resType
* Used to uniquely identify the resource type.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param projectID
* Identifies a master project.
*
* Constraints: Not nullable, Maximum length: 40
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.StaffingData
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.StaffingDataByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
StaffingDataByKeyFluentHelper getStaffingDataByKey(
final String projectID,
final String workPackageID,
final String resType,
final String resourceId,
final String workitemId );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy