A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.
The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".
The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.
Split Identification Number. Identifies partial qantities of a specific returns item. The quantity of a specific returns item may be split up during the returns process, for example, because partial quantities of the returns item were assigned to different follow-up activities. These partial quantities are identified internally with a split ID. Maximum length: 3.
Execution Step Status. Maximum length: 1.
Process Identification Number. Specifies the unique identifier of the advanced returns process. Maximum length: 10.
Item Number. Specifies an item in the start document of a returns process. This can be a returns order, a returns purchase order, or a returns stock transport order. Maximum length: 6.
Step ID. Describes a given document, such as a returns order, an inbound delivery, or a purchase order, in the advanced returns process. Table MSR_I_STEP contains all valid step IDs. The advanced returns sequence Customer return received directly comprises the following steps:0001 Create Returns Order0021 Inbound Delivery0031 Goods Receipt0041 Inspection. Maximum length: 4.
Document Number. Specifies the document number of a returns document. Maximum length: 30.
Approval Status of Returns Process. Maximum length: 1.
Document Item. Specifies an item of the displayed document. Maximum length: 10.
Status of Document Item. Specifies the status of the document item. A document item can have the following statuses:ActiveThe document item has been created without errors.Deletion Flag SetThe document item has been deleted.Document Was CancelledThe document item has been cancelled and a corresponding reversal or cancellation document exists.Reversal (Cancellation) DocumentThis is a cancellation or reversal document and a corresponding cancelled document exists. Maximum length: 1.
Document Type. Specifies the returns document type, such as a returns order, goods movement, or credit memo. Maximum length: 2.
Document Number. Specifies the document number of a returns document. Maximum length: 30.
Document Item. Specifies an item of the displayed document. Maximum length: 10.
Document Type. Specifies the returns document type, such as a returns order, goods movement, or credit memo. Maximum length: 2.
One-to-one navigation property to the CustomerReturn entity.
One-to-one navigation property to the CustomerReturnItem entity.
ETag version identifier accessor.
All fields selector.
Static representation of the retsMgmtProcess property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the retsMgmtProcessItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the retsMgmtProcessStep property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the retsMgmtProcItmQtySplit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the retsMgmtProcStepExecStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the returnsDocument property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the returnsDocumentApprovalStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the returnsDocumentItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the returnsDocumentStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the returnsDocumentType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the returnsReferenceDocument property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the returnsReferenceDocumentItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the returnsReferenceDocumentType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-one navigation property toCustomerReturn for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-one navigation property toCustomerReturnItem for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
All fields of the CustomerReturnProcessStep entity.
Default url path for the according service.
Technical entity name for CustomerReturnProcessStep.
All key fields of the CustomerReturnProcessStep entity.
Mapping of all key field names to the respective static field property CustomerReturnProcessStep.
Returns a map of all defined fields in entity to their current values.
Entity with all defined entity fields
Custom field value getter.
The name of the custom field
The value of the corresponding custom field
Returns a map that contains all entity custom fields.
A map of all defined custom fields in the entity
Returns all updated custom field properties compared to the last known remote state.
A map containing all updated custom properties, with their new values
Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.
Entity with all properties that changed
Validates whether a custom field exists in the entity.
The name of the custom field to update
A boolean value, that indicates whether a custom field is defined in entity
Sets all retrieved custom fields in entity.
Extracted custom fields from a retrieved entity
A boolean value, that indicates the existence of the field in entity
Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
Field name to check
Boolean value that describes whether a field name can be defined as custom field
Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.
The name of the custom field to update
The value of the field
The entity itself, to facilitate method chaining
Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.
State to be set as remote state
The entity itself, to facilitate method chaining
Set the ETag version identifier of the retrieved entity.
The returned ETag version of the entity
The entity itself, to facilitate method chaining
Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Returns an entity builder to construct instances CustomerReturnProcessStep.
A builder that constructs instances of entity type CustomerReturnProcessStep.
Returns a selectable object that allows the selection of custom field in a get request for the entity CustomerReturnProcessStep.
Name of the custom field to select
A builder that constructs instances of entity type CustomerReturnProcessStep.
Returns a request builder to construct requests for operations on the CustomerReturnProcessStep entity type.
A CustomerReturnProcessStep request builder.
This class represents the entity "A_CustomerReturnProcessStep" of service "API_CUSTOMER_RETURN_SRV". This service is part of the following communication scenarios: Customer Return Integration (SAP_COM_0157). See https://api.sap.com/api/API_CUSTOMER_RETURN_SRV for more information.