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

Interface SupplyAvailabilityProtectionPlanService

All Known Implementing Classes:

DefaultSupplyAvailabilityProtectionPlanService

public interface SupplyAvailabilityProtectionPlanService

The service contains the supply protection object, the characteristics, the supply protection groups and the time buckets. Once the supply availability protection plan has been created, the response contains the created object with comprehensive information including UUIDs of the objects as well as error messages for the case that the creation was not successful..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SUPAVAILYPROTPLAN_0001
API Version:	1
Communication Scenario:	Supply Availability Protection Plan Integration (SAP_COM_0384)
Scope Items:	Advanced Available-to-Promise Processing (1JW)
Authentication Methods:	Basic, x509, OAuth2
Service Group Name:	API_SUPAVAILYPROTPLAN
Business Object:	SupAvailabilityProtectionPlan

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
BatchRequestBuilder	batch() Creates a batch request builder object.
CountRequestBuilder<SupplyProtection>	countSupplyProtection() Fetch the number of entries from the SupplyProtection entity collection matching the filter and search expressions.
CountRequestBuilder<SupplyProtectionGroup>	countSupplyProtectionGroup() Fetch the number of entries from the SupplyProtectionGroup entity collection matching the filter and search expressions.
CountRequestBuilder<SupplyProtectionTimeBucket>	countSupplyProtectionTimeBucket() Fetch the number of entries from the SupplyProtectionTimeBucket entity collection matching the filter and search expressions.
CountRequestBuilder<SupProtCharacteristic>	countSupProtCharacteristic() Fetch the number of entries from the SupProtCharacteristic entity collection matching the filter and search expressions.
CreateRequestBuilder<SupplyProtection>	createSupplyProtection(SupplyProtection supplyProtection) Create a new SupplyProtection entity and save it to the S/4HANA system.
DeleteRequestBuilder<SupplyProtection>	deleteSupplyProtection(SupplyProtection supplyProtection) Deletes an existing SupplyProtection entity in the S/4HANA system.
DeleteRequestBuilder<SupplyProtectionGroup>	deleteSupplyProtectionGroup(SupplyProtectionGroup supplyProtectionGroup) Deletes an existing SupplyProtectionGroup entity in the S/4HANA system.
DeleteRequestBuilder<SupplyProtectionTimeBucket>	deleteSupplyProtectionTimeBucket(SupplyProtectionTimeBucket supplyProtectionTimeBucket) Deletes an existing SupplyProtectionTimeBucket entity in the S/4HANA system.
DeleteRequestBuilder<SupProtCharacteristic>	deleteSupProtCharacteristic(SupProtCharacteristic supProtCharacteristic) Deletes an existing SupProtCharacteristic entity in the S/4HANA system.
GetAllRequestBuilder<SupplyProtection>	getAllSupplyProtection() Fetch multiple SupplyProtection entities.
GetAllRequestBuilder<SupplyProtectionGroup>	getAllSupplyProtectionGroup() Fetch multiple SupplyProtectionGroup entities.
GetAllRequestBuilder<SupplyProtectionTimeBucket>	getAllSupplyProtectionTimeBucket() Fetch multiple SupplyProtectionTimeBucket entities.
GetAllRequestBuilder<SupProtCharacteristic>	getAllSupProtCharacteristic() Fetch multiple SupProtCharacteristic entities.
GetByKeyRequestBuilder<SupplyProtection>	getSupplyProtectionByKey(UUID supplyProtectionUUID) Fetch a single SupplyProtection entity using key fields.
GetByKeyRequestBuilder<SupplyProtectionGroup>	getSupplyProtectionGroupByKey(UUID supplyProtectionGroupUUID) Fetch a single SupplyProtectionGroup entity using key fields.
GetByKeyRequestBuilder<SupplyProtectionTimeBucket>	getSupplyProtectionTimeBucketByKey(UUID supProtTimeBucketUUID) Fetch a single SupplyProtectionTimeBucket entity using key fields.
GetByKeyRequestBuilder<SupProtCharacteristic>	getSupProtCharacteristicByKey(UUID supProtCharacteristicUUID) Fetch a single SupProtCharacteristic entity using key fields.
UpdateRequestBuilder<SupplyProtection>	updateSupplyProtection(SupplyProtection supplyProtection) Update an existing SupplyProtection entity and save it to the S/4HANA system.
UpdateRequestBuilder<SupplyProtectionGroup>	updateSupplyProtectionGroup(SupplyProtectionGroup supplyProtectionGroup) Update an existing SupplyProtectionGroup entity and save it to the S/4HANA system.
UpdateRequestBuilder<SupplyProtectionTimeBucket>	updateSupplyProtectionTimeBucket(SupplyProtectionTimeBucket supplyProtectionTimeBucket) Update an existing SupplyProtectionTimeBucket entity and save it to the S/4HANA system.
UpdateRequestBuilder<SupProtCharacteristic>	updateSupProtCharacteristic(SupProtCharacteristic supProtCharacteristic) Update an existing SupProtCharacteristic entity and save it to the S/4HANA system.
SupplyAvailabilityProtectionPlanService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

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
SupplyAvailabilityProtectionPlanService 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.

