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

Class BR_NFePharmaceutical

java.lang.Object

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

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

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

public class BR_NFePharmaceutical
extends VdmEntity<BR_NFePharmaceutical>

Nota Fiscal Pharmaceutical Items

Original entity name from the Odata EDM: A_BR_NFePharmaceuticalType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static BR_NFePharmaceuticalSelectable	ALL_FIELDS Selector for all available fields of BR_NFePharmaceutical.
static BR_NFePharmaceuticalField<String>	BR_NOTA_FISCAL Use with available fluent helpers to apply the BR_NotaFiscal field to query operations.
static BR_NFePharmaceuticalField<String>	BR_NOTA_FISCAL_ITEM Use with available fluent helpers to apply the BR_NotaFiscalItem field to query operations.
static BR_NFePharmaceuticalField<String>	BRANVISA_CODE Use with available fluent helpers to apply the BR_ANVISACode field to query operations.
static BR_NFePharmaceuticalField<String>	BRANVISA_EXEMPTION_REASON_TEXT Use with available fluent helpers to apply the BR_ANVISAExemptionReasonText field to query operations.
static BR_NFePharmaceuticalField<BigDecimal>	MEDICINE_CONSUMER_MAX_PRICE Use with available fluent helpers to apply the MedicineConsumerMaxPrice field to query operations.
static BR_NFePharmaceuticalField<String>	SALES_DOCUMENT_CURRENCY Use with available fluent helpers to apply the SalesDocumentCurrency field to query operations.
static BR_NFePharmaceuticalOneToOneLink<BR_NFDocument>	TO_BRNF_DOC Use with available fluent helpers to apply the to_BR_NFDoc navigation property to query operations.
static BR_NFePharmaceuticalOneToOneLink<BR_NFItem>	TO_BRNF_ITEM Use with available fluent helpers to apply the to_BR_NFItem 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_NFePharmaceutical()
BR_NFePharmaceutical(String bR_NotaFiscal, String bR_NotaFiscalItem, String bR_ANVISACode, BigDecimal medicineConsumerMaxPrice, String bR_ANVISAExemptionReasonText, String salesDocumentCurrency, BR_NFDocument toBR_NFDoc, BR_NFItem toBR_NFItem)

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_NFePharmaceutical.BR_NFePharmaceuticalBuilder	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.
BR_NFItem	fetchBR_NFItem() Fetches the BR_NFItem entity (one to one) associated with this entity.
static <T> BR_NFePharmaceuticalField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> BR_NFePharmaceuticalField<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)
String	getBR_ANVISACode() Constraints: Not nullable, Maximum length: 13
String	getBR_ANVISAExemptionReasonText() Constraints: Not nullable, Maximum length: 255
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).
io.vavr.control.Option<BR_NFItem>	getBR_NFItemIfPresent() Retrieval of associated BR_NFItem entity (one to one).
BR_NFItem	getBR_NFItemOrFetch() Retrieval of associated BR_NFItem entity (one to one).
String	getBR_NotaFiscal() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getBR_NotaFiscalItem() (Key Field) Constraints: Not nullable, Maximum length: 6
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()
BigDecimal	getMedicineConsumerMaxPrice() Constraints: Not nullable, Precision: 15, Scale: 2
String	getSalesDocumentCurrency() Constraints: Not nullable, Maximum length: 5
Class<BR_NFePharmaceutical>	getType()
int	hashCode()
void	setBR_ANVISACode(String bR_ANVISACode) Constraints: Not nullable, Maximum length: 13
void	setBR_ANVISAExemptionReasonText(String bR_ANVISAExemptionReasonText) Constraints: Not nullable, Maximum length: 255
void	setBR_NFDoc(BR_NFDocument value) Overwrites the associated BR_NFDocument entity for the loaded navigation property to_BR_NFDoc.
void	setBR_NFItem(BR_NFItem value) Overwrites the associated BR_NFItem entity for the loaded navigation property to_BR_NFItem.
void	setBR_NotaFiscal(String bR_NotaFiscal) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setBR_NotaFiscalItem(String bR_NotaFiscalItem) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setMedicineConsumerMaxPrice(BigDecimal medicineConsumerMaxPrice) Constraints: Not nullable, Precision: 15, Scale: 2
void	setSalesDocumentCurrency(String salesDocumentCurrency) Constraints: Not nullable, Maximum length: 5
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_NFePharmaceuticalSelectable ALL_FIELDS

Selector for all available fields of BR_NFePharmaceutical.

BR_NOTA_FISCAL

public static final BR_NFePharmaceuticalField<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_NFePharmaceuticalField<String> BR_NOTA_FISCAL_ITEM

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

BRANVISA_CODE

public static final BR_NFePharmaceuticalField<String> BRANVISA_CODE

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

