com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readcommercialprojectdetails

Class PlanDataByKeyFluentHelper

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readcommercialprojectdetails.PlanDataByKeyFluentHelper

public class PlanDataByKeyFluentHelper
extends Object

Fluent helper to fetch a single PlanData entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself.

Constructor Summary

Constructors

Constructor and Description
PlanDataByKeyFluentHelper(String projectID, String resType, String workPackageID, String resourceId, String version, String employee, String confirmed, String workitemId, String delvryServOrg) Creates a fluent helper object that will fetch a single PlanData entity with the provided key field values.

Method Summary

Modifier and Type	Method and Description
PlanData	execute() Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.
PlanData	execute(ErpConfigContext erpConfigContext) Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.
PlanData	execute(ErpEndpoint erpEndpoint) Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.
PlanDataByKeyFluentHelper	select(EntityField<PlanData,?>... fields) Query modifier to limit which field values within an entity get fetched & populated.
com.sap.cloud.sdk.odatav2.connectivity.ODataQuery	toQuery() Provides access to the underlying Query object, to allow for custom integration scenarios not yet supported by the virtual data model.
PlanDataByKeyFluentHelper	withErrorHandler(com.sap.cloud.sdk.odatav2.connectivity.ErrorResultHandler<?> errorResultHandler) An error handling class that implements the ErrorResultHandler interface can be attached to this fluent helper.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlanDataByKeyFluentHelper

public PlanDataByKeyFluentHelper(String projectID,
                                 String resType,
                                 String workPackageID,
                                 String resourceId,
                                 String version,
                                 String employee,
                                 String confirmed,
                                 String workitemId,
                                 String delvryServOrg)

Creates a fluent helper object that will fetch a single PlanData entity with the provided key field values. To perform execution, call the execute method on the fluent helper object.

Parameters:

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

resourceId - Used to uniquely identify a resource.

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

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

projectID - Identifies a master project.

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

confirmed - Confirmation of staffed Employee

Constraints: Not nullable, Maximum length: 1

Method Detail

select

@SafeVarargs
public final PlanDataByKeyFluentHelper select(EntityField<PlanData,?>... fields)

Query modifier to limit which field values within an entity get fetched & populated. If this method is never called, then all fields will be fetched & populated. But if this method is called at least once, then only the specified fields will be fetched & populated. Calling this multiple times will combine the set(s) of fields of each call.

Parameters:

fields - Fields to fetch & populate. See PlanData for available fields.

Returns:

The same fluent helper with this query modifier applied.

toQuery

public com.sap.cloud.sdk.odatav2.connectivity.ODataQuery toQuery()

Provides access to the underlying Query object, to allow for custom integration scenarios not yet supported by the virtual data model.

Returns:

The underlying query object.

withErrorHandler

public PlanDataByKeyFluentHelper withErrorHandler(com.sap.cloud.sdk.odatav2.connectivity.ErrorResultHandler<?> errorResultHandler)

An error handling class that implements the ErrorResultHandler interface can be attached to this fluent helper. This allows custom logic to be called when an error occurs in the execute method. If this method is not called, then an instance of ODataVdmErrorResultHandler is used. Only one handler can be attached at a time per fluent helper object, so calling this multiple times will replace the handler.

Parameters:

errorResultHandler - Instance of an error handler class that implements the ErrorResultHandler interface.

Returns:

The same fluent helper with its error handler set to the provided object.

execute

public PlanData execute(ErpEndpoint erpEndpoint)
                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.

Parameters:

erpEndpoint - Supply the ERP system instance for executing the underlying OData query.

Returns:

An PlanData entity if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown, and the error handler class attached to this fluent helper will be called.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException

See Also:

ErpConfigContext.ErpConfigContext(), ErpEndpoint.ErpEndpoint(ErpConfigContext)

execute

public PlanData execute(ErpConfigContext erpConfigContext)
                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.

Parameters:

erpConfigContext - Supply the ERP system context for executing the underlying OData query.

Returns:

An PlanData entity if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown, and the error handler class attached to this fluent helper will be called.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException

See Also:

ErpConfigContext.ErpConfigContext(), ErpEndpoint.ErpEndpoint(ErpConfigContext)

execute

public PlanData execute()
                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.

The default ERP configuration context will be used.

Returns:

An PlanData entity if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown, and the error handler class attached to this fluent helper will be called.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException

See Also:

ErpConfigContext.ErpConfigContext(), ErpEndpoint.ErpEndpoint(ErpConfigContext)