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

Class BR_NFExportDocument

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<BR_NFExportDocument>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.brazilnotafiscal.BR_NFExportDocument
public class BR_NFExportDocument extends VdmEntity<BR_NFExportDocument>
Brazil Nota Fiscal Export Document

Original entity name from the Odata EDM: A_BR_NFExportDocumentType

  • Field Details

    • ALL_FIELDS

      public static final BR_NFExportDocumentSelectable ALL_FIELDS
      Selector for all available fields of BR_NFExportDocument.

    • BR_NOTA_FISCAL

      public static final BR_NFExportDocumentField<String> BR_NOTA_FISCAL
      Use with available fluent helpers to apply the BR_NotaFiscal field to query operations.

    • BR_NOTA_FISCAL_ITEM

      public static final BR_NFExportDocumentField<String> BR_NOTA_FISCAL_ITEM
      Use with available fluent helpers to apply the BR_NotaFiscalItem field to query operations.

    • BRNF_ITEM_EXPRT_SQNC_NUMBER

      public static final BR_NFExportDocumentField<String> BRNF_ITEM_EXPRT_SQNC_NUMBER
      Use with available fluent helpers to apply the BR_NFItemExprtSqncNumber field to query operations.

    • BASE_UNIT

      public static final BR_NFExportDocumentField<String> BASE_UNIT
      Use with available fluent helpers to apply the BaseUnit field to query operations.

    • BRNF_ITEM_EXPRT_REG_NUMBER

      public static final BR_NFExportDocumentField<String> BRNF_ITEM_EXPRT_REG_NUMBER
      Use with available fluent helpers to apply the BR_NFItemExprtRegNumber field to query operations.

    • BRNF_ITEM_EXPRT_N_FE_ACCESS_KEY

      public static final BR_NFExportDocumentField<String> BRNF_ITEM_EXPRT_N_FE_ACCESS_KEY
      Use with available fluent helpers to apply the BR_NFItemExprtNFeAccessKey field to query operations.

    • BRNF_ITEM_EXPORT_REAL_QTY

      public static final BR_NFExportDocumentField<BigDecimal> BRNF_ITEM_EXPORT_REAL_QTY
      Use with available fluent helpers to apply the BR_NFItemExportRealQty field to query operations.

    • BRNF_ITM_EXPRT_DRWBK_CONCESSION

      public static final BR_NFExportDocumentField<String> BRNF_ITM_EXPRT_DRWBK_CONCESSION
      Use with available fluent helpers to apply the BR_NFItmExprtDrwbkConcession field to query operations.

    • BRNF_EXPORT_DRAWBACK_CONCESSION

      public static final BR_NFExportDocumentField<String> BRNF_EXPORT_DRAWBACK_CONCESSION
      Use with available fluent helpers to apply the BR_NFExportDrawbackConcession field to query operations.

    • TO_BRNF_DOC

      public static final BR_NFExportDocumentOneToOneLink<BR_NFDocument> TO_BRNF_DOC
      Use with available fluent helpers to apply the to_BR_NFDoc navigation property to query operations.

    • TO_BRNF_ITEM

      public static final BR_NFExportDocumentOneToOneLink<BR_NFItem> TO_BRNF_ITEM
      Use with available fluent helpers to apply the to_BR_NFItem navigation property to query operations.

  • Constructor Details

    • BR_NFExportDocument

      public BR_NFExportDocument()

    • BR_NFExportDocument

      public BR_NFExportDocument(@Nullable String bR_NotaFiscal, @Nullable String bR_NotaFiscalItem, @Nullable String bR_NFItemExprtSqncNumber, @Nullable String baseUnit, @Nullable String bR_NFItemExprtRegNumber, @Nullable String bR_NFItemExprtNFeAccessKey, @Nullable BigDecimal bR_NFItemExportRealQty, @Nullable String bR_NFItmExprtDrwbkConcession, @Nullable String bR_NFExportDrawbackConcession, @Nullable BR_NFDocument toBR_NFDoc, @Nullable BR_NFItem toBR_NFItem)

  • Method Details

    • getType

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

    • setBR_NotaFiscal

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

      Original property name from the Odata EDM: BR_NotaFiscal

      Parameters:
      bR_NotaFiscal - Document Number

    • setBR_NotaFiscalItem

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

      Original property name from the Odata EDM: BR_NotaFiscalItem

      Parameters:
      bR_NotaFiscalItem - Document Item Number

    • setBR_NFItemExprtSqncNumber

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

      Original property name from the Odata EDM: BR_NFItemExprtSqncNumber

      Parameters:
      bR_NFItemExprtSqncNumber - Export Sequence Nmbr

    • setBaseUnit

      public void setBaseUnit(@Nullable String baseUnit)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: BaseUnit

      Parameters:
      baseUnit - Base unit of measure

    • setBR_NFItemExprtRegNumber

      public void setBR_NFItemExprtRegNumber(@Nullable String bR_NFItemExprtRegNumber)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: BR_NFItemExprtRegNumber

      Parameters:
      bR_NFItemExprtRegNumber - Export Register Number

    • setBR_NFItemExprtNFeAccessKey

      public void setBR_NFItemExprtNFeAccessKey(@Nullable String bR_NFItemExprtNFeAccessKey)
      Constraints: Not nullable, Maximum length: 44

      Original property name from the Odata EDM: BR_NFItemExprtNFeAccessKey

      Parameters:
      bR_NFItemExprtNFeAccessKey - Export NF-e Key

    • setBR_NFItemExportRealQty

      public void setBR_NFItemExportRealQty(@Nullable BigDecimal bR_NFItemExportRealQty)
      Constraints: Not nullable, Precision: 15, Scale: 4

      Original property name from the Odata EDM: BR_NFItemExportRealQty

      Parameters:
      bR_NFItemExportRealQty - Quantity of Export Item

    • setBR_NFItmExprtDrwbkConcession

      public void setBR_NFItmExprtDrwbkConcession(@Nullable String bR_NFItmExprtDrwbkConcession)
      Constraints: Not nullable, Maximum length: 11

      Original property name from the Odata EDM: BR_NFItmExprtDrwbkConcession

      Parameters:
      bR_NFItmExprtDrwbkConcession - OBSOLETE: Number of drawback concession

    • setBR_NFExportDrawbackConcession

      public void setBR_NFExportDrawbackConcession(@Nullable String bR_NFExportDrawbackConcession)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: BR_NFExportDrawbackConcession

      Parameters:
      bR_NFExportDrawbackConcession - Drawback Concession

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> BR_NFExportDocumentField<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> BR_NFExportDocumentField<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<BR_NFExportDocument>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchBR_NFDoc

      @Nullable public BR_NFDocument fetchBR_NFDoc()
      Fetches the BR_NFDocument entity (one to one) associated with this entity. This corresponds to the OData navigation property to_BR_NFDoc.

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

      Returns:
      The single associated BR_NFDocument 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.

    • getBR_NFDocOrFetch

      @Nullable public BR_NFDocument getBR_NFDocOrFetch()
      Retrieval of associated BR_NFDocument entity (one to one). This corresponds to the OData navigation property to_BR_NFDoc.

      If the navigation property to_BR_NFDoc of a queried BR_NFExportDocument 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 BR_NFDocument 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.

    • getBR_NFDocIfPresent

      @Nonnull public io.vavr.control.Option<BR_NFDocument> getBR_NFDocIfPresent()
      Retrieval of associated BR_NFDocument entity (one to one). This corresponds to the OData navigation property to_BR_NFDoc.

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

    • setBR_NFDoc

      public void setBR_NFDoc(BR_NFDocument value)
      Overwrites the associated BR_NFDocument entity for the loaded navigation property to_BR_NFDoc.
      Parameters:
      value - New BR_NFDocument entity.

    • fetchBR_NFItem

      @Nullable public BR_NFItem fetchBR_NFItem()
      Fetches the BR_NFItem entity (one to one) associated with this entity. This corresponds to the OData navigation property to_BR_NFItem.

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

      Returns:
      The single associated BR_NFItem 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.

    • getBR_NFItemOrFetch

      @Nullable public BR_NFItem getBR_NFItemOrFetch()
      Retrieval of associated BR_NFItem entity (one to one). This corresponds to the OData navigation property to_BR_NFItem.

      If the navigation property to_BR_NFItem of a queried BR_NFExportDocument 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 BR_NFItem 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.

    • getBR_NFItemIfPresent

      @Nonnull public io.vavr.control.Option<BR_NFItem> getBR_NFItemIfPresent()
      Retrieval of associated BR_NFItem entity (one to one). This corresponds to the OData navigation property to_BR_NFItem.

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

    • setBR_NFItem

      public void setBR_NFItem(BR_NFItem value)
      Overwrites the associated BR_NFItem entity for the loaded navigation property to_BR_NFItem.
      Parameters:
      value - New BR_NFItem entity.

    • builder

      @Nonnull public static BR_NFExportDocument.BR_NFExportDocumentBuilder builder()

    • getBR_NotaFiscal

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

      Original property name from the Odata EDM: BR_NotaFiscal

      Returns:
      Document Number

    • getBR_NotaFiscalItem

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

      Original property name from the Odata EDM: BR_NotaFiscalItem

      Returns:
      Document Item Number

    • getBR_NFItemExprtSqncNumber

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

      Original property name from the Odata EDM: BR_NFItemExprtSqncNumber

      Returns:
      Export Sequence Nmbr

    • getBaseUnit

      @Nullable public String getBaseUnit()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: BaseUnit

      Returns:
      Base unit of measure

    • getBR_NFItemExprtRegNumber

      @Nullable public String getBR_NFItemExprtRegNumber()
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: BR_NFItemExprtRegNumber

      Returns:
      Export Register Number

    • getBR_NFItemExprtNFeAccessKey

      @Nullable public String getBR_NFItemExprtNFeAccessKey()
      Constraints: Not nullable, Maximum length: 44

      Original property name from the Odata EDM: BR_NFItemExprtNFeAccessKey

      Returns:
      Export NF-e Key

    • getBR_NFItemExportRealQty

      @Nullable public BigDecimal getBR_NFItemExportRealQty()
      Constraints: Not nullable, Precision: 15, Scale: 4

      Original property name from the Odata EDM: BR_NFItemExportRealQty

      Returns:
      Quantity of Export Item

    • getBR_NFItmExprtDrwbkConcession

      @Nullable public String getBR_NFItmExprtDrwbkConcession()
      Constraints: Not nullable, Maximum length: 11

      Original property name from the Odata EDM: BR_NFItmExprtDrwbkConcession

      Returns:
      OBSOLETE: Number of drawback concession

    • getBR_NFExportDrawbackConcession

      @Nullable public String getBR_NFExportDrawbackConcession()
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: BR_NFExportDrawbackConcession

      Returns:
      Drawback Concession

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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