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

Interface ProductStructureService

All Superinterfaces:

BatchService<ProductStructureServiceBatch>

All Known Implementing Classes:

DefaultProductStructureService

public interface ProductStructureService
extends BatchService<ProductStructureServiceBatch>

This service contains product structure nodes and product structure variants as the main entity. It enables you to read the product structure information including product nodes and product structure variants. It is based on the OData protocol and can be consumed by apps and other user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PRODUCT_STRUCTURE_SRV
API Version:	1
Communication Scenario:	Product Lifecycle Management - Product Structure Integration (SAP_COM_0346)
Scope Items:	Product Structure Management (3ND)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	ProductStructure

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
ProductStructureNodeFluentHelper	getAllProductStructureNode() Fetch multiple ProductStructureNode entities.
ProductStructureVariantFluentHelper	getAllProductStructureVariant() Fetch multiple ProductStructureVariant entities.
ProductStructureNodeByKeyFluentHelper	getProductStructureNodeByKey(UUID productStructureNodeUUID) Fetch a single ProductStructureNode entity using key fields.
ProductStructureVariantByKeyFluentHelper	getProductStructureVariantByKey(UUID productStructureVariantUUID, String prodStrucVariantChgStateIntID) Fetch a single ProductStructureVariant entity using key fields.
ProductStructureService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

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

getAllProductStructureNode

@Nonnull
ProductStructureNodeFluentHelper getAllProductStructureNode()

Fetch multiple ProductStructureNode entities.

Returns:

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

getProductStructureNodeByKey

@Nonnull
ProductStructureNodeByKeyFluentHelper getProductStructureNodeByKey(UUID productStructureNodeUUID)

Fetch a single ProductStructureNode entity using key fields.

Parameters:

productStructureNodeUUID - Internal Number of iPPE Node

Constraints: Not nullable

Returns:

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

getAllProductStructureVariant

@Nonnull
ProductStructureVariantFluentHelper getAllProductStructureVariant()

Fetch multiple ProductStructureVariant entities.

Returns:

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

getProductStructureVariantByKey

@Nonnull
ProductStructureVariantByKeyFluentHelper getProductStructureVariantByKey(UUID productStructureVariantUUID,
                                                                                  String prodStrucVariantChgStateIntID)

Fetch a single ProductStructureVariant entity using key fields.

Parameters:

productStructureVariantUUID - Internal Number of the PVS Variant

Constraints: Not nullable

prodStrucVariantChgStateIntID - Differentiates iPPE objects (such as relationship types) that link different iPPE objects but have the same name.

Constraints: Not nullable, Maximum length: 8

Returns:

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