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

Interface ChangeRecordService

All Superinterfaces:

BatchService<ChangeRecordServiceBatch>

All Known Implementing Classes:

DefaultChangeRecordService

public interface ChangeRecordService
extends BatchService<ChangeRecordServiceBatch>

You can create, read, and delete change records as header objects. You can also assign (write), read, and delete the following objects belonging to change records: - BOM - BOM item - Document info record - Material - Product structure variant.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CHANGE_RECORD
API Version:	1
Communication Scenario:	Product Lifecycle Management - Change Record Integration (SAP_COM_0339)
Scope Items:	Engineering Change Management with Change Records (1NF)
Authentication Methods:	Basic, x509
Business Object:	ChangeRecord

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
ChangeRecordCreateFluentHelper	createChangeRecord(ChangeRecord changeRecord) Create a new ChangeRecord entity and save it to the S/4HANA system.
ChangeRecordReferenceBitCreateFluentHelper	createChangeRecordReferenceBit(ChangeRecordReferenceBit changeRecordReferenceBit) Create a new ChangeRecordReferenceBit entity and save it to the S/4HANA system.
ChangeRecordReferenceBOMCreateFluentHelper	createChangeRecordReferenceBOM(ChangeRecordReferenceBOM changeRecordReferenceBOM) Create a new ChangeRecordReferenceBOM entity and save it to the S/4HANA system.
ChangeRecordReferenceDocCreateFluentHelper	createChangeRecordReferenceDoc(ChangeRecordReferenceDoc changeRecordReferenceDoc) Create a new ChangeRecordReferenceDoc entity and save it to the S/4HANA system.
ChangeRecordReferenceMatCreateFluentHelper	createChangeRecordReferenceMat(ChangeRecordReferenceMat changeRecordReferenceMat) Create a new ChangeRecordReferenceMat entity and save it to the S/4HANA system.
ChangeRecordReferencePSVCreateFluentHelper	createChangeRecordReferencePSV(ChangeRecordReferencePSV changeRecordReferencePSV) Create a new ChangeRecordReferencePSV entity and save it to the S/4HANA system.
ChangeRecordReferenceBitDeleteFluentHelper	deleteChangeRecordReferenceBit(ChangeRecordReferenceBit changeRecordReferenceBit) Deletes an existing ChangeRecordReferenceBit entity in the S/4HANA system.
ChangeRecordReferenceBOMDeleteFluentHelper	deleteChangeRecordReferenceBOM(ChangeRecordReferenceBOM changeRecordReferenceBOM) Deletes an existing ChangeRecordReferenceBOM entity in the S/4HANA system.
ChangeRecordReferenceDocDeleteFluentHelper	deleteChangeRecordReferenceDoc(ChangeRecordReferenceDoc changeRecordReferenceDoc) Deletes an existing ChangeRecordReferenceDoc entity in the S/4HANA system.
ChangeRecordReferenceMatDeleteFluentHelper	deleteChangeRecordReferenceMat(ChangeRecordReferenceMat changeRecordReferenceMat) Deletes an existing ChangeRecordReferenceMat entity in the S/4HANA system.
ChangeRecordReferencePSVDeleteFluentHelper	deleteChangeRecordReferencePSV(ChangeRecordReferencePSV changeRecordReferencePSV) Deletes an existing ChangeRecordReferencePSV entity in the S/4HANA system.
ChangeRecordFluentHelper	getAllChangeRecord() Fetch multiple ChangeRecord entities.
ChangeRecordReferenceBitFluentHelper	getAllChangeRecordReferenceBit() Fetch multiple ChangeRecordReferenceBit entities.
ChangeRecordReferenceBOMFluentHelper	getAllChangeRecordReferenceBOM() Fetch multiple ChangeRecordReferenceBOM entities.
ChangeRecordReferenceDocFluentHelper	getAllChangeRecordReferenceDoc() Fetch multiple ChangeRecordReferenceDoc entities.
ChangeRecordReferenceMatFluentHelper	getAllChangeRecordReferenceMat() Fetch multiple ChangeRecordReferenceMat entities.
ChangeRecordReferencePSVFluentHelper	getAllChangeRecordReferencePSV() Fetch multiple ChangeRecordReferencePSV entities.
ChangeRecordByKeyFluentHelper	getChangeRecordByKey(UUID changeRecordUUID) Fetch a single ChangeRecord entity using key fields.
ChangeRecordReferenceBitByKeyFluentHelper	getChangeRecordReferenceBitByKey(UUID changeRecordReferenceUUID) Fetch a single ChangeRecordReferenceBit entity using key fields.
ChangeRecordReferenceBOMByKeyFluentHelper	getChangeRecordReferenceBOMByKey(UUID changeRecordReferenceUUID) Fetch a single ChangeRecordReferenceBOM entity using key fields.
ChangeRecordReferenceDocByKeyFluentHelper	getChangeRecordReferenceDocByKey(UUID changeRecordReferenceUUID) Fetch a single ChangeRecordReferenceDoc entity using key fields.
ChangeRecordReferenceMatByKeyFluentHelper	getChangeRecordReferenceMatByKey(UUID changeRecordReferenceUUID) Fetch a single ChangeRecordReferenceMat entity using key fields.
ChangeRecordReferencePSVByKeyFluentHelper	getChangeRecordReferencePSVByKey(UUID changeRecordReferenceUUID) Fetch a single ChangeRecordReferencePSV entity using key fields.
ChangeRecordUpdateFluentHelper	updateChangeRecord(ChangeRecord changeRecord) Update an existing ChangeRecord entity and save it to the S/4HANA system.
ChangeRecordReferenceBitUpdateFluentHelper	updateChangeRecordReferenceBit(ChangeRecordReferenceBit changeRecordReferenceBit) Update an existing ChangeRecordReferenceBit entity and save it to the S/4HANA system.
ChangeRecordReferenceBOMUpdateFluentHelper	updateChangeRecordReferenceBOM(ChangeRecordReferenceBOM changeRecordReferenceBOM) Update an existing ChangeRecordReferenceBOM entity and save it to the S/4HANA system.
ChangeRecordReferenceDocUpdateFluentHelper	updateChangeRecordReferenceDoc(ChangeRecordReferenceDoc changeRecordReferenceDoc) Update an existing ChangeRecordReferenceDoc entity and save it to the S/4HANA system.
ChangeRecordReferenceMatUpdateFluentHelper	updateChangeRecordReferenceMat(ChangeRecordReferenceMat changeRecordReferenceMat) Update an existing ChangeRecordReferenceMat entity and save it to the S/4HANA system.
ChangeRecordReferencePSVUpdateFluentHelper	updateChangeRecordReferencePSV(ChangeRecordReferencePSV changeRecordReferencePSV) Update an existing ChangeRecordReferencePSV entity and save it to the S/4HANA system.
ChangeRecordService	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
ChangeRecordService 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.

