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

Class SDDocumentReason

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<SDDocumentReason>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesanddistributiondocumentorderreason.SDDocumentReason
public class SDDocumentReason extends VdmEntity<SDDocumentReason>
Order Reason ID and Self-Billing Processing Indicators

Original entity name from the Odata EDM: A_SDDocumentReasonType

  • Field Details

    • ALL_FIELDS

      public static final SDDocumentReasonSelectable ALL_FIELDS
      Selector for all available fields of SDDocumentReason.

    • SD_DOCUMENT_REASON

      public static final SDDocumentReasonField<String> SD_DOCUMENT_REASON
      Use with available fluent helpers to apply the SDDocumentReason field to query operations.

    • RETRO_BILLING_USAGE

      public static final SDDocumentReasonField<String> RETRO_BILLING_USAGE
      Use with available fluent helpers to apply the RetroBillingUsage field to query operations.

    • SELF_BILLING_VALUE_ITEM

      public static final SDDocumentReasonField<String> SELF_BILLING_VALUE_ITEM
      Use with available fluent helpers to apply the SelfBillingValueItem field to query operations.

    • TO_RETRO_BILLING_USAGE_TEXT

      public static final SDDocumentReasonLink<RetroBillingUsageText> TO_RETRO_BILLING_USAGE_TEXT
      Use with available fluent helpers to apply the to_RetroBillingUsageText navigation property to query operations.

    • TO_SD_DOCUMENT_REASON_TEXT

      public static final SDDocumentReasonLink<SDDocumentReasonText> TO_SD_DOCUMENT_REASON_TEXT
      Use with available fluent helpers to apply the to_SDDocumentReasonText navigation property to query operations.

    • TO_SELF_BILLING_VALUE_ITEM_TEXT

      public static final SDDocumentReasonLink<SelfBillingValueItemText> TO_SELF_BILLING_VALUE_ITEM_TEXT
      Use with available fluent helpers to apply the to_SelfBillingValueItemText navigation property to query operations.

  • Constructor Details

  • Method Details

    • getType

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

    • setSDDocumentReason

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

      Original property name from the Odata EDM: SDDocumentReason

      Parameters:
      sDDocumentReason - Order Reason (Reason for the Business Transaction)

    • setRetroBillingUsage

      public void setRetroBillingUsage(@Nullable String retroBillingUsage)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: RetroBillingUsage

      Parameters:
      retroBillingUsage - Use of Order Reason for Retroactive Billing

    • setSelfBillingValueItem

      public void setSelfBillingValueItem(@Nullable String selfBillingValueItem)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: SelfBillingValueItem

      Parameters:
      selfBillingValueItem - Value Item for Self-Billing

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> SDDocumentReasonField<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> SDDocumentReasonField<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<SDDocumentReason>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchRetroBillingUsageText

      @Nonnull public List<RetroBillingUsageText> fetchRetroBillingUsageText()
      Fetches the RetroBillingUsageText entities (one to many) associated with this entity. This corresponds to the OData navigation property to_RetroBillingUsageText.

      Please note: This method will not cache or persist the query results.

      Returns:
      List containing one or more associated RetroBillingUsageText entities. If no entities are associated then an empty list is returned.
      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.

    • getRetroBillingUsageTextOrFetch

      @Nonnull public List<RetroBillingUsageText> getRetroBillingUsageTextOrFetch()
      Retrieval of associated RetroBillingUsageText entities (one to many). This corresponds to the OData navigation property to_RetroBillingUsageText.

      If the navigation property to_RetroBillingUsageText of a queried SDDocumentReason 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 RetroBillingUsageText entities.
      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.

    • getRetroBillingUsageTextIfPresent

      @Nonnull public io.vavr.control.Option<List<RetroBillingUsageText>> getRetroBillingUsageTextIfPresent()
      Retrieval of associated RetroBillingUsageText entities (one to many). This corresponds to the OData navigation property to_RetroBillingUsageText.

      If the navigation property for an entity SDDocumentReason 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_RetroBillingUsageText is already loaded, the result will contain the RetroBillingUsageText entities. If not, an Option with result state empty is returned.

    • setRetroBillingUsageText

      public void setRetroBillingUsageText(@Nonnull List<RetroBillingUsageText> value)
      Overwrites the list of associated RetroBillingUsageText entities for the loaded navigation property to_RetroBillingUsageText.

      If the navigation property to_RetroBillingUsageText of a queried SDDocumentReason 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.

      Parameters:
      value - List of RetroBillingUsageText entities.

    • addRetroBillingUsageText

      public void addRetroBillingUsageText(RetroBillingUsageText... entity)
      Adds elements to the list of associated RetroBillingUsageText entities. This corresponds to the OData navigation property to_RetroBillingUsageText.

      If the navigation property to_RetroBillingUsageText of a queried SDDocumentReason 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.

      Parameters:
      entity - Array of RetroBillingUsageText entities.

    • fetchSDDocumentReasonText

      @Nonnull public List<SDDocumentReasonText> fetchSDDocumentReasonText()
      Fetches the SDDocumentReasonText entities (one to many) associated with this entity. This corresponds to the OData navigation property to_SDDocumentReasonText.

      Please note: This method will not cache or persist the query results.

      Returns:
      List containing one or more associated SDDocumentReasonText entities. If no entities are associated then an empty list is returned.
      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.

    • getSDDocumentReasonTextOrFetch

      @Nonnull public List<SDDocumentReasonText> getSDDocumentReasonTextOrFetch()
      Retrieval of associated SDDocumentReasonText entities (one to many). This corresponds to the OData navigation property to_SDDocumentReasonText.

      If the navigation property to_SDDocumentReasonText of a queried SDDocumentReason 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 SDDocumentReasonText entities.
      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.

    • getSDDocumentReasonTextIfPresent

      @Nonnull public io.vavr.control.Option<List<SDDocumentReasonText>> getSDDocumentReasonTextIfPresent()
      Retrieval of associated SDDocumentReasonText entities (one to many). This corresponds to the OData navigation property to_SDDocumentReasonText.

      If the navigation property for an entity SDDocumentReason 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_SDDocumentReasonText is already loaded, the result will contain the SDDocumentReasonText entities. If not, an Option with result state empty is returned.

    • setSDDocumentReasonText

      public void setSDDocumentReasonText(@Nonnull List<SDDocumentReasonText> value)
      Overwrites the list of associated SDDocumentReasonText entities for the loaded navigation property to_SDDocumentReasonText.

      If the navigation property to_SDDocumentReasonText of a queried SDDocumentReason 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.

      Parameters:
      value - List of SDDocumentReasonText entities.

    • addSDDocumentReasonText

      public void addSDDocumentReasonText(SDDocumentReasonText... entity)
      Adds elements to the list of associated SDDocumentReasonText entities. This corresponds to the OData navigation property to_SDDocumentReasonText.

      If the navigation property to_SDDocumentReasonText of a queried SDDocumentReason 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.

      Parameters:
      entity - Array of SDDocumentReasonText entities.

    • fetchSelfBillingValueItemText

      @Nonnull public List<SelfBillingValueItemText> fetchSelfBillingValueItemText()
      Fetches the SelfBillingValueItemText entities (one to many) associated with this entity. This corresponds to the OData navigation property to_SelfBillingValueItemText.

      Please note: This method will not cache or persist the query results.

      Returns:
      List containing one or more associated SelfBillingValueItemText entities. If no entities are associated then an empty list is returned.
      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.

    • getSelfBillingValueItemTextOrFetch

      @Nonnull public List<SelfBillingValueItemText> getSelfBillingValueItemTextOrFetch()
      Retrieval of associated SelfBillingValueItemText entities (one to many). This corresponds to the OData navigation property to_SelfBillingValueItemText.

      If the navigation property to_SelfBillingValueItemText of a queried SDDocumentReason 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 SelfBillingValueItemText entities.
      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.

    • getSelfBillingValueItemTextIfPresent

      @Nonnull public io.vavr.control.Option<List<SelfBillingValueItemText>> getSelfBillingValueItemTextIfPresent()
      Retrieval of associated SelfBillingValueItemText entities (one to many). This corresponds to the OData navigation property to_SelfBillingValueItemText.

      If the navigation property for an entity SDDocumentReason 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_SelfBillingValueItemText is already loaded, the result will contain the SelfBillingValueItemText entities. If not, an Option with result state empty is returned.

    • setSelfBillingValueItemText

      public void setSelfBillingValueItemText(@Nonnull List<SelfBillingValueItemText> value)
      Overwrites the list of associated SelfBillingValueItemText entities for the loaded navigation property to_SelfBillingValueItemText.

      If the navigation property to_SelfBillingValueItemText of a queried SDDocumentReason 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.

      Parameters:
      value - List of SelfBillingValueItemText entities.

    • addSelfBillingValueItemText

      public void addSelfBillingValueItemText(SelfBillingValueItemText... entity)
      Adds elements to the list of associated SelfBillingValueItemText entities. This corresponds to the OData navigation property to_SelfBillingValueItemText.

      If the navigation property to_SelfBillingValueItemText of a queried SDDocumentReason 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.

      Parameters:
      entity - Array of SelfBillingValueItemText entities.

    • builder

      @Nonnull public static SDDocumentReason.SDDocumentReasonBuilder builder()

    • getSDDocumentReason

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

      Original property name from the Odata EDM: SDDocumentReason

      Returns:
      Order Reason (Reason for the Business Transaction)

    • getRetroBillingUsage

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

      Original property name from the Odata EDM: RetroBillingUsage

      Returns:
      Use of Order Reason for Retroactive Billing

    • getSelfBillingValueItem

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

      Original property name from the Odata EDM: SelfBillingValueItem

      Returns:
      Value Item for Self-Billing

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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