batch

@Nonnull
BatchRequestBuilder batch()

Creates a batch request builder object.

Returns:

A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

getAllSupplyProtection

@Nonnull
GetAllRequestBuilder<SupplyProtection> getAllSupplyProtection()

Fetch multiple SupplyProtection entities.

Returns:

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

countSupplyProtection

@Nonnull
CountRequestBuilder<SupplyProtection> countSupplyProtection()

Fetch the number of entries from the SupplyProtection entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of SupplyProtection entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getSupplyProtectionByKey

@Nonnull
GetByKeyRequestBuilder<SupplyProtection> getSupplyProtectionByKey(@Nonnull
                                                                           UUID supplyProtectionUUID)

Fetch a single SupplyProtection entity using key fields.

Parameters:

supplyProtectionUUID - UUID

Constraints: Not nullable

Returns:

A request builder to fetch a single SupplyProtection entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

createSupplyProtection

@Nonnull
CreateRequestBuilder<SupplyProtection> createSupplyProtection(@Nonnull
                                                                       SupplyProtection supplyProtection)

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

Parameters:

supplyProtection - SupplyProtection entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new SupplyProtection entity. To perform execution, call the execute method on the request builder object.

updateSupplyProtection

@Nonnull
UpdateRequestBuilder<SupplyProtection> updateSupplyProtection(@Nonnull
                                                                       SupplyProtection supplyProtection)

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

Parameters:

supplyProtection - SupplyProtection entity object that will be updated in the S/4HANA system.

Returns:

A request builder to update an existing SupplyProtection entity. To perform execution, call the execute method on the request builder object.

deleteSupplyProtection

@Nonnull
DeleteRequestBuilder<SupplyProtection> deleteSupplyProtection(@Nonnull
                                                                       SupplyProtection supplyProtection)

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

Parameters:

supplyProtection - SupplyProtection entity object that will be deleted in the S/4HANA system.

Returns:

A request builder to delete an existing SupplyProtection entity. To perform execution, call the execute method on the request builder object.

getAllSupplyProtectionGroup

@Nonnull
GetAllRequestBuilder<SupplyProtectionGroup> getAllSupplyProtectionGroup()

Fetch multiple SupplyProtectionGroup entities.

Returns:

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

countSupplyProtectionGroup

@Nonnull
CountRequestBuilder<SupplyProtectionGroup> countSupplyProtectionGroup()

Fetch the number of entries from the SupplyProtectionGroup entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of SupplyProtectionGroup entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getSupplyProtectionGroupByKey

@Nonnull
GetByKeyRequestBuilder<SupplyProtectionGroup> getSupplyProtectionGroupByKey(@Nonnull
                                                                                     UUID supplyProtectionGroupUUID)

Fetch a single SupplyProtectionGroup entity using key fields.

Parameters:

supplyProtectionGroupUUID - Characteristic Value Combination UUID

Constraints: Not nullable

Returns:

A request builder to fetch a single SupplyProtectionGroup entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

updateSupplyProtectionGroup

@Nonnull
UpdateRequestBuilder<SupplyProtectionGroup> updateSupplyProtectionGroup(@Nonnull
                                                                                 SupplyProtectionGroup supplyProtectionGroup)

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

Parameters:

supplyProtectionGroup - SupplyProtectionGroup entity object that will be updated in the S/4HANA system.

Returns:

A request builder to update an existing SupplyProtectionGroup entity. To perform execution, call the execute method on the request builder object.

deleteSupplyProtectionGroup