getAllChangeRecord

@Nonnull
ChangeRecordFluentHelper getAllChangeRecord()

Fetch multiple ChangeRecord entities.

Returns:

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

getChangeRecordByKey

@Nonnull
ChangeRecordByKeyFluentHelper getChangeRecordByKey(UUID changeRecordUUID)

Fetch a single ChangeRecord entity using key fields.

Parameters:

changeRecordUUID - NodeID

Constraints: Not nullable

Returns:

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

createChangeRecord

@Nonnull
ChangeRecordCreateFluentHelper createChangeRecord(@Nonnull
                                                           ChangeRecord changeRecord)

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

Parameters:

changeRecord - ChangeRecord entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ChangeRecord entity. To perform execution, call the execute method on the fluent helper object.

updateChangeRecord

@Nonnull
ChangeRecordUpdateFluentHelper updateChangeRecord(@Nonnull
                                                           ChangeRecord changeRecord)

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

Parameters:

changeRecord - ChangeRecord entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ChangeRecord entity. To perform execution, call the execute method on the fluent helper object.

getAllChangeRecordReferenceBit

@Nonnull
ChangeRecordReferenceBitFluentHelper getAllChangeRecordReferenceBit()

Fetch multiple ChangeRecordReferenceBit entities.

Returns:

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

getChangeRecordReferenceBitByKey

@Nonnull
ChangeRecordReferenceBitByKeyFluentHelper getChangeRecordReferenceBitByKey(UUID changeRecordReferenceUUID)

Fetch a single ChangeRecordReferenceBit entity using key fields.

Parameters:

changeRecordReferenceUUID - NodeID

Constraints: Not nullable

Returns:

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

createChangeRecordReferenceBit

@Nonnull
ChangeRecordReferenceBitCreateFluentHelper createChangeRecordReferenceBit(@Nonnull
                                                                                   ChangeRecordReferenceBit changeRecordReferenceBit)

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

