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

Class DefaultProductHierarchyNodeService

java.lang.Object

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

All Implemented Interfaces:

ServiceWithNavigableEntities, ProductHierarchyNodeService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultProductHierarchyNodeService")
public class DefaultProductHierarchyNodeService
extends Object
implements ServiceWithNavigableEntities, 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

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

ServiceWithNavigableEntities.NavigableEntity<EntityT extends VdmEntity<EntityT>>

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.ProductHierarchyNodeService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultProductHierarchyNodeService() Creates a service using ProductHierarchyNodeService.DEFAULT_SERVICE_PATH to send the requests.

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.
String	getServicePath() Getter for the OData service root path.
DefaultProductHierarchyNodeService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

forEntity

Constructor Detail

DefaultProductHierarchyNodeService

public DefaultProductHierarchyNodeService()

Creates a service using ProductHierarchyNodeService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultProductHierarchyNodeService withServicePath(@Nonnull
                                                                   String servicePath)

Description copied from interface: ProductHierarchyNodeService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface ProductHierarchyNodeService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public BatchRequestBuilder batch()

Description copied from interface: ProductHierarchyNodeService

Creates a batch request builder object.

Specified by:

batch in interface ProductHierarchyNodeService

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
public GetAllRequestBuilder<ProdUniversalHierarchy> getAllProdUniversalHierarchy()

Description copied from interface: ProductHierarchyNodeService

Fetch multiple ProdUniversalHierarchy entities.

Specified by:

getAllProdUniversalHierarchy in interface ProductHierarchyNodeService

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
public CountRequestBuilder<ProdUniversalHierarchy> countProdUniversalHierarchy()

Description copied from interface: ProductHierarchyNodeService

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

Specified by:

countProdUniversalHierarchy in interface ProductHierarchyNodeService

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
public GetByKeyRequestBuilder<ProdUniversalHierarchy> getProdUniversalHierarchyByKey(@Nonnull
                                                                                              String prodUnivHierarchy,
                                                                                              @Nonnull
                                                                                              LocalDate prodHierarchyValidityEndDate)

Description copied from interface: ProductHierarchyNodeService

Fetch a single ProdUniversalHierarchy entity using key fields.

Specified by:

getProdUniversalHierarchyByKey in interface ProductHierarchyNodeService

Parameters:

prodUnivHierarchy - Product Hierarchy

Constraints: Not nullable, Maximum length: 20

prodHierarchyValidityEndDate - Validity End Date

Constraints: Not nullable

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
public GetAllRequestBuilder<ProdUnivHierNodeByHierID> getAllProdUnivHierNodeByHierID()

Description copied from interface: ProductHierarchyNodeService

Fetch multiple ProdUnivHierNodeByHierID entities.

Specified by:

getAllProdUnivHierNodeByHierID in interface ProductHierarchyNodeService

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
public CountRequestBuilder<ProdUnivHierNodeByHierID> countProdUnivHierNodeByHierID()

Description copied from interface: ProductHierarchyNodeService

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

Specified by:

countProdUnivHierNodeByHierID in interface ProductHierarchyNodeService

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
public GetByKeyRequestBuilder<ProdUnivHierNodeByHierID> getProdUnivHierNodeByHierIDByKey(@Nonnull
                                                                                                  String prodUnivHierarchy,
                                                                                                  @Nonnull
                                                                                                  String hierarchyNode,
                                                                                                  @Nonnull
                                                                                                  LocalDate prodHierarchyValidityEndDate)

Description copied from interface: ProductHierarchyNodeService

Fetch a single ProdUnivHierNodeByHierID entity using key fields.

Specified by:

getProdUnivHierNodeByHierIDByKey in interface ProductHierarchyNodeService

Parameters:

prodUnivHierarchy - Product Hierarchy

Constraints: Not nullable, Maximum length: 20

hierarchyNode - Hierarchy node

Constraints: Not nullable, Maximum length: 50

prodHierarchyValidityEndDate - Validity End Date

Constraints: Not nullable

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.

getServicePath

@Nonnull
public String getServicePath()

Description copied from interface: ServiceWithNavigableEntities

Getter for the OData service root path.

Specified by:

getServicePath in interface ServiceWithNavigableEntities

Returns:

the service path.