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

Interface FieldLogisticsShipmentVoyageService

All Known Implementing Classes:

DefaultFieldLogisticsShipmentVoyageService

@Deprecated
public interface FieldLogisticsShipmentVoyageService

Deprecated.

The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

You can create, read, update and delete Field Logistics shipment voyages and respective stages. Additionally, we can also perform the following actions with this API: - Dispatch the containers, handling units, or shipment items, which are assigned to Field Logistics shipment voyage. - Set the status of the Field Logistics shipment voyage to*** Arrived***, which is assigned for containers, handling units, or shipment items..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service:	FLDLOGSSHIPMENTVOYAGE_0001
API Version:	1.0.0
Minimum ERP Version:	2302
Communication Scenario:	Field Logistics - Shipment Voyage Integration(SAP_COM_0753)
Scope Items:	Field Logistics Planning and Execution - Containers and Voyages(6BA)
Authentication Methods:	x509
Service Group Name:	API_FLDLOGSSHIPMENTVOYAGE
Business Object:	FieldLogisticsShipmentVoyage

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SERVICE_PATH	Deprecated. 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	Description
BatchRequestBuilder	batch()	Deprecated. Creates a batch request builder object.
CountRequestBuilder<FieldLogisticsShipmentVoyage>	countFieldLogisticsShipmentVoyage()	Deprecated. Fetch the number of entries from the FieldLogisticsShipmentVoyage entity collection matching the filter and search expressions.
CountRequestBuilder<FieldLogisticsShipmentVoyageStage>	countFieldLogisticsShipmentVoyStage()	Deprecated. Fetch the number of entries from the FieldLogisticsShipmentVoyageStage entity collection matching the filter and search expressions.
CreateRequestBuilder<FieldLogisticsShipmentVoyage>	createFieldLogisticsShipmentVoyage(FieldLogisticsShipmentVoyage fieldLogisticsShipmentVoyage)	Deprecated. Create a new FieldLogisticsShipmentVoyage entity and save it to the S/4HANA system.
CreateRequestBuilder<FieldLogisticsShipmentVoyageStage>	createFieldLogisticsShipmentVoyStage(FieldLogisticsShipmentVoyageStage fieldLogisticsShipmentVoyageStage)	Deprecated. Create a new FieldLogisticsShipmentVoyageStage entity and save it to the S/4HANA system.
DeleteRequestBuilder<FieldLogisticsShipmentVoyage>	deleteFieldLogisticsShipmentVoyage(FieldLogisticsShipmentVoyage fieldLogisticsShipmentVoyage)	Deprecated. Deletes an existing FieldLogisticsShipmentVoyage entity in the S/4HANA system.
DeleteRequestBuilder<FieldLogisticsShipmentVoyageStage>	deleteFieldLogisticsShipmentVoyStage(FieldLogisticsShipmentVoyageStage fieldLogisticsShipmentVoyageStage)	Deprecated. Deletes an existing FieldLogisticsShipmentVoyageStage entity in the S/4HANA system.
GetAllRequestBuilder<FieldLogisticsShipmentVoyage>	getAllFieldLogisticsShipmentVoyage()	Deprecated. Fetch multiple FieldLogisticsShipmentVoyage entities.
GetAllRequestBuilder<FieldLogisticsShipmentVoyageStage>	getAllFieldLogisticsShipmentVoyStage()	Deprecated. Fetch multiple FieldLogisticsShipmentVoyageStage entities.
GetByKeyRequestBuilder<FieldLogisticsShipmentVoyage>	getFieldLogisticsShipmentVoyageByKey(UUID fldLogsShptVoyageUUID)	Deprecated. Fetch a single FieldLogisticsShipmentVoyage entity using key fields.
GetByKeyRequestBuilder<FieldLogisticsShipmentVoyageStage>	getFieldLogisticsShipmentVoyStageByKey(UUID fldLogsShptVoyageUUID, String fldLogsVoyageStageID)	Deprecated. Fetch a single FieldLogisticsShipmentVoyageStage entity using key fields.
UpdateRequestBuilder<FieldLogisticsShipmentVoyage>	updateFieldLogisticsShipmentVoyage(FieldLogisticsShipmentVoyage fieldLogisticsShipmentVoyage)	Deprecated. Update an existing FieldLogisticsShipmentVoyage entity and save it to the S/4HANA system.
UpdateRequestBuilder<FieldLogisticsShipmentVoyageStage>	updateFieldLogisticsShipmentVoyStage(FieldLogisticsShipmentVoyageStage fieldLogisticsShipmentVoyageStage)	Deprecated. Update an existing FieldLogisticsShipmentVoyageStage entity and save it to the S/4HANA system.
FieldLogisticsShipmentVoyageService	withServicePath(String servicePath)	Deprecated. Overrides the default service path and returns a new service instance with the specified service path.

Field Details

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

Deprecated.

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 Details

withServicePath

@Nonnull
FieldLogisticsShipmentVoyageService withServicePath(@Nonnull
 String servicePath)

Deprecated.

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()

Deprecated.

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.

getAllFieldLogisticsShipmentVoyage

@Nonnull
GetAllRequestBuilder<FieldLogisticsShipmentVoyage> getAllFieldLogisticsShipmentVoyage()

Deprecated.

Fetch multiple FieldLogisticsShipmentVoyage entities.

Returns:

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

countFieldLogisticsShipmentVoyage

@Nonnull
CountRequestBuilder<FieldLogisticsShipmentVoyage> countFieldLogisticsShipmentVoyage()

Deprecated.

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

Returns:

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

getFieldLogisticsShipmentVoyageByKey

