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

Class CustomerReturnItemRelatedObj

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<CustomerReturnItemRelatedObj>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customerreturn.CustomerReturnItemRelatedObj
public class CustomerReturnItemRelatedObj extends VdmEntity<CustomerReturnItemRelatedObj>
Item Related Object

Original entity name from the Odata EDM: A_CustomerReturnItemRelatedObjType

  • Field Details

    • ALL_FIELDS

      public static final CustomerReturnItemRelatedObjSelectable ALL_FIELDS
      Selector for all available fields of CustomerReturnItemRelatedObj.

    • CUSTOMER_RETURN

      public static final CustomerReturnItemRelatedObjField<String> CUSTOMER_RETURN
      Use with available fluent helpers to apply the CustomerReturn field to query operations.

    • CUSTOMER_RETURN_ITEM

      public static final CustomerReturnItemRelatedObjField<String> CUSTOMER_RETURN_ITEM
      Use with available fluent helpers to apply the CustomerReturnItem field to query operations.

    • TO_CUSTOMER_RETURN

      public static final CustomerReturnItemRelatedObjOneToOneLink<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 CustomerReturnItemRelatedObjOneToOneLink<CustomerReturnItem> TO_CUSTOMER_RETURN_ITEM
      Use with available fluent helpers to apply the to_CustomerReturnItem navigation property to query operations.

  • Constructor Details

    • CustomerReturnItemRelatedObj

      public CustomerReturnItemRelatedObj()

    • CustomerReturnItemRelatedObj

      public CustomerReturnItemRelatedObj(@Nullable String customerReturn, @Nullable String customerReturnItem, @Nullable String sDDocRelatedObjectSequenceNmbr, @Nullable String sDDocumentRelatedObjectType, @Nullable String sDDocRelatedObjectSystem, @Nullable String sDDocRelatedObjectReference1, @Nullable String sDDocRelatedObjectReference2, @Nullable CustomerReturn toCustomerReturn, @Nullable CustomerReturnItem toCustomerReturnItem)

  • Method Details

    • getType

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

    • setCustomerReturn

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

      Original property name from the Odata EDM: CustomerReturn

      Parameters:
      customerReturn - Sales Order

    • setCustomerReturnItem

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

      Original property name from the Odata EDM: CustomerReturnItem

      Parameters:
      customerReturnItem - Sales Order Item

    • setSDDocRelatedObjectSequenceNmbr

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

      Original property name from the Odata EDM: SDDocRelatedObjectSequenceNmbr

      Parameters:
      sDDocRelatedObjectSequenceNmbr - Sequence Number of the Related Object of an SD Document

    • setSDDocumentRelatedObjectType

      public void setSDDocumentRelatedObjectType(@Nullable String sDDocumentRelatedObjectType)
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: SDDocumentRelatedObjectType

      Parameters:
      sDDocumentRelatedObjectType - Type of the Related Object of an SD Document

    • setSDDocRelatedObjectSystem

      public void setSDDocRelatedObjectSystem(@Nullable String sDDocRelatedObjectSystem)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: SDDocRelatedObjectSystem

      Parameters:
      sDDocRelatedObjectSystem - System of the Related Object of an SD Document

    • setSDDocRelatedObjectReference1

      public void setSDDocRelatedObjectReference1(@Nullable String sDDocRelatedObjectReference1)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: SDDocRelatedObjectReference1

      Parameters:
      sDDocRelatedObjectReference1 - Reference of the Related Object of an SD Document

    • setSDDocRelatedObjectReference2

      public void setSDDocRelatedObjectReference2(@Nullable String sDDocRelatedObjectReference2)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: SDDocRelatedObjectReference2

      Parameters:
      sDDocRelatedObjectReference2 - Reference of the Related Object of an SD Document

    • getEntityCollection

      protected String getEntityCollection()
      Specified by:
      getEntityCollection in class VdmEntity<CustomerReturnItemRelatedObj>

    • getKey

      @Nonnull protected Map<String,Object> getKey()
      Overrides:
      getKey in class VdmObject<CustomerReturnItemRelatedObj>

    • toMapOfFields

      @Nonnull protected Map<String,Object> toMapOfFields()
      Overrides:
      toMapOfFields in class VdmObject<CustomerReturnItemRelatedObj>

    • fromMap

      protected void fromMap(Map<String,Object> inputValues)
      Overrides:
      fromMap in class VdmObject<CustomerReturnItemRelatedObj>

    • field

      @Nonnull public static <T> CustomerReturnItemRelatedObjField<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> CustomerReturnItemRelatedObjField<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<CustomerReturnItemRelatedObj>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

      protected String getDefaultServicePath()
      Overrides:
      getDefaultServicePath in class VdmEntity<CustomerReturnItemRelatedObj>

    • toMapOfNavigationProperties

      @Nonnull protected Map<String,Object> toMapOfNavigationProperties()
      Overrides:
      toMapOfNavigationProperties in class VdmObject<CustomerReturnItemRelatedObj>

    • 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 CustomerReturnItemRelatedObj 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 CustomerReturnItemRelatedObj 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 CustomerReturnItemRelatedObj 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 CustomerReturnItemRelatedObj 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 CustomerReturnItemRelatedObj.CustomerReturnItemRelatedObjBuilder builder()

    • getCustomerReturn

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

      Original property name from the Odata EDM: CustomerReturn

      Returns:
      Sales Order

    • getCustomerReturnItem

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

      Original property name from the Odata EDM: CustomerReturnItem

      Returns:
      Sales Order Item

    • getSDDocRelatedObjectSequenceNmbr

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

      Original property name from the Odata EDM: SDDocRelatedObjectSequenceNmbr

      Returns:
      Sequence Number of the Related Object of an SD Document

    • getSDDocumentRelatedObjectType

      @Nullable public String getSDDocumentRelatedObjectType()
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: SDDocumentRelatedObjectType

      Returns:
      Type of the Related Object of an SD Document

    • getSDDocRelatedObjectSystem

      @Nullable public String getSDDocRelatedObjectSystem()
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: SDDocRelatedObjectSystem

      Returns:
      System of the Related Object of an SD Document

    • getSDDocRelatedObjectReference1

      @Nullable public String getSDDocRelatedObjectReference1()
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: SDDocRelatedObjectReference1

      Returns:
      Reference of the Related Object of an SD Document

    • getSDDocRelatedObjectReference2

      @Nullable public String getSDDocRelatedObjectReference2()
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: SDDocRelatedObjectReference2

      Returns:
      Reference of the Related Object of an SD Document

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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