com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.namespaces.brazilnotafiscal

Class BR_NFTradeNote

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>

com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<BR_NFTradeNote>

com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.namespaces.brazilnotafiscal.BR_NFTradeNote

public class BR_NFTradeNote
extends VdmEntity<BR_NFTradeNote>

Nota Fiscal Trade Notes

Original entity name from the Odata EDM: A_BR_NFTradeNoteType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BR_NFTradeNote.BR_NFTradeNoteBuilder Helper class to allow for fluent creation of BR_NFTradeNote instances.

Field Summary

Fields

Modifier and Type	Field and Description
static BR_NFTradeNoteSelectable	ALL_FIELDS Selector for all available fields of BR_NFTradeNote.
static BR_NFTradeNoteField<String>	BR_NOTA_FISCAL Use with available fluent helpers to apply the BR_NotaFiscal field to query operations.
static BR_NFTradeNoteField<LocalDateTime>	BRNF_TRADE_NOTE_EXPIRING_DATE Use with available fluent helpers to apply the BR_NFTradeNoteExpiringDate field to query operations.
static BR_NFTradeNoteField<String>	BRNF_TRADE_NOTE_NUMBER Use with available fluent helpers to apply the BR_NFTradeNoteNumber field to query operations.
static BR_NFTradeNoteField<String>	BRNF_TRADE_NOTE_SEQUENCE_NUMBER Use with available fluent helpers to apply the BR_NFTradeNoteSequenceNumber field to query operations.
static BR_NFTradeNoteField<BigDecimal>	BRNF_TRADE_NOTE_VALUE Use with available fluent helpers to apply the BR_NFTradeNoteValue field to query operations.
static BR_NFTradeNoteOneToOneLink<BR_NFDocument>	TO_BRNF_DOC Use with available fluent helpers to apply the to_BR_NFDoc navigation property to query operations.

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
BR_NFTradeNote()
BR_NFTradeNote(String bR_NotaFiscal, String bR_NFTradeNoteSequenceNumber, String bR_NFTradeNoteNumber, LocalDateTime bR_NFTradeNoteExpiringDate, BigDecimal bR_NFTradeNoteValue, BR_NFDocument toBR_NFDoc)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static BR_NFTradeNote.BR_NFTradeNoteBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BR_NFDocument	fetchBR_NFDoc() Fetches the BR_NFDocument entity (one to one) associated with this entity.
static <T> BR_NFTradeNoteField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> BR_NFTradeNoteField<T>	field(String fieldName, TypeConverter<T,DomainT> typeConverter) Use with available fluent helpers to apply an extension field to query operations.
protected void	fromMap(Map<String,Object> inputValues)
io.vavr.control.Option<BR_NFDocument>	getBR_NFDocIfPresent() Retrieval of associated BR_NFDocument entity (one to one).
BR_NFDocument	getBR_NFDocOrFetch() Retrieval of associated BR_NFDocument entity (one to one).
LocalDateTime	getBR_NFTradeNoteExpiringDate() Constraints: Not nullable, Precision: 0
String	getBR_NFTradeNoteNumber() Constraints: Not nullable, Maximum length: 20
String	getBR_NFTradeNoteSequenceNumber() (Key Field) Constraints: Not nullable, Maximum length: 4
BigDecimal	getBR_NFTradeNoteValue() Constraints: Not nullable, Precision: 15, Scale: 2
String	getBR_NotaFiscal() (Key Field) Constraints: Not nullable, Maximum length: 10
protected String	getDefaultServicePath() Used by fluent helpers and navigation property methods to construct OData queries.
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
protected Map<String,Object>	getKey()
Class<BR_NFTradeNote>	getType()
int	hashCode()
void	setBR_NFDoc(BR_NFDocument value) Overwrites the associated BR_NFDocument entity for the loaded navigation property to_BR_NFDoc.
void	setBR_NFTradeNoteExpiringDate(LocalDateTime bR_NFTradeNoteExpiringDate) Constraints: Not nullable, Precision: 0
void	setBR_NFTradeNoteNumber(String bR_NFTradeNoteNumber) Constraints: Not nullable, Maximum length: 20
void	setBR_NFTradeNoteSequenceNumber(String bR_NFTradeNoteSequenceNumber) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setBR_NFTradeNoteValue(BigDecimal bR_NFTradeNoteValue) Constraints: Not nullable, Precision: 15, Scale: 2
void	setBR_NotaFiscal(String bR_NotaFiscal) (Key Field) Constraints: Not nullable, Maximum length: 10
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity

getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final BR_NFTradeNoteSelectable ALL_FIELDS

Selector for all available fields of BR_NFTradeNote.

BR_NOTA_FISCAL

public static final BR_NFTradeNoteField<String> BR_NOTA_FISCAL

Use with available fluent helpers to apply the BR_NotaFiscal field to query operations.

BRNF_TRADE_NOTE_SEQUENCE_NUMBER

public static final BR_NFTradeNoteField<String> BRNF_TRADE_NOTE_SEQUENCE_NUMBER

Use with available fluent helpers to apply the BR_NFTradeNoteSequenceNumber field to query operations.

BRNF_TRADE_NOTE_NUMBER

public static final BR_NFTradeNoteField<String> BRNF_TRADE_NOTE_NUMBER

Use with available fluent helpers to apply the BR_NFTradeNoteNumber field to query operations.

BRNF_TRADE_NOTE_EXPIRING_DATE

public static final BR_NFTradeNoteField<LocalDateTime> BRNF_TRADE_NOTE_EXPIRING_DATE

Use with available fluent helpers to apply the BR_NFTradeNoteExpiringDate field to query operations.