Parameters:

changeRecordReferenceBit - ChangeRecordReferenceBit entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ChangeRecordReferenceBit entity. To perform execution, call the execute method on the fluent helper object.

updateChangeRecordReferenceBit

@Nonnull
ChangeRecordReferenceBitUpdateFluentHelper updateChangeRecordReferenceBit(@Nonnull
                                                                                   ChangeRecordReferenceBit changeRecordReferenceBit)

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

Parameters:

changeRecordReferenceBit - ChangeRecordReferenceBit entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ChangeRecordReferenceBit entity. To perform execution, call the execute method on the fluent helper object.

deleteChangeRecordReferenceBit

@Nonnull
ChangeRecordReferenceBitDeleteFluentHelper deleteChangeRecordReferenceBit(@Nonnull
                                                                                   ChangeRecordReferenceBit changeRecordReferenceBit)

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

Parameters:

changeRecordReferenceBit - ChangeRecordReferenceBit entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing ChangeRecordReferenceBit entity. To perform execution, call the execute method on the fluent helper object.

getAllChangeRecordReferenceBOM

@Nonnull
ChangeRecordReferenceBOMFluentHelper getAllChangeRecordReferenceBOM()

Fetch multiple ChangeRecordReferenceBOM entities.

Returns:

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

getChangeRecordReferenceBOMByKey

@Nonnull
ChangeRecordReferenceBOMByKeyFluentHelper getChangeRecordReferenceBOMByKey(UUID changeRecordReferenceUUID)

Fetch a single ChangeRecordReferenceBOM entity using key fields.

Parameters:

changeRecordReferenceUUID - NodeID

Constraints: Not nullable

Returns:

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

createChangeRecordReferenceBOM

@Nonnull
ChangeRecordReferenceBOMCreateFluentHelper createChangeRecordReferenceBOM(@Nonnull
                                                                                   ChangeRecordReferenceBOM changeRecordReferenceBOM)

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

Parameters:

changeRecordReferenceBOM - ChangeRecordReferenceBOM entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ChangeRecordReferenceBOM entity. To perform execution, call the execute method on the fluent helper object.

updateChangeRecordReferenceBOM

@Nonnull
ChangeRecordReferenceBOMUpdateFluentHelper updateChangeRecordReferenceBOM(@Nonnull
                                                                                   ChangeRecordReferenceBOM changeRecordReferenceBOM)

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

Parameters:

changeRecordReferenceBOM - ChangeRecordReferenceBOM entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ChangeRecordReferenceBOM entity. To perform execution, call the execute method on the fluent helper object.

deleteChangeRecordReferenceBOM

@Nonnull
ChangeRecordReferenceBOMDeleteFluentHelper deleteChangeRecordReferenceBOM(@Nonnull
                                                                                   ChangeRecordReferenceBOM changeRecordReferenceBOM)

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

Parameters:

changeRecordReferenceBOM - ChangeRecordReferenceBOM entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing ChangeRecordReferenceBOM entity. To perform execution, call the execute method on the fluent helper object.

getAllChangeRecordReferenceDoc

@Nonnull
ChangeRecordReferenceDocFluentHelper getAllChangeRecordReferenceDoc()

Fetch multiple ChangeRecordReferenceDoc entities.

Returns:

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

getChangeRecordReferenceDocByKey

@Nonnull
ChangeRecordReferenceDocByKeyFluentHelper getChangeRecordReferenceDocByKey(UUID changeRecordReferenceUUID)

Fetch a single ChangeRecordReferenceDoc entity using key fields.

Parameters:

changeRecordReferenceUUID - NodeID

Constraints: Not nullable

Returns:

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

createChangeRecordReferenceDoc

@Nonnull
ChangeRecordReferenceDocCreateFluentHelper createChangeRecordReferenceDoc(@Nonnull
                                                                                   ChangeRecordReferenceDoc changeRecordReferenceDoc)

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

Parameters:

changeRecordReferenceDoc - ChangeRecordReferenceDoc entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ChangeRecordReferenceDoc entity. To perform execution, call the execute method on the fluent helper object.

updateChangeRecordReferenceDoc

@Nonnull
ChangeRecordReferenceDocUpdateFluentHelper updateChangeRecordReferenceDoc(@Nonnull
                                                                                   ChangeRecordReferenceDoc changeRecordReferenceDoc)

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

Parameters:

