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

Class BR_NFTrailer

java.lang.Object

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

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

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

public class BR_NFTrailer
extends VdmEntity<BR_NFTrailer>

Nota Fiscal Trailer Data

Original entity name from the Odata EDM: A_BR_NFTrailerType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static BR_NFTrailerSelectable	ALL_FIELDS Selector for all available fields of BR_NFTrailer.
static BR_NFTrailerField<String>	BR_NOTA_FISCAL Use with available fluent helpers to apply the BR_NotaFiscal field to query operations.
static BR_NFTrailerField<String>	LICENSE_PLATE Use with available fluent helpers to apply the LicensePlate field to query operations.
static BR_NFTrailerOneToOneLink<BR_NFDocument>	TO_BRNF_DOC Use with available fluent helpers to apply the to_BR_NFDoc navigation property to query operations.
static BR_NFTrailerField<String>	TRAILER_ID Use with available fluent helpers to apply the TrailerID field to query operations.
static BR_NFTrailerField<String>	TRAILER_REGION Use with available fluent helpers to apply the TrailerRegion field to query operations.
static BR_NFTrailerField<String>	TRAILER_REGISTRATION Use with available fluent helpers to apply the TrailerRegistration field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
BR_NFTrailer()
BR_NFTrailer(String bR_NotaFiscal, String trailerID, String licensePlate, String trailerRegion, String trailerRegistration, 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_NFTrailer.BR_NFTrailerBuilder	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_NFTrailerField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> BR_NFTrailerField<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).
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()
String	getLicensePlate() Constraints: Not nullable, Maximum length: 7
String	getTrailerID() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getTrailerRegion() Constraints: Not nullable, Maximum length: 3
String	getTrailerRegistration() Constraints: Not nullable, Maximum length: 20
Class<BR_NFTrailer>	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_NotaFiscal(String bR_NotaFiscal) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setLicensePlate(String licensePlate) Constraints: Not nullable, Maximum length: 7
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setTrailerID(String trailerID) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setTrailerRegion(String trailerRegion) Constraints: Not nullable, Maximum length: 3
void	setTrailerRegistration(String trailerRegistration) Constraints: Not nullable, Maximum length: 20
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_NFTrailerSelectable ALL_FIELDS

Selector for all available fields of BR_NFTrailer.

BR_NOTA_FISCAL

public static final BR_NFTrailerField<String> BR_NOTA_FISCAL

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

TRAILER_ID

public static final BR_NFTrailerField<String> TRAILER_ID

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

LICENSE_PLATE

public static final BR_NFTrailerField<String> LICENSE_PLATE

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

TRAILER_REGION

public static final BR_NFTrailerField<String> TRAILER_REGION

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

TRAILER_REGISTRATION

public static final BR_NFTrailerField<String> TRAILER_REGISTRATION

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

TO_BRNF_DOC

public static final BR_NFTrailerOneToOneLink<BR_NFDocument> TO_BRNF_DOC

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

Constructor Detail

BR_NFTrailer

public BR_NFTrailer()

BR_NFTrailer

public BR_NFTrailer(@Nullable
                    String bR_NotaFiscal,
                    @Nullable
                    String trailerID,
                    @Nullable
                    String licensePlate,
                    @Nullable
                    String trailerRegion,
                    @Nullable
                    String trailerRegistration,
                    @Nullable
                    BR_NFDocument toBR_NFDoc)

Method Detail

getType

@Nonnull
public Class<BR_NFTrailer> getType()

Specified by:

getType in class VdmObject<BR_NFTrailer>

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

setTrailerID

public void setTrailerID(@Nullable
                         String trailerID)

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

Original property name from the Odata EDM: TrailerID

Parameters:

trailerID - Counter

setLicensePlate

public void setLicensePlate(@Nullable
                            String licensePlate)

Constraints: Not nullable, Maximum length: 7

Original property name from the Odata EDM: LicensePlate

Parameters:

licensePlate - Vehicle License Plate

setTrailerRegion

public void setTrailerRegion(@Nullable
                             String trailerRegion)

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: TrailerRegion

Parameters:

trailerRegion - Region of Vehicle

setTrailerRegistration

public void setTrailerRegistration(@Nullable
                                   String trailerRegistration)

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: TrailerRegistration

Parameters:

trailerRegistration - Cargo Carrier ID

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<BR_NFTrailer>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<BR_NFTrailer>

fromMap

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

Overrides:

fromMap in class VdmObject<BR_NFTrailer>

field

@Nonnull
public static <T> BR_NFTrailerField<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_NFTrailerField<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_NFTrailer>

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

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

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

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

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_NFTrailer 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_NFTrailer 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_NFTrailer.BR_NFTrailerBuilder 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

getTrailerID

@Nullable
public String getTrailerID()

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

Original property name from the Odata EDM: TrailerID

Returns:

Counter

getLicensePlate

@Nullable
public String getLicensePlate()

Constraints: Not nullable, Maximum length: 7

Original property name from the Odata EDM: LicensePlate

Returns:

Vehicle License Plate

getTrailerRegion

@Nullable
public String getTrailerRegion()

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: TrailerRegion

Returns:

Region of Vehicle

getTrailerRegistration

@Nullable
public String getTrailerRegistration()

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: TrailerRegistration

Returns:

Cargo Carrier ID

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<BR_NFTrailer>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<BR_NFTrailer>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<BR_NFTrailer>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BR_NFTrailer>