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

Class EquipmentLongText

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.namespaces.equipment.EquipmentLongText

public class EquipmentLongText
extends VdmEntity<EquipmentLongText>

Equipment Long Text

Original entity name from the Odata EDM: EquipmentLongTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static EquipmentLongTextSelectable	ALL_FIELDS Selector for all available fields of EquipmentLongText.
static EquipmentLongTextField<String>	EQUIPMENT Use with available fluent helpers to apply the Equipment field to query operations.
static EquipmentLongTextField<String>	EQUIPMENT_LONG_TEXT Use with available fluent helpers to apply the EquipmentLongText field to query operations.
static EquipmentLongTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static EquipmentLongTextField<String>	TEXT_OBJECT_KEY Use with available fluent helpers to apply the TextObjectKey field to query operations.
static EquipmentLongTextOneToOneLink<Equipment>	TO_EQUIPMENT Use with available fluent helpers to apply the to_Equipment navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
EquipmentLongText()
EquipmentLongText(String equipment, String textObjectKey, String language, String equipmentLongText, Equipment toEquipment)

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 EquipmentLongText.EquipmentLongTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Equipment	fetchEquipment() Fetches the Equipment entity (one to one) associated with this entity.
static <T> EquipmentLongTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> EquipmentLongTextField<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)
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.
String	getEquipment() (Key Field) Constraints: Not nullable, Maximum length: 18
io.vavr.control.Option<Equipment>	getEquipmentIfPresent() Retrieval of associated Equipment entity (one to one).
String	getEquipmentLongText() Constraints: none
Equipment	getEquipmentOrFetch() Retrieval of associated Equipment entity (one to one).
protected Map<String,Object>	getKey()
String	getLanguage() Constraints: Not nullable, Maximum length: 2
String	getTextObjectKey() Constraints: Not nullable, Maximum length: 18
Class<EquipmentLongText>	getType()
int	hashCode()
void	setEquipment(Equipment value) Overwrites the associated Equipment entity for the loaded navigation property to_Equipment.
void	setEquipment(String equipment) (Key Field) Constraints: Not nullable, Maximum length: 18
void	setEquipmentLongText(String equipmentLongText) Constraints: none
void	setLanguage(String language) Constraints: Not nullable, Maximum length: 2
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setTextObjectKey(String textObjectKey) Constraints: Not nullable, Maximum length: 18
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 EquipmentLongTextSelectable ALL_FIELDS

Selector for all available fields of EquipmentLongText.

EQUIPMENT

public static final EquipmentLongTextField<String> EQUIPMENT

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

TEXT_OBJECT_KEY

public static final EquipmentLongTextField<String> TEXT_OBJECT_KEY

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

LANGUAGE

public static final EquipmentLongTextField<String> LANGUAGE

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

EQUIPMENT_LONG_TEXT

public static final EquipmentLongTextField<String> EQUIPMENT_LONG_TEXT

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

TO_EQUIPMENT

public static final EquipmentLongTextOneToOneLink<Equipment> TO_EQUIPMENT

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

Constructor Detail

EquipmentLongText

public EquipmentLongText()

EquipmentLongText

public EquipmentLongText(@Nullable
                         String equipment,
                         @Nullable
                         String textObjectKey,
                         @Nullable
                         String language,
                         @Nullable
                         String equipmentLongText,
                         @Nullable
                         Equipment toEquipment)

Method Detail

getType

@Nonnull
public Class<EquipmentLongText> getType()

Specified by:

getType in class VdmObject<EquipmentLongText>

Returns:

The class of this object.

setEquipment

public void setEquipment(@Nullable
                         String equipment)

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

Original property name from the Odata EDM: Equipment

Parameters:

equipment - Equipment Number

setTextObjectKey

public void setTextObjectKey(@Nullable
                             String textObjectKey)

Constraints: Not nullable, Maximum length: 18

Original property name from the Odata EDM: TextObjectKey

Parameters:

textObjectKey - Equipment Number

setLanguage

public void setLanguage(@Nullable
                        String language)

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: Language

Parameters:

language - Language Key

setEquipmentLongText

public void setEquipmentLongText(@Nullable
                                 String equipmentLongText)

Constraints: none

Original property name from the Odata EDM: EquipmentLongText

Parameters:

equipmentLongText - Long Text

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<EquipmentLongText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<EquipmentLongText>

fromMap

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

Overrides:

fromMap in class VdmObject<EquipmentLongText>

field

@Nonnull
public static <T> EquipmentLongTextField<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> EquipmentLongTextField<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). New destination to apply to this entity

Overrides:

getDestinationForFetch in class VdmEntity<EquipmentLongText>

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

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

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

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

fetchEquipment

@Nullable
public Equipment fetchEquipment()
                                   throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the Equipment entity (one to one) associated with this entity. This corresponds to the OData navigation property to_Equipment.

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

Returns:

The single associated Equipment 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.

getEquipmentOrFetch

@Nullable
public Equipment getEquipmentOrFetch()
                                        throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated Equipment entity (one to one). This corresponds to the OData navigation property to_Equipment.

If the navigation property to_Equipment of a queried EquipmentLongText 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 Equipment 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.

getEquipmentIfPresent

@Nonnull
public io.vavr.control.Option<Equipment> getEquipmentIfPresent()

Retrieval of associated Equipment entity (one to one). This corresponds to the OData navigation property to_Equipment.

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

setEquipment

public void setEquipment(Equipment value)

Overwrites the associated Equipment entity for the loaded navigation property to_Equipment.

Parameters:

value - New Equipment entity.

builder

@Nonnull
public static EquipmentLongText.EquipmentLongTextBuilder builder()

getEquipment

@Nullable
public String getEquipment()

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

Original property name from the Odata EDM: Equipment

Returns:

Equipment Number

getTextObjectKey

@Nullable
public String getTextObjectKey()

Constraints: Not nullable, Maximum length: 18

Original property name from the Odata EDM: TextObjectKey

Returns:

Equipment Number

getLanguage

@Nullable
public String getLanguage()

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: Language

Returns:

Language Key

getEquipmentLongText

@Nullable
public String getEquipmentLongText()

Constraints: none

Original property name from the Odata EDM: EquipmentLongText

Returns:

Long Text

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<EquipmentLongText>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<EquipmentLongText>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<EquipmentLongText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<EquipmentLongText>