CustomerReturnProcessStep (SAP Cloud SDK

java.lang.Object
- com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
- - com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<CustomerReturnProcessStep>
  - - com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customerreturn.CustomerReturnProcessStep

```
public class CustomerReturnProcessStep
extends VdmEntity<CustomerReturnProcessStep>
```
Customer Return Item Process Step (API)

Original entity name from the Odata EDM: A_CustomerReturnProcessStepType

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CustomerReturnProcessStep.CustomerReturnProcessStepBuilder` Helper class to allow for fluent creation of CustomerReturnProcessStep instances.

Field Summary

Fields
Modifier and Type	Field and Description
`static CustomerReturnProcessStepSelectable`	`ALL_FIELDS` Selector for all available fields of CustomerReturnProcessStep.
`static CustomerReturnProcessStepField<String>`	`RETS_MGMT_PROC_ITM_QTY_SPLIT` Use with available fluent helpers to apply the RetsMgmtProcItmQtySplit field to query operations.
`static CustomerReturnProcessStepField<String>`	`RETS_MGMT_PROC_STEP_EXEC_STATUS` Use with available fluent helpers to apply the RetsMgmtProcStepExecStatus field to query operations.
`static CustomerReturnProcessStepField<String>`	`RETS_MGMT_PROCESS` Use with available fluent helpers to apply the RetsMgmtProcess field to query operations.
`static CustomerReturnProcessStepField<String>`	`RETS_MGMT_PROCESS_ITEM` Use with available fluent helpers to apply the RetsMgmtProcessItem field to query operations.
`static CustomerReturnProcessStepField<String>`	`RETS_MGMT_PROCESS_STEP` Use with available fluent helpers to apply the RetsMgmtProcessStep field to query operations.
`static CustomerReturnProcessStepField<String>`	`RETURNS_DOCUMENT` Use with available fluent helpers to apply the ReturnsDocument field to query operations.
`static CustomerReturnProcessStepField<String>`	`RETURNS_DOCUMENT_APPROVAL_STATUS` Use with available fluent helpers to apply the ReturnsDocumentApprovalStatus field to query operations.
`static CustomerReturnProcessStepField<String>`	`RETURNS_DOCUMENT_ITEM` Use with available fluent helpers to apply the ReturnsDocumentItem field to query operations.
`static CustomerReturnProcessStepField<String>`	`RETURNS_DOCUMENT_STATUS` Use with available fluent helpers to apply the ReturnsDocumentStatus field to query operations.
`static CustomerReturnProcessStepField<String>`	`RETURNS_DOCUMENT_TYPE` Use with available fluent helpers to apply the ReturnsDocumentType field to query operations.
`static CustomerReturnProcessStepField<String>`	`RETURNS_REFERENCE_DOCUMENT` Use with available fluent helpers to apply the ReturnsReferenceDocument field to query operations.
`static CustomerReturnProcessStepField<String>`	`RETURNS_REFERENCE_DOCUMENT_ITEM` Use with available fluent helpers to apply the ReturnsReferenceDocumentItem field to query operations.
`static CustomerReturnProcessStepField<String>`	`RETURNS_REFERENCE_DOCUMENT_TYPE` Use with available fluent helpers to apply the ReturnsReferenceDocumentType field to query operations.
`static CustomerReturnProcessStepOneToOneLink<CustomerReturn>`	`TO_CUSTOMER_RETURN` Use with available fluent helpers to apply the to_CustomerReturn navigation property to query operations.
`static CustomerReturnProcessStepOneToOneLink<CustomerReturnItem>`	`TO_CUSTOMER_RETURN_ITEM` Use with available fluent helpers to apply the to_CustomerReturnItem navigation property to query operations.

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject
changedOriginalFields

Constructor Summary

Constructors
Constructor and Description
`CustomerReturnProcessStep()`
CustomerReturnProcessStep(String retsMgmtProcess, String retsMgmtProcessItem, String retsMgmtProcItmQtySplit, String retsMgmtProcessStep, String returnsDocumentType, String returnsDocument, String returnsDocumentItem, String returnsDocumentStatus, String returnsDocumentApprovalStatus, String returnsReferenceDocumentType, String returnsReferenceDocument, String returnsReferenceDocumentItem, String retsMgmtProcStepExecStatus, CustomerReturn toCustomerReturn, CustomerReturnItem toCustomerReturnItem)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`attachToService(String servicePath, HttpDestinationProperties destination)` Sets the service path and destination for the fetch commands of this entity.
`static CustomerReturnProcessStep.CustomerReturnProcessStepBuilder`	`builder()`
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`CustomerReturn`	`fetchCustomerReturn()` Fetches the CustomerReturn entity (one to one) associated with this entity.
`CustomerReturnItem`	`fetchCustomerReturnItem()` Fetches the CustomerReturnItem entity (one to one) associated with this entity.
`static <T> CustomerReturnProcessStepField<T>`	`field(String fieldName, Class<T> fieldType)` Use with available fluent helpers to apply an extension field to query operations.
`static <T,DomainT> CustomerReturnProcessStepField<T>`	`field(String fieldName, TypeConverter<T,DomainT> typeConverter)` Use with available fluent helpers to apply an extension field to query operations.
`protected void`	`fromMap(Map<String,Object> inputValues)`
`io.vavr.control.Option<CustomerReturn>`	`getCustomerReturnIfPresent()` Retrieval of associated CustomerReturn entity (one to one).
`io.vavr.control.Option<CustomerReturnItem>`	`getCustomerReturnItemIfPresent()` Retrieval of associated CustomerReturnItem entity (one to one).
`CustomerReturnItem`	`getCustomerReturnItemOrFetch()` Retrieval of associated CustomerReturnItem entity (one to one).
`CustomerReturn`	`getCustomerReturnOrFetch()` Retrieval of associated CustomerReturn entity (one to one).
`protected String`	`getDefaultServicePath()`
`HttpDestinationProperties`	`getDestinationForFetch()` Convienence field for reusing the same destination with multiple queries (e.g.
`protected String`	`getEntityCollection()`
`protected Map<String,Object>`	`getKey()`
`String`	`getRetsMgmtProcess()` (Key Field) Constraints: Not nullable, Maximum length: 10
`String`	`getRetsMgmtProcessItem()` (Key Field) Constraints: Not nullable, Maximum length: 6
`String`	`getRetsMgmtProcessStep()` (Key Field) Constraints: Not nullable, Maximum length: 4
`String`	`getRetsMgmtProcItmQtySplit()` (Key Field) Constraints: Not nullable, Maximum length: 3
`String`	`getRetsMgmtProcStepExecStatus()` Constraints: Not nullable, Maximum length: 1
`String`	`getReturnsDocument()` (Key Field) Constraints: Not nullable, Maximum length: 30
`String`	`getReturnsDocumentApprovalStatus()` Constraints: Not nullable, Maximum length: 1
`String`	`getReturnsDocumentItem()` (Key Field) Constraints: Not nullable, Maximum length: 10
`String`	`getReturnsDocumentStatus()` Constraints: Not nullable, Maximum length: 1
`String`	`getReturnsDocumentType()` (Key Field) Constraints: Not nullable, Maximum length: 2
`String`	`getReturnsReferenceDocument()` Constraints: Not nullable, Maximum length: 30
`String`	`getReturnsReferenceDocumentItem()` Constraints: Not nullable, Maximum length: 10
`String`	`getReturnsReferenceDocumentType()` Constraints: Not nullable, Maximum length: 2
`Class<CustomerReturnProcessStep>`	`getType()`
`int`	`hashCode()`
`void`	`setCustomerReturn(CustomerReturn value)` Overwrites the associated CustomerReturn entity for the loaded navigation property to_CustomerReturn.
`void`	`setCustomerReturnItem(CustomerReturnItem value)` Overwrites the associated CustomerReturnItem entity for the loaded navigation property to_CustomerReturnItem.
`void`	`setRetsMgmtProcess(String retsMgmtProcess)` (Key Field) Constraints: Not nullable, Maximum length: 10
`void`	`setRetsMgmtProcessItem(String retsMgmtProcessItem)` (Key Field) Constraints: Not nullable, Maximum length: 6
`void`	`setRetsMgmtProcessStep(String retsMgmtProcessStep)` (Key Field) Constraints: Not nullable, Maximum length: 4
`void`	`setRetsMgmtProcItmQtySplit(String retsMgmtProcItmQtySplit)` (Key Field) Constraints: Not nullable, Maximum length: 3
`void`	`setRetsMgmtProcStepExecStatus(String retsMgmtProcStepExecStatus)` Constraints: Not nullable, Maximum length: 1
`void`	`setReturnsDocument(String returnsDocument)` (Key Field) Constraints: Not nullable, Maximum length: 30
`void`	`setReturnsDocumentApprovalStatus(String returnsDocumentApprovalStatus)` Constraints: Not nullable, Maximum length: 1
`void`	`setReturnsDocumentItem(String returnsDocumentItem)` (Key Field) Constraints: Not nullable, Maximum length: 10
`void`	`setReturnsDocumentStatus(String returnsDocumentStatus)` Constraints: Not nullable, Maximum length: 1
`void`	`setReturnsDocumentType(String returnsDocumentType)` (Key Field) Constraints: Not nullable, Maximum length: 2
`void`	`setReturnsReferenceDocument(String returnsReferenceDocument)` Constraints: Not nullable, Maximum length: 30
`void`	`setReturnsReferenceDocumentItem(String returnsReferenceDocumentItem)` Constraints: Not nullable, Maximum length: 10
`void`	`setReturnsReferenceDocumentType(String returnsReferenceDocumentType)` Constraints: Not nullable, Maximum length: 2
`protected void`	`setServicePathForFetch(String servicePathForFetch)` The service path only used for the fetch commands of this entity.
`protected Map<String,Object>`	`toMapOfFields()`
`protected Map<String,Object>`	`toMapOfNavigationProperties()`
`String`	`toString()`

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity
getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ALL_FIELDS
```
public static final CustomerReturnProcessStepSelectable ALL_FIELDS
```
    Selector for all available fields of CustomerReturnProcessStep.
  - RETS_MGMT_PROCESS
```
public static final CustomerReturnProcessStepField<String> RETS_MGMT_PROCESS
```
    Use with available fluent helpers to apply the RetsMgmtProcess field to query operations.
  - RETS_MGMT_PROCESS_ITEM
```
public static final CustomerReturnProcessStepField<String> RETS_MGMT_PROCESS_ITEM
```
    Use with available fluent helpers to apply the RetsMgmtProcessItem field to query operations.
  - RETS_MGMT_PROC_ITM_QTY_SPLIT
```
public static final CustomerReturnProcessStepField<String> RETS_MGMT_PROC_ITM_QTY_SPLIT
```
    Use with available fluent helpers to apply the RetsMgmtProcItmQtySplit field to query operations.
  - RETS_MGMT_PROCESS_STEP
```
public static final CustomerReturnProcessStepField<String> RETS_MGMT_PROCESS_STEP
```
    Use with available fluent helpers to apply the RetsMgmtProcessStep field to query operations.
  - RETURNS_DOCUMENT_TYPE
```
public static final CustomerReturnProcessStepField<String> RETURNS_DOCUMENT_TYPE
```
    Use with available fluent helpers to apply the ReturnsDocumentType field to query operations.
  - RETURNS_DOCUMENT
```
public static final CustomerReturnProcessStepField<String> RETURNS_DOCUMENT
```
    Use with available fluent helpers to apply the ReturnsDocument field to query operations.
  - RETURNS_DOCUMENT_ITEM
```
public static final CustomerReturnProcessStepField<String> RETURNS_DOCUMENT_ITEM
```
    Use with available fluent helpers to apply the ReturnsDocumentItem field to query operations.
  - RETURNS_DOCUMENT_STATUS
```
public static final CustomerReturnProcessStepField<String> RETURNS_DOCUMENT_STATUS
```
    Use with available fluent helpers to apply the ReturnsDocumentStatus field to query operations.
  - RETURNS_DOCUMENT_APPROVAL_STATUS
```
public static final CustomerReturnProcessStepField<String> RETURNS_DOCUMENT_APPROVAL_STATUS
```
    Use with available fluent helpers to apply the ReturnsDocumentApprovalStatus field to query operations.
  - RETURNS_REFERENCE_DOCUMENT_TYPE
```
public static final CustomerReturnProcessStepField<String> RETURNS_REFERENCE_DOCUMENT_TYPE
```
    Use with available fluent helpers to apply the ReturnsReferenceDocumentType field to query operations.
  - RETURNS_REFERENCE_DOCUMENT
```
public static final CustomerReturnProcessStepField<String> RETURNS_REFERENCE_DOCUMENT
```
    Use with available fluent helpers to apply the ReturnsReferenceDocument field to query operations.
  - RETURNS_REFERENCE_DOCUMENT_ITEM
```
public static final CustomerReturnProcessStepField<String> RETURNS_REFERENCE_DOCUMENT_ITEM
```
    Use with available fluent helpers to apply the ReturnsReferenceDocumentItem field to query operations.
  - RETS_MGMT_PROC_STEP_EXEC_STATUS
```
public static final CustomerReturnProcessStepField<String> RETS_MGMT_PROC_STEP_EXEC_STATUS
```
    Use with available fluent helpers to apply the RetsMgmtProcStepExecStatus field to query operations.
  - TO_CUSTOMER_RETURN
```
public static final CustomerReturnProcessStepOneToOneLink<CustomerReturn> TO_CUSTOMER_RETURN
```
    Use with available fluent helpers to apply the to_CustomerReturn navigation property to query operations.
  - TO_CUSTOMER_RETURN_ITEM
```
public static final CustomerReturnProcessStepOneToOneLink<CustomerReturnItem> TO_CUSTOMER_RETURN_ITEM
```
    Use with available fluent helpers to apply the to_CustomerReturnItem navigation property to query operations.
- Constructor Detail
  - CustomerReturnProcessStep
```
public CustomerReturnProcessStep()
```
  - CustomerReturnProcessStep
```
public CustomerReturnProcessStep(@Nullable
                                 String retsMgmtProcess,
                                 @Nullable
                                 String retsMgmtProcessItem,
                                 @Nullable
                                 String retsMgmtProcItmQtySplit,
                                 @Nullable
                                 String retsMgmtProcessStep,
                                 @Nullable
                                 String returnsDocumentType,
                                 @Nullable
                                 String returnsDocument,
                                 @Nullable
                                 String returnsDocumentItem,
                                 @Nullable
                                 String returnsDocumentStatus,
                                 @Nullable
                                 String returnsDocumentApprovalStatus,
                                 @Nullable
                                 String returnsReferenceDocumentType,
                                 @Nullable
                                 String returnsReferenceDocument,
                                 @Nullable
                                 String returnsReferenceDocumentItem,
                                 @Nullable
                                 String retsMgmtProcStepExecStatus,
                                 @Nullable
                                 CustomerReturn toCustomerReturn,
                                 @Nullable
                                 CustomerReturnItem toCustomerReturnItem)
```
- Method Detail
  - getType
```
@Nonnull
public Class<CustomerReturnProcessStep> getType()
```
    Specified by:
    
    getType in class VdmObject<CustomerReturnProcessStep>
    
    Returns:
    
    The class of this object.
  - setRetsMgmtProcess
```
public void setRetsMgmtProcess(@Nullable
                               String retsMgmtProcess)
```
    (Key Field) Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: RetsMgmtProcess
    
    Parameters:
    
    retsMgmtProcess - Specifies the unique identifier of the advanced returns process.
  - setRetsMgmtProcessItem
```
public void setRetsMgmtProcessItem(@Nullable
                                   String retsMgmtProcessItem)
```
    (Key Field) Constraints: Not nullable, Maximum length: 6
    Original property name from the Odata EDM: RetsMgmtProcessItem
    
    Parameters:
    
    retsMgmtProcessItem - 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.
  - setRetsMgmtProcItmQtySplit
```
public void setRetsMgmtProcItmQtySplit(@Nullable
                                       String retsMgmtProcItmQtySplit)
```
    (Key Field) Constraints: Not nullable, Maximum length: 3
    Original property name from the Odata EDM: RetsMgmtProcItmQtySplit
    
    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.
    
    Parameters:
    
    retsMgmtProcItmQtySplit - Identifies partial qantities of a specific returns item.
  - setRetsMgmtProcessStep
```
public void setRetsMgmtProcessStep(@Nullable
                                   String retsMgmtProcessStep)
```
    (Key Field) Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: RetsMgmtProcessStep
    
    The advanced returns sequence Customer return received directly comprises the following steps:0001 Create Returns Order0021 Inbound Delivery0031 Goods Receipt0041 Inspection
    
    Parameters:
    
    retsMgmtProcessStep - 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.
  - setReturnsDocumentType
```
public void setReturnsDocumentType(@Nullable
                                   String returnsDocumentType)
```
    (Key Field) Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: ReturnsDocumentType
    
    Parameters:
    
    returnsDocumentType - Specifies the returns document type, such as a returns order, goods movement, or credit memo.
  - setReturnsDocument
```
public void setReturnsDocument(@Nullable
                               String returnsDocument)
```
    (Key Field) Constraints: Not nullable, Maximum length: 30
    Original property name from the Odata EDM: ReturnsDocument
    
    Parameters:
    
    returnsDocument - Specifies the document number of a returns document.
  - setReturnsDocumentItem
```
public void setReturnsDocumentItem(@Nullable
                                   String returnsDocumentItem)
```
    (Key Field) Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: ReturnsDocumentItem
    
    Parameters:
    
    returnsDocumentItem - Specifies an item of the displayed document.
  - setReturnsDocumentStatus
```
public void setReturnsDocumentStatus(@Nullable
                                     String returnsDocumentStatus)
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: ReturnsDocumentStatus
    
    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.
    
    Parameters:
    
    returnsDocumentStatus - Specifies the status of the document item.
  - setReturnsDocumentApprovalStatus
```
public void setReturnsDocumentApprovalStatus(@Nullable
                                             String returnsDocumentApprovalStatus)
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: ReturnsDocumentApprovalStatus
    
    Parameters:
    
    returnsDocumentApprovalStatus - Approval Status of Returns Process
  - setReturnsReferenceDocumentType
```
public void setReturnsReferenceDocumentType(@Nullable
                                            String returnsReferenceDocumentType)
```
    Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: ReturnsReferenceDocumentType
    
    Parameters:
    
    returnsReferenceDocumentType - Specifies the returns document type, such as a returns order, goods movement, or credit memo.
  - setReturnsReferenceDocument
```
public void setReturnsReferenceDocument(@Nullable
                                        String returnsReferenceDocument)
```
    Constraints: Not nullable, Maximum length: 30
    Original property name from the Odata EDM: ReturnsReferenceDocument
    
    Parameters:
    
    returnsReferenceDocument - Specifies the document number of a returns document.
  - setReturnsReferenceDocumentItem
```
public void setReturnsReferenceDocumentItem(@Nullable
                                            String returnsReferenceDocumentItem)
```
    Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: ReturnsReferenceDocumentItem
    
    Parameters:
    
    returnsReferenceDocumentItem - Specifies an item of the displayed document.
  - setRetsMgmtProcStepExecStatus
```
public void setRetsMgmtProcStepExecStatus(@Nullable
                                          String retsMgmtProcStepExecStatus)
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: RetsMgmtProcStepExecStatus
    
    Parameters:
    
    retsMgmtProcStepExecStatus - Execution Step Status
  - getEntityCollection
```
protected String getEntityCollection()
```
    Specified by:
    
    getEntityCollection in class VdmEntity<CustomerReturnProcessStep>
  - getKey
```
@Nonnull
protected Map<String,Object> getKey()
```
    Overrides:
    
    getKey in class VdmObject<CustomerReturnProcessStep>
    
    Returns:
    
    The compound key of this object.
  - toMapOfFields
```
@Nonnull
protected Map<String,Object> toMapOfFields()
```
    Overrides:
    
    toMapOfFields in class VdmObject<CustomerReturnProcessStep>
  - fromMap
```
protected void fromMap(Map<String,Object> inputValues)
```
    Overrides:
    
    fromMap in class VdmObject<CustomerReturnProcessStep>
  - field
```
@Nonnull
public static <T> CustomerReturnProcessStepField<T> field(@Nonnull
                                                                   String fieldName,
                                                                   @Nonnull
                                                                   Class<T> fieldType)
```
    Use with available fluent helpers to apply an extension field to query operations.
    
    Type Parameters:
    
    T - The type of the extension field when performing value comparisons.
    
    Parameters:
    
    fieldName - The name of the extension field as returned by the OData service.
    
    fieldType - The Java type to use for the extension field when performing value comparisons.
    
    Returns:
    
    A representation of an extension field from this entity.
  - field
```
@Nonnull
public static <T,DomainT> CustomerReturnProcessStepField<T> field(@Nonnull
                                                                           String fieldName,
                                                                           @Nonnull
                                                                           TypeConverter<T,DomainT> typeConverter)
```
    Use with available fluent helpers to apply an extension field to query operations.
    
    Type Parameters:
    
    T - The type of the extension field when performing value comparisons.
    
    DomainT - The type of the extension field as returned by the OData service.
    
    Parameters:
    
    typeConverter - A TypeConverter instance whose first generic type matches the Java type of the field
    
    fieldName - The name of the extension field as returned by the OData service.
    
    Returns:
    
    A representation of an extension field from this entity, holding a reference to the given TypeConverter.
  - getDestinationForFetch
```
@Nullable
public HttpDestinationProperties getDestinationForFetch()
```
    Description copied from class: VdmEntity
    
    Convienence field for reusing the same destination with multiple queries (e.g. fetching associated entities). New destination to apply to this entity
    
    Overrides:
    
    getDestinationForFetch in class VdmEntity<CustomerReturnProcessStep>
    
    Returns:
    
    The stored destination for executing queries, or null if no such context has been set.
  - setServicePathForFetch
```
protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)
```
    Description copied from class: VdmEntity
    
    The service path only used for the fetch commands of this entity.
    Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.
    
    Overrides:
    
    setServicePathForFetch in class VdmEntity<CustomerReturnProcessStep>
  - attachToService
```
public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)
```
    Description copied from class: VdmEntity
    
    Sets the service path and destination for the fetch commands of this entity. Also applies to any associated entities (navigation properties) that were previously fetched.
    Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.
    
    Overrides:
    
    attachToService in class VdmEntity<CustomerReturnProcessStep>
    
    Parameters:
    
    servicePath - Optional parameter. New service path to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the service path has never been set, then the service path will be set to the default defined in the corresponding service interface.
    
    destination - New destination to apply to this entity and any associated entities that were previously fetched.
  - getDefaultServicePath
```
protected String getDefaultServicePath()
```
    Overrides:
    
    getDefaultServicePath in class VdmEntity<CustomerReturnProcessStep>
  - toMapOfNavigationProperties
```
@Nonnull
protected Map<String,Object> toMapOfNavigationProperties()
```
    Overrides:
    
    toMapOfNavigationProperties in class VdmObject<CustomerReturnProcessStep>
  - fetchCustomerReturn
```
@Nullable
public CustomerReturn fetchCustomerReturn()
                                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Fetches the CustomerReturn entity (one to one) associated with this entity. This corresponds to the OData navigation property to_CustomerReturn.
    Please note: This method will not cache or persist the query results.
    
    Returns:
    
    The single associated CustomerReturn entity, or null if an entity is not associated.
    
    Throws:
    
    com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.
  - getCustomerReturnOrFetch
```
@Nullable
public CustomerReturn getCustomerReturnOrFetch()
                                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Retrieval of associated CustomerReturn entity (one to one). This corresponds to the OData navigation property to_CustomerReturn.
    If the navigation property to_CustomerReturn of a queried CustomerReturnProcessStep is operated lazily, an ODataException can be thrown in case of an OData query error.
    Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
    
    Returns:
    
    List of associated CustomerReturn entity.
    
    Throws:
    
    com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.
  - getCustomerReturnIfPresent
```
@Nonnull
public io.vavr.control.Option<CustomerReturn> getCustomerReturnIfPresent()
```
    Retrieval of associated CustomerReturn entity (one to one). This corresponds to the OData navigation property to_CustomerReturn.
    If the navigation property for an entity CustomerReturnProcessStep has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.
    
    Returns:
    
    If the information for navigation property to_CustomerReturn is already loaded, the result will contain the CustomerReturn entity. If not, an Option with result state empty is returned.
  - setCustomerReturn
```
public void setCustomerReturn(CustomerReturn value)
```
    Overwrites the associated CustomerReturn entity for the loaded navigation property to_CustomerReturn.
    
    Parameters:
    
    value - New CustomerReturn entity.
  - fetchCustomerReturnItem
```
@Nullable
public CustomerReturnItem fetchCustomerReturnItem()
                                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Fetches the CustomerReturnItem entity (one to one) associated with this entity. This corresponds to the OData navigation property to_CustomerReturnItem.
    Please note: This method will not cache or persist the query results.
    
    Returns:
    
    The single associated CustomerReturnItem entity, or null if an entity is not associated.
    
    Throws:
    
    com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.
  - getCustomerReturnItemOrFetch
```
@Nullable
public CustomerReturnItem getCustomerReturnItemOrFetch()
                                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Retrieval of associated CustomerReturnItem entity (one to one). This corresponds to the OData navigation property to_CustomerReturnItem.
    If the navigation property to_CustomerReturnItem of a queried CustomerReturnProcessStep is operated lazily, an ODataException can be thrown in case of an OData query error.
    Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
    
    Returns:
    
    List of associated CustomerReturnItem entity.
    
    Throws:
    
    com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.
  - getCustomerReturnItemIfPresent
```
@Nonnull
public io.vavr.control.Option<CustomerReturnItem> getCustomerReturnItemIfPresent()
```
    Retrieval of associated CustomerReturnItem entity (one to one). This corresponds to the OData navigation property to_CustomerReturnItem.
    If the navigation property for an entity CustomerReturnProcessStep has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.
    
    Returns:
    
    If the information for navigation property to_CustomerReturnItem is already loaded, the result will contain the CustomerReturnItem entity. If not, an Option with result state empty is returned.
  - setCustomerReturnItem
```
public void setCustomerReturnItem(CustomerReturnItem value)
```
    Overwrites the associated CustomerReturnItem entity for the loaded navigation property to_CustomerReturnItem.
    
    Parameters:
    
    value - New CustomerReturnItem entity.
  - builder
```
public static CustomerReturnProcessStep.CustomerReturnProcessStepBuilder builder()
```
  - getRetsMgmtProcess
```
@Nullable
public String getRetsMgmtProcess()
```
    (Key Field) Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: RetsMgmtProcess
    
    Returns:
    
    Specifies the unique identifier of the advanced returns process.
  - getRetsMgmtProcessItem
```
@Nullable
public String getRetsMgmtProcessItem()
```
    (Key Field) Constraints: Not nullable, Maximum length: 6
    Original property name from the Odata EDM: RetsMgmtProcessItem
    
    Returns:
    
    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.
  - getRetsMgmtProcItmQtySplit
```
@Nullable
public String getRetsMgmtProcItmQtySplit()
```
    (Key Field) Constraints: Not nullable, Maximum length: 3
    Original property name from the Odata EDM: RetsMgmtProcItmQtySplit
    
    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.
    
    Returns:
    
    Identifies partial qantities of a specific returns item.
  - getRetsMgmtProcessStep
```
@Nullable
public String getRetsMgmtProcessStep()
```
    (Key Field) Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: RetsMgmtProcessStep
    
    The advanced returns sequence Customer return received directly comprises the following steps:0001 Create Returns Order0021 Inbound Delivery0031 Goods Receipt0041 Inspection
    
    Returns:
    
    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.
  - getReturnsDocumentType
```
@Nullable
public String getReturnsDocumentType()
```
    (Key Field) Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: ReturnsDocumentType
    
    Returns:
    
    Specifies the returns document type, such as a returns order, goods movement, or credit memo.
  - getReturnsDocument
```
@Nullable
public String getReturnsDocument()
```
    (Key Field) Constraints: Not nullable, Maximum length: 30
    Original property name from the Odata EDM: ReturnsDocument
    
    Returns:
    
    Specifies the document number of a returns document.
  - getReturnsDocumentItem
```
@Nullable
public String getReturnsDocumentItem()
```
    (Key Field) Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: ReturnsDocumentItem
    
    Returns:
    
    Specifies an item of the displayed document.
  - getReturnsDocumentStatus
```
@Nullable
public String getReturnsDocumentStatus()
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: ReturnsDocumentStatus
    
    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.
    
    Returns:
    
    Specifies the status of the document item.
  - getReturnsDocumentApprovalStatus
```
@Nullable
public String getReturnsDocumentApprovalStatus()
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: ReturnsDocumentApprovalStatus
    
    Returns:
    
    Approval Status of Returns Process
  - getReturnsReferenceDocumentType
```
@Nullable
public String getReturnsReferenceDocumentType()
```
    Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: ReturnsReferenceDocumentType
    
    Returns:
    
    Specifies the returns document type, such as a returns order, goods movement, or credit memo.
  - getReturnsReferenceDocument
```
@Nullable
public String getReturnsReferenceDocument()
```
    Constraints: Not nullable, Maximum length: 30
    Original property name from the Odata EDM: ReturnsReferenceDocument
    
    Returns:
    
    Specifies the document number of a returns document.
  - getReturnsReferenceDocumentItem
```
@Nullable
public String getReturnsReferenceDocumentItem()
```
    Constraints: Not nullable, Maximum length: 10
    Original property name from the Odata EDM: ReturnsReferenceDocumentItem
    
    Returns:
    
    Specifies an item of the displayed document.
  - getRetsMgmtProcStepExecStatus
```
@Nullable
public String getRetsMgmtProcStepExecStatus()
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: RetsMgmtProcStepExecStatus
    
    Returns:
    
    Execution Step Status
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class VdmObject<CustomerReturnProcessStep>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class VdmObject<CustomerReturnProcessStep>
  - canEqual
```
protected boolean canEqual(Object other)
```
    Overrides:
    
    canEqual in class VdmObject<CustomerReturnProcessStep>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class VdmObject<CustomerReturnProcessStep>

Class CustomerReturnProcessStep

Nested Class Summary

Field Summary

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

Constructor Summary

Method Summary

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

Methods inherited from class java.lang.Object

Field Detail

ALL_FIELDS

RETS_MGMT_PROCESS

RETS_MGMT_PROCESS_ITEM

RETS_MGMT_PROC_ITM_QTY_SPLIT

RETS_MGMT_PROCESS_STEP

RETURNS_DOCUMENT_TYPE

RETURNS_DOCUMENT

RETURNS_DOCUMENT_ITEM

RETURNS_DOCUMENT_STATUS

RETURNS_DOCUMENT_APPROVAL_STATUS

RETURNS_REFERENCE_DOCUMENT_TYPE

RETURNS_REFERENCE_DOCUMENT

RETURNS_REFERENCE_DOCUMENT_ITEM

RETS_MGMT_PROC_STEP_EXEC_STATUS

TO_CUSTOMER_RETURN

TO_CUSTOMER_RETURN_ITEM

Constructor Detail

CustomerReturnProcessStep

CustomerReturnProcessStep

Method Detail

getType

setRetsMgmtProcess

setRetsMgmtProcessItem

setRetsMgmtProcItmQtySplit

setRetsMgmtProcessStep

setReturnsDocumentType

setReturnsDocument

setReturnsDocumentItem

setReturnsDocumentStatus

setReturnsDocumentApprovalStatus

setReturnsReferenceDocumentType

setReturnsReferenceDocument

setReturnsReferenceDocumentItem

setRetsMgmtProcStepExecStatus

getEntityCollection

getKey

toMapOfFields

fromMap

field

field

getDestinationForFetch

setServicePathForFetch

attachToService

getDefaultServicePath

toMapOfNavigationProperties

fetchCustomerReturn

getCustomerReturnOrFetch

getCustomerReturnIfPresent

setCustomerReturn

fetchCustomerReturnItem

getCustomerReturnItemOrFetch

getCustomerReturnItemIfPresent

setCustomerReturnItem

builder

getRetsMgmtProcess

getRetsMgmtProcessItem

getRetsMgmtProcItmQtySplit

getRetsMgmtProcessStep

getReturnsDocumentType

getReturnsDocument

getReturnsDocumentItem

getReturnsDocumentStatus

getReturnsDocumentApprovalStatus

getReturnsReferenceDocumentType

getReturnsReferenceDocument

getReturnsReferenceDocumentItem

getRetsMgmtProcStepExecStatus

toString

equals

canEqual