@Nonnull
DeleteRequestBuilder<SupplyProtectionGroup> deleteSupplyProtectionGroup(@Nonnull
                                                                                 SupplyProtectionGroup supplyProtectionGroup)

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

Parameters:

supplyProtectionGroup - SupplyProtectionGroup entity object that will be deleted in the S/4HANA system.

Returns:

A request builder to delete an existing SupplyProtectionGroup entity. To perform execution, call the execute method on the request builder object.

getAllSupplyProtectionTimeBucket

@Nonnull
GetAllRequestBuilder<SupplyProtectionTimeBucket> getAllSupplyProtectionTimeBucket()

Fetch multiple SupplyProtectionTimeBucket entities.

Returns:

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

countSupplyProtectionTimeBucket

@Nonnull
CountRequestBuilder<SupplyProtectionTimeBucket> countSupplyProtectionTimeBucket()

Fetch the number of entries from the SupplyProtectionTimeBucket entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of SupplyProtectionTimeBucket entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getSupplyProtectionTimeBucketByKey

@Nonnull
GetByKeyRequestBuilder<SupplyProtectionTimeBucket> getSupplyProtectionTimeBucketByKey(@Nonnull
                                                                                               UUID supProtTimeBucketUUID)

Fetch a single SupplyProtectionTimeBucket entity using key fields.

Parameters:

supProtTimeBucketUUID - Time Bucket UUID

Constraints: Not nullable

Returns:

A request builder to fetch a single SupplyProtectionTimeBucket entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

updateSupplyProtectionTimeBucket

@Nonnull
UpdateRequestBuilder<SupplyProtectionTimeBucket> updateSupplyProtectionTimeBucket(@Nonnull
                                                                                           SupplyProtectionTimeBucket supplyProtectionTimeBucket)

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

Parameters:

supplyProtectionTimeBucket - SupplyProtectionTimeBucket entity object that will be updated in the S/4HANA system.

Returns:

A request builder to update an existing SupplyProtectionTimeBucket entity. To perform execution, call the execute method on the request builder object.

deleteSupplyProtectionTimeBucket

@Nonnull
DeleteRequestBuilder<SupplyProtectionTimeBucket> deleteSupplyProtectionTimeBucket(@Nonnull
                                                                                           SupplyProtectionTimeBucket supplyProtectionTimeBucket)

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

Parameters:

supplyProtectionTimeBucket - SupplyProtectionTimeBucket entity object that will be deleted in the S/4HANA system.

Returns:

A request builder to delete an existing SupplyProtectionTimeBucket entity. To perform execution, call the execute method on the request builder object.

getAllSupProtCharacteristic

@Nonnull
GetAllRequestBuilder<SupProtCharacteristic> getAllSupProtCharacteristic()

Fetch multiple SupProtCharacteristic entities.

Returns:

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

countSupProtCharacteristic

@Nonnull
CountRequestBuilder<SupProtCharacteristic> countSupProtCharacteristic()

Fetch the number of entries from the SupProtCharacteristic entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of SupProtCharacteristic entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getSupProtCharacteristicByKey

@Nonnull
GetByKeyRequestBuilder<SupProtCharacteristic> getSupProtCharacteristicByKey(@Nonnull
                                                                                     UUID supProtCharacteristicUUID)

Fetch a single SupProtCharacteristic entity using key fields.

Parameters:

supProtCharacteristicUUID - Characteristic UUID

Constraints: Not nullable

Returns:

A request builder to fetch a single SupProtCharacteristic entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

updateSupProtCharacteristic

@Nonnull
UpdateRequestBuilder<SupProtCharacteristic> updateSupProtCharacteristic(@Nonnull
                                                                                 SupProtCharacteristic supProtCharacteristic)

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

Parameters:

supProtCharacteristic - SupProtCharacteristic entity object that will be updated in the S/4HANA system.

Returns:

A request builder to update an existing SupProtCharacteristic entity. To perform execution, call the execute method on the request builder object.

deleteSupProtCharacteristic

@Nonnull
DeleteRequestBuilder<SupProtCharacteristic> deleteSupProtCharacteristic(@Nonnull
                                                                                 SupProtCharacteristic supProtCharacteristic)

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

Parameters:

supProtCharacteristic - SupProtCharacteristic entity object that will be deleted in the S/4HANA system.

Returns:

A request builder to delete an existing SupProtCharacteristic entity. To perform execution, call the execute method on the request builder object.