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

Class BR_NFDocumentReference

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

Original entity name from the Odata EDM: A_BR_NFDocumentReferenceType

  • Field Details

    • ALL_FIELDS

      public static final BR_NFDocumentReferenceSelectable ALL_FIELDS
      Selector for all available fields of BR_NFDocumentReference.

    • BR_NOTA_FISCAL

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

    • BRNF_DOC_REF_SEQUENCE_NUMBER

      public static final BR_NFDocumentReferenceField<String> BRNF_DOC_REF_SEQUENCE_NUMBER
      Use with available fluent helpers to apply the BR_NFDocRefSequenceNumber field to query operations.

    • BRNF_DOCUMENT_REFERENCE_TYPE

      public static final BR_NFDocumentReferenceField<String> BRNF_DOCUMENT_REFERENCE_TYPE
      Use with available fluent helpers to apply the BR_NFDocumentReferenceType field to query operations.

    • BRNF_DOC_REFERENCE_ACCESS_KEY

      public static final BR_NFDocumentReferenceField<String> BRNF_DOC_REFERENCE_ACCESS_KEY
      Use with available fluent helpers to apply the BR_NFDocReferenceAccessKey field to query operations.

    • TO_BRNF_DOC

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

  • Constructor Details

    • BR_NFDocumentReference

      public BR_NFDocumentReference()

    • BR_NFDocumentReference

      public BR_NFDocumentReference(@Nullable String bR_NotaFiscal, @Nullable String bR_NFDocRefSequenceNumber, @Nullable String bR_NFDocumentReferenceType, @Nullable String bR_NFDocReferenceAccessKey, @Nullable BR_NFDocument toBR_NFDoc)

  • Method Details

    • getType

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

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

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

      Original property name from the Odata EDM: BR_NFDocRefSequenceNumber

      Parameters:
      bR_NFDocRefSequenceNumber - Counter

    • setBR_NFDocumentReferenceType

      public void setBR_NFDocumentReferenceType(@Nullable String bR_NFDocumentReferenceType)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: BR_NFDocumentReferenceType

      Parameters:
      bR_NFDocumentReferenceType - Document Reference Type

    • setBR_NFDocReferenceAccessKey

      public void setBR_NFDocReferenceAccessKey(@Nullable String bR_NFDocReferenceAccessKey)
      Constraints: Not nullable, Maximum length: 44

      Original property name from the Odata EDM: BR_NFDocReferenceAccessKey

      Parameters:
      bR_NFDocReferenceAccessKey - 44-Digit Access Key

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> BR_NFDocumentReferenceField<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_NFDocumentReferenceField<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_NFDocumentReference>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

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

    • builder

      @Nonnull public static BR_NFDocumentReference.BR_NFDocumentReferenceBuilder 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_NFDocRefSequenceNumber

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

      Original property name from the Odata EDM: BR_NFDocRefSequenceNumber

      Returns:
      Counter

    • getBR_NFDocumentReferenceType

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

      Original property name from the Odata EDM: BR_NFDocumentReferenceType

      Returns:
      Document Reference Type

    • getBR_NFDocReferenceAccessKey

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

      Original property name from the Odata EDM: BR_NFDocReferenceAccessKey

      Returns:
      44-Digit Access Key

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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