changeRecordReferenceDoc - ChangeRecordReferenceDoc entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ChangeRecordReferenceDoc entity. To perform execution, call the execute method on the fluent helper object.

deleteChangeRecordReferenceDoc

@Nonnull
ChangeRecordReferenceDocDeleteFluentHelper deleteChangeRecordReferenceDoc(@Nonnull
                                                                                   ChangeRecordReferenceDoc changeRecordReferenceDoc)

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

Parameters:

changeRecordReferenceDoc - ChangeRecordReferenceDoc entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing ChangeRecordReferenceDoc entity. To perform execution, call the execute method on the fluent helper object.

getAllChangeRecordReferenceMat

@Nonnull
ChangeRecordReferenceMatFluentHelper getAllChangeRecordReferenceMat()

Fetch multiple ChangeRecordReferenceMat entities.

Returns:

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

getChangeRecordReferenceMatByKey

@Nonnull
ChangeRecordReferenceMatByKeyFluentHelper getChangeRecordReferenceMatByKey(UUID changeRecordReferenceUUID)

Fetch a single ChangeRecordReferenceMat entity using key fields.

Parameters:

changeRecordReferenceUUID - NodeID

Constraints: Not nullable

Returns:

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

createChangeRecordReferenceMat

@Nonnull
ChangeRecordReferenceMatCreateFluentHelper createChangeRecordReferenceMat(@Nonnull
                                                                                   ChangeRecordReferenceMat changeRecordReferenceMat)

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

Parameters:

changeRecordReferenceMat - ChangeRecordReferenceMat entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ChangeRecordReferenceMat entity. To perform execution, call the execute method on the fluent helper object.

updateChangeRecordReferenceMat

@Nonnull
ChangeRecordReferenceMatUpdateFluentHelper updateChangeRecordReferenceMat(@Nonnull
                                                                                   ChangeRecordReferenceMat changeRecordReferenceMat)

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

Parameters:

changeRecordReferenceMat - ChangeRecordReferenceMat entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ChangeRecordReferenceMat entity. To perform execution, call the execute method on the fluent helper object.

deleteChangeRecordReferenceMat

@Nonnull
ChangeRecordReferenceMatDeleteFluentHelper deleteChangeRecordReferenceMat(@Nonnull
                                                                                   ChangeRecordReferenceMat changeRecordReferenceMat)

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

Parameters:

changeRecordReferenceMat - ChangeRecordReferenceMat entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing ChangeRecordReferenceMat entity. To perform execution, call the execute method on the fluent helper object.

getAllChangeRecordReferencePSV

@Nonnull
ChangeRecordReferencePSVFluentHelper getAllChangeRecordReferencePSV()

Fetch multiple ChangeRecordReferencePSV entities.

Returns:

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

getChangeRecordReferencePSVByKey

@Nonnull
ChangeRecordReferencePSVByKeyFluentHelper getChangeRecordReferencePSVByKey(UUID changeRecordReferenceUUID)

Fetch a single ChangeRecordReferencePSV entity using key fields.

Parameters:

changeRecordReferenceUUID - NodeID

Constraints: Not nullable

Returns:

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

createChangeRecordReferencePSV

@Nonnull
ChangeRecordReferencePSVCreateFluentHelper createChangeRecordReferencePSV(@Nonnull
                                                                                   ChangeRecordReferencePSV changeRecordReferencePSV)

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

Parameters:

changeRecordReferencePSV - ChangeRecordReferencePSV entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ChangeRecordReferencePSV entity. To perform execution, call the execute method on the fluent helper object.

updateChangeRecordReferencePSV

@Nonnull
ChangeRecordReferencePSVUpdateFluentHelper updateChangeRecordReferencePSV(@Nonnull
                                                                                   ChangeRecordReferencePSV changeRecordReferencePSV)

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

Parameters:

changeRecordReferencePSV - ChangeRecordReferencePSV entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ChangeRecordReferencePSV entity. To perform execution, call the execute method on the fluent helper object.

deleteChangeRecordReferencePSV

@Nonnull
ChangeRecordReferencePSVDeleteFluentHelper deleteChangeRecordReferencePSV(@Nonnull
                                                                                   ChangeRecordReferencePSV changeRecordReferencePSV)

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

Parameters:

changeRecordReferencePSV - ChangeRecordReferencePSV entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing ChangeRecordReferencePSV entity. To perform execution, call the execute method on the fluent helper object.