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

Class DefaultPackingInstructionService

java.lang.Object

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

All Implemented Interfaces:

BatchService<PackingInstructionServiceBatch>, PackingInstructionService

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

In every API call, you can make use of the following operations: - Retrieve header information for a packing instruction. You can use filter criteria to retrieve information based on other selection criteria, for example, material number. - Retrieve component information for a packing instruction, which contains information about the products packed in the handling unit. - Retrieve texts in different languages for a packing instruction. You can apply the filters provided or retrieve all existing data. #.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PACKINGINSTRUCTION
API Version:	1
Communication Scenario:	Packing Instruction Integration (SAP_COM_0399)
Scope Items:	Handling Unit Management (4MM)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	PackingInstruction

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.PackingInstructionService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultPackingInstructionService() Creates a service using PackingInstructionService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultPackingInstructionServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
PackingInstructionComponentFluentHelper	getAllPackingInstructionComponent() Fetch multiple PackingInstructionComponent entities.
PackingInstructionHeaderFluentHelper	getAllPackingInstructionHeader() Fetch multiple PackingInstructionHeader entities.
PackingInstructionTextFluentHelper	getAllPackingInstructionText() Fetch multiple PackingInstructionText entities.
PackingInstructionComponentByKeyFluentHelper	getPackingInstructionComponentByKey(UUID packingInstructionItemSystUUID) Fetch a single PackingInstructionComponent entity using key fields.
PackingInstructionHeaderByKeyFluentHelper	getPackingInstructionHeaderByKey(UUID packingInstructionSystemUUID) Fetch a single PackingInstructionHeader entity using key fields.
PackingInstructionTextByKeyFluentHelper	getPackingInstructionTextByKey(String language, UUID packingInstructionSystemUUID) Fetch a single PackingInstructionText entity using key fields.
DefaultPackingInstructionService	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

DefaultPackingInstructionService

public DefaultPackingInstructionService()

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

Method Detail

withServicePath

@Nonnull
public DefaultPackingInstructionService withServicePath(@Nonnull
                                                                 String servicePath)

Description copied from interface: PackingInstructionService

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 PackingInstructionService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultPackingInstructionServiceBatch batch()

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

Specified by:

batch in interface BatchService<PackingInstructionServiceBatch>

Returns:

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

getAllPackingInstructionComponent

@Nonnull
public PackingInstructionComponentFluentHelper getAllPackingInstructionComponent()

Description copied from interface: PackingInstructionService

Fetch multiple PackingInstructionComponent entities.

Specified by:

getAllPackingInstructionComponent in interface PackingInstructionService

Returns:

A fluent helper to fetch multiple PackingInstructionComponent 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.

getPackingInstructionComponentByKey

@Nonnull
public PackingInstructionComponentByKeyFluentHelper getPackingInstructionComponentByKey(UUID packingInstructionItemSystUUID)

Description copied from interface: PackingInstructionService

Fetch a single PackingInstructionComponent entity using key fields.

Specified by:

getPackingInstructionComponentByKey in interface PackingInstructionService

Parameters:

packingInstructionItemSystUUID - Packing Instruction Component

Constraints: Not nullable

Returns:

A fluent helper to fetch a single PackingInstructionComponent 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.

getAllPackingInstructionHeader

@Nonnull
public PackingInstructionHeaderFluentHelper getAllPackingInstructionHeader()

Description copied from interface: PackingInstructionService

Fetch multiple PackingInstructionHeader entities.

Specified by:

getAllPackingInstructionHeader in interface PackingInstructionService

Returns:

A fluent helper to fetch multiple PackingInstructionHeader 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.

getPackingInstructionHeaderByKey

@Nonnull
public PackingInstructionHeaderByKeyFluentHelper getPackingInstructionHeaderByKey(UUID packingInstructionSystemUUID)

Description copied from interface: PackingInstructionService

Fetch a single PackingInstructionHeader entity using key fields.

Specified by:

getPackingInstructionHeaderByKey in interface PackingInstructionService

Parameters:

packingInstructionSystemUUID - Packing Instruction Number

Constraints: Not nullable

Returns:

A fluent helper to fetch a single PackingInstructionHeader 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.

getAllPackingInstructionText

@Nonnull
public PackingInstructionTextFluentHelper getAllPackingInstructionText()

Description copied from interface: PackingInstructionService

Fetch multiple PackingInstructionText entities.

Specified by:

getAllPackingInstructionText in interface PackingInstructionService

Returns:

A fluent helper to fetch multiple PackingInstructionText 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.

getPackingInstructionTextByKey

@Nonnull
public PackingInstructionTextByKeyFluentHelper getPackingInstructionTextByKey(String language,
                                                                                       UUID packingInstructionSystemUUID)

Description copied from interface: PackingInstructionService

Fetch a single PackingInstructionText entity using key fields.

Specified by:

getPackingInstructionTextByKey in interface PackingInstructionService

Parameters:

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

packingInstructionSystemUUID - Packing Instruction Number

Constraints: Not nullable

Returns:

A fluent helper to fetch a single PackingInstructionText 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.