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

Class DefaultProductStructureService

java.lang.Object

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

All Implemented Interfaces:

BatchService<ProductStructureServiceBatch>, ProductStructureService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultProductStructureService")
public class DefaultProductStructureService
extends Object
implements ProductStructureService

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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.ProductStructureService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultProductStructureService() Creates a service using ProductStructureService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultProductStructureServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultProductStructureService	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

Constructor Detail

DefaultProductStructureService

public DefaultProductStructureService()

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

Method Detail

withServicePath

@Nonnull
public DefaultProductStructureService withServicePath(@Nonnull
                                                               String servicePath)

Description copied from interface: ProductStructureService

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 ProductStructureService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultProductStructureServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<ProductStructureServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllProductStructureNode

@Nonnull
public ProductStructureNodeFluentHelper getAllProductStructureNode()

Description copied from interface: ProductStructureService

Fetch multiple ProductStructureNode entities.

Specified by:

getAllProductStructureNode in interface ProductStructureService

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
public ProductStructureNodeByKeyFluentHelper getProductStructureNodeByKey(UUID productStructureNodeUUID)

Description copied from interface: ProductStructureService

Fetch a single ProductStructureNode entity using key fields.

Specified by:

getProductStructureNodeByKey in interface ProductStructureService

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
public ProductStructureVariantFluentHelper getAllProductStructureVariant()

Description copied from interface: ProductStructureService

Fetch multiple ProductStructureVariant entities.

Specified by:

getAllProductStructureVariant in interface ProductStructureService

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
public ProductStructureVariantByKeyFluentHelper getProductStructureVariantByKey(UUID productStructureVariantUUID,
                                                                                         String prodStrucVariantChgStateIntID)

Description copied from interface: ProductStructureService

Fetch a single ProductStructureVariant entity using key fields.

Specified by:

getProductStructureVariantByKey in interface ProductStructureService

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.