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

Interface PreferredSupplierListService

All Known Implementing Classes:

DefaultPreferredSupplierListService

@Deprecated
public interface PreferredSupplierListService

Deprecated.

The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

This service enables you to create, read, update and delete preferred supplier list from an external system in the SAP S/4HANA Cloud system. The service contains a header, business partners or suppliers, material groups, and company codes. The information is sent in the request as a payload. All information is utilized when creating a supplier list for sourcing with appropriate checks for restricted values and authorizations. You can also create a user-specified supplier list, activate, deactivate or copy an existing supplier list. The creation of a new version of the existing standard supplier list is also possible. .

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service:	CE_SUPPLIERLIST_0001
API Version:	1.1.0
Minimum ERP Version:	2302
Communication Scenario:	Preferred Supplier List Integration(SAP_COM_0911)
Scope Items:	Preferred Supplier List(4RI)
Authentication Methods:	x509
Service Group Name:	API_SUPPLIERLIST
Business Object:	SupplierList

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SERVICE_PATH	Deprecated. 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	Description
BatchRequestBuilder	batch()	Deprecated. Creates a batch request builder object.
CountRequestBuilder<SuplrListPrpsdCompanyCode>	countSuplrListProposedCompanyCode()	Deprecated. Fetch the number of entries from the SuplrListPrpsdCompanyCode entity collection matching the filter and search expressions.
CountRequestBuilder<SuplrListPrpsdBusinessPartner>	countSuplrListPrpsdBusinessPartner()	Deprecated. Fetch the number of entries from the SuplrListPrpsdBusinessPartner entity collection matching the filter and search expressions.
CountRequestBuilder<SupplierList>	countSupplierList()	Deprecated. Fetch the number of entries from the SupplierList entity collection matching the filter and search expressions.
CountRequestBuilder<SupplierListBusinessPartner>	countSupplierListBusinessPartner()	Deprecated. Fetch the number of entries from the SupplierListBusinessPartner entity collection matching the filter and search expressions.
CountRequestBuilder<SupplierListCompanyCode>	countSupplierListCompanyCode()	Deprecated. Fetch the number of entries from the SupplierListCompanyCode entity collection matching the filter and search expressions.
CountRequestBuilder<SupplierListMaterialGroup>	countSupplierListMaterialGroup()	Deprecated. Fetch the number of entries from the SupplierListMaterialGroup entity collection matching the filter and search expressions.
CreateRequestBuilder<SuplrListPrpsdCompanyCode>	createSuplrListProposedCompanyCode(SuplrListPrpsdCompanyCode suplrListPrpsdCompanyCode)	Deprecated. Create a new SuplrListPrpsdCompanyCode entity and save it to the S/4HANA system.
CreateRequestBuilder<SuplrListPrpsdBusinessPartner>	createSuplrListPrpsdBusinessPartner(SuplrListPrpsdBusinessPartner suplrListPrpsdBusinessPartner)	Deprecated. Create a new SuplrListPrpsdBusinessPartner entity and save it to the S/4HANA system.
CreateRequestBuilder<SupplierList>	createSupplierList(SupplierList supplierList)	Deprecated. Create a new SupplierList entity and save it to the S/4HANA system.
CreateRequestBuilder<SupplierListBusinessPartner>	createSupplierListBusinessPartner(SupplierListBusinessPartner supplierListBusinessPartner)	Deprecated. Create a new SupplierListBusinessPartner entity and save it to the S/4HANA system.
DeleteRequestBuilder<SupplierListBusinessPartner>	deleteSupplierListBusinessPartner(SupplierListBusinessPartner supplierListBusinessPartner)	Deprecated. Deletes an existing SupplierListBusinessPartner entity in the S/4HANA system.
DeleteRequestBuilder<SupplierListCompanyCode>	deleteSupplierListCompanyCode(SupplierListCompanyCode supplierListCompanyCode)	Deprecated. Deletes an existing SupplierListCompanyCode entity in the S/4HANA system.
DeleteRequestBuilder<SupplierListMaterialGroup>	deleteSupplierListMaterialGroup(SupplierListMaterialGroup supplierListMaterialGroup)	Deprecated. Deletes an existing SupplierListMaterialGroup entity in the S/4HANA system.
GetAllRequestBuilder<SuplrListPrpsdCompanyCode>	getAllSuplrListProposedCompanyCode()	Deprecated. Fetch multiple SuplrListPrpsdCompanyCode entities.
GetAllRequestBuilder<SuplrListPrpsdBusinessPartner>	getAllSuplrListPrpsdBusinessPartner()	Deprecated. Fetch multiple SuplrListPrpsdBusinessPartner entities.
GetAllRequestBuilder<SupplierList>	getAllSupplierList()	Deprecated. Fetch multiple SupplierList entities.
GetAllRequestBuilder<SupplierListBusinessPartner>	getAllSupplierListBusinessPartner()	Deprecated. Fetch multiple SupplierListBusinessPartner entities.
GetAllRequestBuilder<SupplierListCompanyCode>	getAllSupplierListCompanyCode()	Deprecated. Fetch multiple SupplierListCompanyCode entities.
GetAllRequestBuilder<SupplierListMaterialGroup>	getAllSupplierListMaterialGroup()	Deprecated. Fetch multiple SupplierListMaterialGroup entities.
GetByKeyRequestBuilder<SuplrListPrpsdCompanyCode>	getSuplrListProposedCompanyCodeByKey(UUID suplrListPrpsdCompanyCodeUUID)	Deprecated. Fetch a single SuplrListPrpsdCompanyCode entity using key fields.
GetByKeyRequestBuilder<SuplrListPrpsdBusinessPartner>	getSuplrListPrpsdBusinessPartnerByKey(UUID suplrListProposedSupplierUUID)	Deprecated. Fetch a single SuplrListPrpsdBusinessPartner entity using key fields.
GetByKeyRequestBuilder<SupplierListBusinessPartner>	getSupplierListBusinessPartnerByKey(UUID suplrListBusinessPartnerUUID)	Deprecated. Fetch a single SupplierListBusinessPartner entity using key fields.
GetByKeyRequestBuilder<SupplierList>	getSupplierListByKey(UUID supplierListUUID)	Deprecated. Fetch a single SupplierList entity using key fields.
GetByKeyRequestBuilder<SupplierListCompanyCode>	getSupplierListCompanyCodeByKey(UUID companyCodeUUID)	Deprecated. Fetch a single SupplierListCompanyCode entity using key fields.
GetByKeyRequestBuilder<SupplierListMaterialGroup>	getSupplierListMaterialGroupByKey(UUID materialGroupUUID)	Deprecated. Fetch a single SupplierListMaterialGroup entity using key fields.
UpdateRequestBuilder<SupplierList>	updateSupplierList(SupplierList supplierList)	Deprecated. Update an existing SupplierList entity and save it to the S/4HANA system.
UpdateRequestBuilder<SupplierListBusinessPartner>	updateSupplierListBusinessPartner(SupplierListBusinessPartner supplierListBusinessPartner)	Deprecated. Update an existing SupplierListBusinessPartner entity and save it to the S/4HANA system.
PreferredSupplierListService	withServicePath(String servicePath)	Deprecated. Overrides the default service path and returns a new service instance with the specified service path.