MEDICINE_CONSUMER_MAX_PRICE

public static final BR_NFePharmaceuticalField<BigDecimal> MEDICINE_CONSUMER_MAX_PRICE

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

BRANVISA_EXEMPTION_REASON_TEXT

public static final BR_NFePharmaceuticalField<String> BRANVISA_EXEMPTION_REASON_TEXT

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

SALES_DOCUMENT_CURRENCY

public static final BR_NFePharmaceuticalField<String> SALES_DOCUMENT_CURRENCY

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

TO_BRNF_DOC

public static final BR_NFePharmaceuticalOneToOneLink<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_NFePharmaceuticalOneToOneLink<BR_NFItem> TO_BRNF_ITEM

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

Constructor Detail

BR_NFePharmaceutical

public BR_NFePharmaceutical()

BR_NFePharmaceutical

public BR_NFePharmaceutical(@Nullable
                            String bR_NotaFiscal,
                            @Nullable
                            String bR_NotaFiscalItem,
                            @Nullable
                            String bR_ANVISACode,
                            @Nullable
                            BigDecimal medicineConsumerMaxPrice,
                            @Nullable
                            String bR_ANVISAExemptionReasonText,
                            @Nullable
                            String salesDocumentCurrency,
                            @Nullable
                            BR_NFDocument toBR_NFDoc,
                            @Nullable
                            BR_NFItem toBR_NFItem)

Method Detail

getType

@Nonnull
public Class<BR_NFePharmaceutical> getType()

Specified by:

getType in class VdmObject<BR_NFePharmaceutical>

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_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_ANVISACode

public void setBR_ANVISACode(@Nullable
                             String bR_ANVISACode)

Constraints: Not nullable, Maximum length: 13

Original property name from the Odata EDM: BR_ANVISACode

Parameters:

bR_ANVISACode - ANVISA Code

setMedicineConsumerMaxPrice

public void setMedicineConsumerMaxPrice(@Nullable
                                        BigDecimal medicineConsumerMaxPrice)

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

Original property name from the Odata EDM: MedicineConsumerMaxPrice

Parameters:

medicineConsumerMaxPrice - Consumer Maximum Price

setBR_ANVISAExemptionReasonText

public void setBR_ANVISAExemptionReasonText(@Nullable
                                            String bR_ANVISAExemptionReasonText)

Constraints: Not nullable, Maximum length: 255

Original property name from the Odata EDM: BR_ANVISAExemptionReasonText

Parameters:

bR_ANVISAExemptionReasonText - ANVISA Exemption Reason

setSalesDocumentCurrency

public void setSalesDocumentCurrency(@Nullable
                                     String salesDocumentCurrency)

Constraints: Not nullable, Maximum length: 5

Original property name from the Odata EDM: SalesDocumentCurrency

Parameters:

salesDocumentCurrency - SD document currency

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_NFePharmaceutical>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<BR_NFePharmaceutical>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<BR_NFePharmaceutical>

fromMap

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

Overrides:

fromMap in class VdmObject<BR_NFePharmaceutical>

field

@Nonnull
public static <T> BR_NFePharmaceuticalField<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_NFePharmaceuticalField<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_NFePharmaceutical>

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_NFePharmaceutical>

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_NFePharmaceutical>

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_NFePharmaceutical>

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_NFePharmaceutical>

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

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.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_NFItemOrFetch

@Nullable
public BR_NFItem getBR_NFItemOrFetch()
                                        throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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_NFePharmaceutical 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.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_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_NFePharmaceutical 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_NFePharmaceutical.BR_NFePharmaceuticalBuilder 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_ANVISACode

@Nullable
public String getBR_ANVISACode()

Constraints: Not nullable, Maximum length: 13

Original property name from the Odata EDM: BR_ANVISACode

Returns:

ANVISA Code

getMedicineConsumerMaxPrice

@Nullable
public BigDecimal getMedicineConsumerMaxPrice()

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

Original property name from the Odata EDM: MedicineConsumerMaxPrice

Returns:

Consumer Maximum Price

getBR_ANVISAExemptionReasonText

@Nullable
public String getBR_ANVISAExemptionReasonText()

Constraints: Not nullable, Maximum length: 255

Original property name from the Odata EDM: BR_ANVISAExemptionReasonText

Returns:

ANVISA Exemption Reason

getSalesDocumentCurrency

@Nullable
public String getSalesDocumentCurrency()

Constraints: Not nullable, Maximum length: 5

Original property name from the Odata EDM: SalesDocumentCurrency

Returns:

SD document currency

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<BR_NFePharmaceutical>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<BR_NFePharmaceutical>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<BR_NFePharmaceutical>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BR_NFePharmaceutical>