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

Interface ProjectService

All Superinterfaces:

BatchService<ProjectServiceBatch>

All Known Implementing Classes:

DefaultProjectService

public interface ProjectService
extends BatchService<ProjectServiceBatch>

The service reads data from the project using Project Internal ID, and can retrieve project header data as well as description fields, organizational fields and planned date fields. You can use the WBS Element entity type to get details about the WBS Elements associated with this project. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_PROJECT_V2_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Project

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
ProjectFluentHelper	getAllProject() Fetch multiple Project entities.
WBSElementFluentHelper	getAllWBSElement() Fetch multiple WBSElement entities.
ProjectByKeyFluentHelper	getProjectByKey(String projectInternalID) Fetch a single Project entity using key fields.
WBSElementByKeyFluentHelper	getWBSElementByKey(String wBSElementInternalID) Fetch a single WBSElement entity using key fields.
ProjectService	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.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
ProjectService 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.

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 projectInternalID)

Fetch a single Project entity using key fields.

Parameters:

projectInternalID - Project (internal)

Constraints: Not nullable, Maximum length: 8

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.

getAllWBSElement

@Nonnull
WBSElementFluentHelper getAllWBSElement()

Fetch multiple WBSElement entities.

Returns:

A fluent helper to fetch multiple WBSElement 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.

getWBSElementByKey

@Nonnull
WBSElementByKeyFluentHelper getWBSElementByKey(String wBSElementInternalID)

Fetch a single WBSElement entity using key fields.

Parameters:

wBSElementInternalID - WBS Element

Constraints: Not nullable, Maximum length: 8

Returns:

A fluent helper to fetch a single WBSElement 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.