Field Details

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

Deprecated.

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 Details

withServicePath

@Nonnull
PreferredSupplierListService withServicePath(@Nonnull
 String servicePath)

Deprecated.

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

Deprecated.

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.

getAllSuplrListProposedCompanyCode

@Nonnull
GetAllRequestBuilder<SuplrListPrpsdCompanyCode> getAllSuplrListProposedCompanyCode()

Deprecated.

Fetch multiple SuplrListPrpsdCompanyCode entities.

Returns:

A request builder to fetch multiple SuplrListPrpsdCompanyCode 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.

countSuplrListProposedCompanyCode

@Nonnull
CountRequestBuilder<SuplrListPrpsdCompanyCode> countSuplrListProposedCompanyCode()

Deprecated.

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

Returns:

A request builder to fetch the count of SuplrListPrpsdCompanyCode 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.

getSuplrListProposedCompanyCodeByKey

@Nonnull
GetByKeyRequestBuilder<SuplrListPrpsdCompanyCode> getSuplrListProposedCompanyCodeByKey(UUID suplrListPrpsdCompanyCodeUUID)

Deprecated.

Fetch a single SuplrListPrpsdCompanyCode entity using key fields.

Parameters:

suplrListPrpsdCompanyCodeUUID - Proposed Company Code UUID