BRNF_TRADE_NOTE_VALUE

public static final BR_NFTradeNoteField<BigDecimal> BRNF_TRADE_NOTE_VALUE

Use with available fluent helpers to apply the BR_NFTradeNoteValue field to query operations.

TO_BRNF_DOC

public static final BR_NFTradeNoteOneToOneLink<BR_NFDocument> TO_BRNF_DOC

Use with available fluent helpers to apply the to_BR_NFDoc navigation property to query operations.

Constructor Detail

BR_NFTradeNote

public BR_NFTradeNote()

BR_NFTradeNote

public BR_NFTradeNote(@Nullable
                      String bR_NotaFiscal,
                      @Nullable
                      String bR_NFTradeNoteSequenceNumber,
                      @Nullable
                      String bR_NFTradeNoteNumber,
                      @Nullable
                      LocalDateTime bR_NFTradeNoteExpiringDate,
                      @Nullable
                      BigDecimal bR_NFTradeNoteValue,
                      @Nullable
                      BR_NFDocument toBR_NFDoc)

Method Detail

getType

@Nonnull
public Class<BR_NFTradeNote> getType()

Specified by:

getType in class VdmObject<BR_NFTradeNote>

Returns:

The class of this object.

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_NFTradeNoteSequenceNumber

public void setBR_NFTradeNoteSequenceNumber(@Nullable
                                            String bR_NFTradeNoteSequenceNumber)

(Key Field) Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: BR_NFTradeNoteSequenceNumber

Parameters:

bR_NFTradeNoteSequenceNumber - Counter

setBR_NFTradeNoteNumber

public void setBR_NFTradeNoteNumber(@Nullable
                                    String bR_NFTradeNoteNumber)

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: BR_NFTradeNoteNumber

Parameters:

bR_NFTradeNoteNumber - Trade Note Number

setBR_NFTradeNoteExpiringDate

public void setBR_NFTradeNoteExpiringDate(@Nullable
                                          LocalDateTime bR_NFTradeNoteExpiringDate)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: BR_NFTradeNoteExpiringDate

Parameters:

bR_NFTradeNoteExpiringDate - Expiring Date

setBR_NFTradeNoteValue

public void setBR_NFTradeNoteValue(@Nullable
                                   BigDecimal bR_NFTradeNoteValue)

Constraints: Not nullable, Precision: 15, Scale: 2

Original property name from the Odata EDM: BR_NFTradeNoteValue

Parameters:

bR_NFTradeNoteValue - Amount

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<BR_NFTradeNote>

Returns:

EDMX name of the entity collection identifier.

getKey

@Nonnull
protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<BR_NFTradeNote>

Returns:

The compound key of this object.

toMapOfFields

@Nonnull
protected Map<String,Object> toMapOfFields()

Overrides:

toMapOfFields in class VdmObject<BR_NFTradeNote>

fromMap

protected void fromMap(Map<String,Object> inputValues)

Overrides:

fromMap in class VdmObject<BR_NFTradeNote>

field

@Nonnull
public static <T> BR_NFTradeNoteField<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_NFTradeNoteField<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 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()

Description copied from class: VdmEntity

Convienence field for reusing the same destination with multiple queries (e.g. fetching associated entities).

Overrides:

getDestinationForFetch in class VdmEntity<BR_NFTradeNote>

Returns:

The stored destination for executing queries, or null if no such context has been set.

setServicePathForFetch

protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)

Description copied from class: VdmEntity

The service path only used for the fetch commands of this entity.

Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.

Overrides:

setServicePathForFetch in class VdmEntity<BR_NFTradeNote>

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)

Description copied from class: VdmEntity

Sets the service path and destination for the fetch commands of this entity. Also applies to any associated entities (navigation properties) that were previously fetched.

Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.

Overrides:

attachToService in class VdmEntity<BR_NFTradeNote>

Parameters:

servicePath - Optional parameter. New service path to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the service path has never been set, then the service path will be set to the default defined in the corresponding service interface.

destination - New destination to apply to this entity and any associated entities that were previously fetched.

getDefaultServicePath

protected String getDefaultServicePath()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<BR_NFTradeNote>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

toMapOfNavigationProperties

@Nonnull
protected Map<String,Object> toMapOfNavigationProperties()

Overrides:

toMapOfNavigationProperties in class VdmObject<BR_NFTradeNote>

fetchBR_NFDoc

@Nullable
public BR_NFDocument fetchBR_NFDoc()
                                      throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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.odatav2.connectivity.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()
                                           throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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_NFTradeNote 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.odatav2.connectivity.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_NFTradeNote 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_NFTradeNote.BR_NFTradeNoteBuilder 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_NFTradeNoteSequenceNumber

@Nullable
public String getBR_NFTradeNoteSequenceNumber()

(Key Field) Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: BR_NFTradeNoteSequenceNumber

Returns:

Counter

getBR_NFTradeNoteNumber

@Nullable
public String getBR_NFTradeNoteNumber()

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: BR_NFTradeNoteNumber

Returns:

Trade Note Number

getBR_NFTradeNoteExpiringDate

@Nullable
public LocalDateTime getBR_NFTradeNoteExpiringDate()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: BR_NFTradeNoteExpiringDate

Returns:

Expiring Date

getBR_NFTradeNoteValue

@Nullable
public BigDecimal getBR_NFTradeNoteValue()

Constraints: Not nullable, Precision: 15, Scale: 2

Original property name from the Odata EDM: BR_NFTradeNoteValue

Returns:

Amount

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<BR_NFTradeNote>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<BR_NFTradeNote>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<BR_NFTradeNote>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BR_NFTradeNote>