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

Interface ProductHierarchyNodeService

All Known Implementing Classes:

DefaultProductHierarchyNodeService

public interface ProductHierarchyNodeService

This synchronous inbound OData service enables external systems and other consumers to read currently active version for a given Hierarchy ID, or the version with a specified validity date. You can also use this service to read the details of a particular hierarchy, such as the node, its parent, its children and other attributes of a node, and so on. This information is used in the processes related to sales and distribution..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	PRODHIERNODES_0001
API Version:	1
Communication Scenario:	Product Integration (SAP_COM_0009)
Scope Items:	Master Data Integration (1RO), Opportunity-to-Order with SAP Cloud for Customer (1VP)
Authentication Methods:	Basic, x509, OAuth2
Service Group Name:	API_PROD_HIER_NODES_SRV
Business Object:	Product

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<ProdUniversalHierarchy>	countProdUniversalHierarchy() Fetch the number of entries from the ProdUniversalHierarchy entity collection matching the filter and search expressions.
CountRequestBuilder<ProdUnivHierNodeByHierID>	countProdUnivHierNodeByHierID() Fetch the number of entries from the ProdUnivHierNodeByHierID entity collection matching the filter and search expressions.
GetAllRequestBuilder<ProdUniversalHierarchy>	getAllProdUniversalHierarchy() Fetch multiple ProdUniversalHierarchy entities.
GetAllRequestBuilder<ProdUnivHierNodeByHierID>	getAllProdUnivHierNodeByHierID() Fetch multiple ProdUnivHierNodeByHierID entities.
GetByKeyRequestBuilder<ProdUniversalHierarchy>	getProdUniversalHierarchyByKey(String prodUnivHierarchy, LocalDate prodHierarchyValidityEndDate) Fetch a single ProdUniversalHierarchy entity using key fields.
GetByKeyRequestBuilder<ProdUnivHierNodeByHierID>	getProdUnivHierNodeByHierIDByKey(String prodUnivHierarchy, String hierarchyNode, LocalDate prodHierarchyValidityEndDate) Fetch a single ProdUnivHierNodeByHierID entity using key fields.
ProductHierarchyNodeService	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
ProductHierarchyNodeService 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.

getAllProdUniversalHierarchy

@Nonnull
GetAllRequestBuilder<ProdUniversalHierarchy> getAllProdUniversalHierarchy()

Fetch multiple ProdUniversalHierarchy entities.

Returns:

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

countProdUniversalHierarchy

@Nonnull
CountRequestBuilder<ProdUniversalHierarchy> countProdUniversalHierarchy()

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

Returns:

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

getProdUniversalHierarchyByKey

@Nonnull
GetByKeyRequestBuilder<ProdUniversalHierarchy> getProdUniversalHierarchyByKey(@Nonnull
                                                                                       String prodUnivHierarchy,
                                                                                       @Nonnull
                                                                                       LocalDate prodHierarchyValidityEndDate)

Fetch a single ProdUniversalHierarchy entity using key fields.

Parameters:

prodHierarchyValidityEndDate - Validity End Date

Constraints: Not nullable

prodUnivHierarchy - Product Hierarchy

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllProdUnivHierNodeByHierID

@Nonnull
GetAllRequestBuilder<ProdUnivHierNodeByHierID> getAllProdUnivHierNodeByHierID()

Fetch multiple ProdUnivHierNodeByHierID entities.

Returns:

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

countProdUnivHierNodeByHierID

@Nonnull
CountRequestBuilder<ProdUnivHierNodeByHierID> countProdUnivHierNodeByHierID()

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

Returns:

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

getProdUnivHierNodeByHierIDByKey

@Nonnull
GetByKeyRequestBuilder<ProdUnivHierNodeByHierID> getProdUnivHierNodeByHierIDByKey(@Nonnull
                                                                                           String prodUnivHierarchy,
                                                                                           @Nonnull
                                                                                           String hierarchyNode,
                                                                                           @Nonnull
                                                                                           LocalDate prodHierarchyValidityEndDate)

Fetch a single ProdUnivHierNodeByHierID entity using key fields.

Parameters:

prodHierarchyValidityEndDate - Validity End Date

Constraints: Not nullable

prodUnivHierarchy - Product Hierarchy

Constraints: Not nullable, Maximum length: 20

hierarchyNode - Hierarchy node

Constraints: Not nullable, Maximum length: 50

Returns:

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