Constraints: Not nullable

Returns:

A request builder to fetch a single SuplrListPrpsdCompanyCode 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.

createSuplrListProposedCompanyCode

@Nonnull
CreateRequestBuilder<SuplrListPrpsdCompanyCode> createSuplrListProposedCompanyCode(@Nonnull
 SuplrListPrpsdCompanyCode suplrListPrpsdCompanyCode)

Deprecated.

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

Parameters:

suplrListPrpsdCompanyCode - SuplrListPrpsdCompanyCode entity object that will be created in the S/4HANA system.

Returns:

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

getAllSuplrListPrpsdBusinessPartner

@Nonnull
GetAllRequestBuilder<SuplrListPrpsdBusinessPartner> getAllSuplrListPrpsdBusinessPartner()

Deprecated.

Fetch multiple SuplrListPrpsdBusinessPartner entities.

Returns:

A request builder to fetch multiple SuplrListPrpsdBusinessPartner 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.

countSuplrListPrpsdBusinessPartner

@Nonnull
CountRequestBuilder<SuplrListPrpsdBusinessPartner> countSuplrListPrpsdBusinessPartner()

Deprecated.

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

Returns:

A request builder to fetch the count of SuplrListPrpsdBusinessPartner 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.

getSuplrListPrpsdBusinessPartnerByKey

@Nonnull
GetByKeyRequestBuilder<SuplrListPrpsdBusinessPartner> getSuplrListPrpsdBusinessPartnerByKey(UUID suplrListProposedSupplierUUID)

Deprecated.

Fetch a single SuplrListPrpsdBusinessPartner entity using key fields.

Parameters:

suplrListProposedSupplierUUID - Proposed Supplier UUID

Constraints: Not nullable

Returns:

A request builder to fetch a single SuplrListPrpsdBusinessPartner 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.

createSuplrListPrpsdBusinessPartner

@Nonnull
CreateRequestBuilder<SuplrListPrpsdBusinessPartner> createSuplrListPrpsdBusinessPartner(@Nonnull
 SuplrListPrpsdBusinessPartner suplrListPrpsdBusinessPartner)

Deprecated.

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

Parameters:

suplrListPrpsdBusinessPartner - SuplrListPrpsdBusinessPartner entity object that will be created in the S/4HANA system.

Returns:

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

getAllSupplierList

@Nonnull
GetAllRequestBuilder<SupplierList> getAllSupplierList()

Deprecated.

Fetch multiple SupplierList entities.

Returns:

A request builder to fetch multiple SupplierList 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.

countSupplierList

@Nonnull
CountRequestBuilder<SupplierList> countSupplierList()

Deprecated.

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

Returns:

A request builder to fetch the count of SupplierList 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.

getSupplierListByKey

@Nonnull
GetByKeyRequestBuilder<SupplierList> getSupplierListByKey(UUID supplierListUUID)

Deprecated.

Fetch a single SupplierList entity using key fields.

Parameters:

supplierListUUID - Supplier List UUID

Constraints: Not nullable

Returns:

A request builder to fetch a single SupplierList 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.

createSupplierList

@Nonnull
CreateRequestBuilder<SupplierList> createSupplierList(@Nonnull
 SupplierList supplierList)

Deprecated.

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

Parameters:

supplierList - SupplierList entity object that will be created in the S/4HANA system.

Returns:

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

updateSupplierList

@Nonnull
UpdateRequestBuilder<SupplierList> updateSupplierList(@Nonnull
 SupplierList supplierList)

Deprecated.

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

Parameters:

supplierList - SupplierList entity object that will be updated in the S/4HANA system.

Returns:

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

getAllSupplierListBusinessPartner

@Nonnull
GetAllRequestBuilder<SupplierListBusinessPartner> getAllSupplierListBusinessPartner()

Deprecated.

Fetch multiple SupplierListBusinessPartner entities.

Returns:

A request builder to fetch multiple SupplierListBusinessPartner 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.

countSupplierListBusinessPartner

@Nonnull
CountRequestBuilder<SupplierListBusinessPartner> countSupplierListBusinessPartner()

Deprecated.

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

Returns:

A request builder to fetch the count of SupplierListBusinessPartner 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.

getSupplierListBusinessPartnerByKey

