Package com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customerreturn

Class CustomerReturnProcessStep

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>
Return Process Step

Original entity name from the Odata EDM: A_CustomerReturnProcessStepType

  • Field Details

    • 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 Details

    • 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 Details

    • getType

      @Nonnull public Class<CustomerReturnProcessStep> getType()
      Specified by:
      getType in class VdmObject<CustomerReturnProcessStep>

    • 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 - Process Identification Number

    • 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 - Item Number

    • setRetsMgmtProcItmQtySplit

      public void setRetsMgmtProcItmQtySplit(@Nullable String retsMgmtProcItmQtySplit)
      (Key Field) Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: RetsMgmtProcItmQtySplit

      Parameters:
      retsMgmtProcItmQtySplit - Split Identification Number

    • setRetsMgmtProcessStep

      public void setRetsMgmtProcessStep(@Nullable String retsMgmtProcessStep)
      (Key Field) Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: RetsMgmtProcessStep

      Parameters:
      retsMgmtProcessStep - Step ID

    • 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 - Document Type

    • 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 - Document Number

    • 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 - Document Item

    • setReturnsDocumentStatus

      public void setReturnsDocumentStatus(@Nullable String returnsDocumentStatus)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: ReturnsDocumentStatus

      Parameters:
      returnsDocumentStatus - Status of 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 - Document Type

    • setReturnsReferenceDocument

      public void setReturnsReferenceDocument(@Nullable String returnsReferenceDocument)
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: ReturnsReferenceDocument

      Parameters:
      returnsReferenceDocument - Document Number

    • setReturnsReferenceDocumentItem

      public void setReturnsReferenceDocumentItem(@Nullable String returnsReferenceDocumentItem)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: ReturnsReferenceDocumentItem

      Parameters:
      returnsReferenceDocumentItem - Document Item

    • 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>

    • 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<T, DomainT> 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()
      Overrides:
      getDestinationForFetch in class VdmEntity<CustomerReturnProcessStep>

    • setServicePathForFetch

      protected void setServicePathForFetch(@Nullable String servicePathForFetch)
      Overrides:
      setServicePathForFetch in class VdmEntity<CustomerReturnProcessStep>

    • attachToService

      public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
      Overrides:
      attachToService in class VdmEntity<CustomerReturnProcessStep>

    • 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()
      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.datamodel.odata.client.exception.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()
      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.datamodel.odata.client.exception.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()
      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.datamodel.odata.client.exception.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()
      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.datamodel.odata.client.exception.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

      @Nonnull 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:
      Process Identification Number

    • getRetsMgmtProcessItem

      @Nullable public String getRetsMgmtProcessItem()
      (Key Field) Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: RetsMgmtProcessItem

      Returns:
      Item Number

    • getRetsMgmtProcItmQtySplit

      @Nullable public String getRetsMgmtProcItmQtySplit()
      (Key Field) Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: RetsMgmtProcItmQtySplit

      Returns:
      Split Identification Number

    • getRetsMgmtProcessStep

      @Nullable public String getRetsMgmtProcessStep()
      (Key Field) Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: RetsMgmtProcessStep

      Returns:
      Step ID

    • getReturnsDocumentType

      @Nullable public String getReturnsDocumentType()
      (Key Field) Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: ReturnsDocumentType

      Returns:
      Document Type

    • getReturnsDocument

      @Nullable public String getReturnsDocument()
      (Key Field) Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: ReturnsDocument

      Returns:
      Document Number

    • getReturnsDocumentItem

      @Nullable public String getReturnsDocumentItem()
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: ReturnsDocumentItem

      Returns:
      Document Item

    • getReturnsDocumentStatus

      @Nullable public String getReturnsDocumentStatus()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: ReturnsDocumentStatus

      Returns:
      Status of 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:
      Document Type

    • getReturnsReferenceDocument

      @Nullable public String getReturnsReferenceDocument()
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: ReturnsReferenceDocument

      Returns:
      Document Number

    • getReturnsReferenceDocumentItem

      @Nullable public String getReturnsReferenceDocumentItem()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: ReturnsReferenceDocumentItem

      Returns:
      Document Item

    • getRetsMgmtProcStepExecStatus

      @Nullable public String getRetsMgmtProcStepExecStatus()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: RetsMgmtProcStepExecStatus

      Returns:
      Execution Step Status

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class VdmObject<CustomerReturnProcessStep>

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class VdmEntity<CustomerReturnProcessStep>

    • canEqual

      protected boolean canEqual(@Nullable Object other)
      Overrides:
      canEqual in class VdmEntity<CustomerReturnProcessStep>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class VdmEntity<CustomerReturnProcessStep>