@Nonnull
GetByKeyRequestBuilder<FieldLogisticsShipmentVoyage> getFieldLogisticsShipmentVoyageByKey(UUID fldLogsShptVoyageUUID)

Deprecated.

Fetch a single FieldLogisticsShipmentVoyage entity using key fields.

Parameters:

fldLogsShptVoyageUUID - Field Logistics: Voyage UUID

Constraints: Not nullable

Returns:

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

createFieldLogisticsShipmentVoyage

@Nonnull
CreateRequestBuilder<FieldLogisticsShipmentVoyage> createFieldLogisticsShipmentVoyage(@Nonnull
 FieldLogisticsShipmentVoyage fieldLogisticsShipmentVoyage)

Deprecated.

Create a new FieldLogisticsShipmentVoyage entity and save it to the S/4HANA system.

Parameters:

fieldLogisticsShipmentVoyage - FieldLogisticsShipmentVoyage entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new FieldLogisticsShipmentVoyage entity. To perform execution, call the execute method on the request builder object.

updateFieldLogisticsShipmentVoyage

@Nonnull
UpdateRequestBuilder<FieldLogisticsShipmentVoyage> updateFieldLogisticsShipmentVoyage(@Nonnull
 FieldLogisticsShipmentVoyage fieldLogisticsShipmentVoyage)

Deprecated.

Update an existing FieldLogisticsShipmentVoyage entity and save it to the S/4HANA system.

Parameters:

fieldLogisticsShipmentVoyage - FieldLogisticsShipmentVoyage entity object that will be updated in the S/4HANA system.

Returns:

A request builder to update an existing FieldLogisticsShipmentVoyage entity. To perform execution, call the execute method on the request builder object.

deleteFieldLogisticsShipmentVoyage

@Nonnull
DeleteRequestBuilder<FieldLogisticsShipmentVoyage> deleteFieldLogisticsShipmentVoyage(@Nonnull
 FieldLogisticsShipmentVoyage fieldLogisticsShipmentVoyage)

Deprecated.

Deletes an existing FieldLogisticsShipmentVoyage entity in the S/4HANA system.

Parameters:

fieldLogisticsShipmentVoyage - FieldLogisticsShipmentVoyage entity object that will be deleted in the S/4HANA system.

Returns:

A request builder to delete an existing FieldLogisticsShipmentVoyage entity. To perform execution, call the execute method on the request builder object.

getAllFieldLogisticsShipmentVoyStage

@Nonnull
GetAllRequestBuilder<FieldLogisticsShipmentVoyageStage> getAllFieldLogisticsShipmentVoyStage()

Deprecated.

Fetch multiple FieldLogisticsShipmentVoyageStage entities.

Returns:

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

countFieldLogisticsShipmentVoyStage

@Nonnull
CountRequestBuilder<FieldLogisticsShipmentVoyageStage> countFieldLogisticsShipmentVoyStage()

Deprecated.

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

Returns:

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

getFieldLogisticsShipmentVoyStageByKey

@Nonnull
GetByKeyRequestBuilder<FieldLogisticsShipmentVoyageStage> getFieldLogisticsShipmentVoyStageByKey(UUID fldLogsShptVoyageUUID,
 String fldLogsVoyageStageID)

Deprecated.

Fetch a single FieldLogisticsShipmentVoyageStage entity using key fields.

Parameters:

fldLogsShptVoyageUUID - Field Logistics: Voyage UUID

Constraints: Not nullable

fldLogsVoyageStageID - Field Logistics: Voyage Stage ID

Constraints: Not nullable, Maximum length: 4

Returns:

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

createFieldLogisticsShipmentVoyStage

@Nonnull
CreateRequestBuilder<FieldLogisticsShipmentVoyageStage> createFieldLogisticsShipmentVoyStage(@Nonnull
 FieldLogisticsShipmentVoyageStage fieldLogisticsShipmentVoyageStage)

Deprecated.

Create a new FieldLogisticsShipmentVoyageStage entity and save it to the S/4HANA system.

Parameters:

fieldLogisticsShipmentVoyageStage - FieldLogisticsShipmentVoyageStage entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new FieldLogisticsShipmentVoyageStage entity. To perform execution, call the execute method on the request builder object.

updateFieldLogisticsShipmentVoyStage

@Nonnull
UpdateRequestBuilder<FieldLogisticsShipmentVoyageStage> updateFieldLogisticsShipmentVoyStage(@Nonnull
 FieldLogisticsShipmentVoyageStage fieldLogisticsShipmentVoyageStage)

Deprecated.

Update an existing FieldLogisticsShipmentVoyageStage entity and save it to the S/4HANA system.

Parameters:

fieldLogisticsShipmentVoyageStage - FieldLogisticsShipmentVoyageStage entity object that will be updated in the S/4HANA system.

Returns:

A request builder to update an existing FieldLogisticsShipmentVoyageStage entity. To perform execution, call the execute method on the request builder object.

deleteFieldLogisticsShipmentVoyStage

@Nonnull
DeleteRequestBuilder<FieldLogisticsShipmentVoyageStage> deleteFieldLogisticsShipmentVoyStage(@Nonnull
 FieldLogisticsShipmentVoyageStage fieldLogisticsShipmentVoyageStage)

Deprecated.

Deletes an existing FieldLogisticsShipmentVoyageStage entity in the S/4HANA system.

Parameters:

fieldLogisticsShipmentVoyageStage - FieldLogisticsShipmentVoyageStage entity object that will be deleted in the S/4HANA system.

Returns:

A request builder to delete an existing FieldLogisticsShipmentVoyageStage entity. To perform execution, call the execute method on the request builder object.