@Nonnull
GetByKeyRequestBuilder<SupplierListBusinessPartner> getSupplierListBusinessPartnerByKey(UUID suplrListBusinessPartnerUUID)

Deprecated.

Fetch a single SupplierListBusinessPartner entity using key fields.

Parameters:

suplrListBusinessPartnerUUID - Supplier Business Partner UUID

Constraints: Not nullable

Returns:

A request builder to fetch a single SupplierListBusinessPartner 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.

createSupplierListBusinessPartner

@Nonnull
CreateRequestBuilder<SupplierListBusinessPartner> createSupplierListBusinessPartner(@Nonnull
 SupplierListBusinessPartner supplierListBusinessPartner)

Deprecated.

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

Parameters:

supplierListBusinessPartner - SupplierListBusinessPartner entity object that will be created in the S/4HANA system.

Returns:

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

updateSupplierListBusinessPartner

@Nonnull
UpdateRequestBuilder<SupplierListBusinessPartner> updateSupplierListBusinessPartner(@Nonnull
 SupplierListBusinessPartner supplierListBusinessPartner)

Deprecated.

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

Parameters:

supplierListBusinessPartner - SupplierListBusinessPartner entity object that will be updated in the S/4HANA system.

Returns:

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

deleteSupplierListBusinessPartner

@Nonnull
DeleteRequestBuilder<SupplierListBusinessPartner> deleteSupplierListBusinessPartner(@Nonnull
 SupplierListBusinessPartner supplierListBusinessPartner)

Deprecated.

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

Parameters:

supplierListBusinessPartner - SupplierListBusinessPartner entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllSupplierListCompanyCode

@Nonnull
GetAllRequestBuilder<SupplierListCompanyCode> getAllSupplierListCompanyCode()

Deprecated.

Fetch multiple SupplierListCompanyCode entities.

Returns:

A request builder to fetch multiple SupplierListCompanyCode 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.

countSupplierListCompanyCode

@Nonnull
CountRequestBuilder<SupplierListCompanyCode> countSupplierListCompanyCode()

Deprecated.

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

Returns:

A request builder to fetch the count of SupplierListCompanyCode 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.

getSupplierListCompanyCodeByKey

@Nonnull
GetByKeyRequestBuilder<SupplierListCompanyCode> getSupplierListCompanyCodeByKey(UUID companyCodeUUID)

Deprecated.

Fetch a single SupplierListCompanyCode entity using key fields.

Parameters:

companyCodeUUID - Company Code UUID

Constraints: Not nullable

Returns:

A request builder to fetch a single SupplierListCompanyCode 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.

deleteSupplierListCompanyCode

@Nonnull
DeleteRequestBuilder<SupplierListCompanyCode> deleteSupplierListCompanyCode(@Nonnull
 SupplierListCompanyCode supplierListCompanyCode)

Deprecated.

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

Parameters:

supplierListCompanyCode - SupplierListCompanyCode entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllSupplierListMaterialGroup

@Nonnull
GetAllRequestBuilder<SupplierListMaterialGroup> getAllSupplierListMaterialGroup()

Deprecated.

Fetch multiple SupplierListMaterialGroup entities.

Returns:

A request builder to fetch multiple SupplierListMaterialGroup 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.

countSupplierListMaterialGroup

@Nonnull
CountRequestBuilder<SupplierListMaterialGroup> countSupplierListMaterialGroup()

Deprecated.

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

Returns:

A request builder to fetch the count of SupplierListMaterialGroup 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.

getSupplierListMaterialGroupByKey

@Nonnull
GetByKeyRequestBuilder<SupplierListMaterialGroup> getSupplierListMaterialGroupByKey(UUID materialGroupUUID)

Deprecated.

Fetch a single SupplierListMaterialGroup entity using key fields.

Parameters:

materialGroupUUID - Material Group UUID

Constraints: Not nullable

Returns:

A request builder to fetch a single SupplierListMaterialGroup 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.

deleteSupplierListMaterialGroup

@Nonnull
DeleteRequestBuilder<SupplierListMaterialGroup> deleteSupplierListMaterialGroup(@Nonnull
 SupplierListMaterialGroup supplierListMaterialGroup)

Deprecated.

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

Parameters:

supplierListMaterialGroup - SupplierListMaterialGroup entity object that will be deleted in the S/4HANA system.

Returns:

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