com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.recipeheaderandformula

Class RecipeText

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.recipeheaderandformula.RecipeText

public class RecipeText
extends VdmEntity<RecipeText>

API for Recipe Description

Original entity name from the Odata EDM: A_RecipeTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static RecipeTextSelectable	ALL_FIELDS Selector for all available fields of RecipeText.
static RecipeTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static RecipeTextField<String>	RECIPE Use with available fluent helpers to apply the Recipe field to query operations.
static RecipeTextField<String>	RECIPE_DESCRIPTION Use with available fluent helpers to apply the RecipeDescription field to query operations.
static RecipeTextField<ZonedDateTime>	RECIPE_LAST_CHANGE_DATE_TIME Use with available fluent helpers to apply the RecipeLastChangeDateTime field to query operations.
static RecipeTextField<UUID>	RECIPE_UUID Use with available fluent helpers to apply the RecipeUUID field to query operations.
static RecipeTextOneToOneLink<Recipe>	TO_RECIPE Use with available fluent helpers to apply the to_Recipe navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
RecipeText()
RecipeText(UUID recipeUUID, String language, String recipeDescription, ZonedDateTime recipeLastChangeDateTime, String recipe, Recipe toRecipe)

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 RecipeText.RecipeTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Recipe	fetchRecipe() Fetches the Recipe entity (one to one) associated with this entity.
static <T> RecipeTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> RecipeTextField<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()
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection()
protected Map<String,Object>	getKey()
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getRecipe() Constraints: Not nullable, Maximum length: 20
String	getRecipeDescription() Constraints: Not nullable, Maximum length: 132
io.vavr.control.Option<Recipe>	getRecipeIfPresent() Retrieval of associated Recipe entity (one to one).
ZonedDateTime	getRecipeLastChangeDateTime() Constraints: Not nullable, Precision: 0
Recipe	getRecipeOrFetch() Retrieval of associated Recipe entity (one to one).
UUID	getRecipeUUID() (Key Field) Constraints: Not nullable
Class<RecipeText>	getType()
int	hashCode()
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setRecipe(Recipe value) Overwrites the associated Recipe entity for the loaded navigation property to_Recipe.
void	setRecipe(String recipe) Constraints: Not nullable, Maximum length: 20
void	setRecipeDescription(String recipeDescription) Constraints: Not nullable, Maximum length: 132
void	setRecipeLastChangeDateTime(ZonedDateTime recipeLastChangeDateTime) Constraints: Not nullable, Precision: 0
void	setRecipeUUID(UUID recipeUUID) (Key Field) Constraints: Not nullable
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 RecipeTextSelectable ALL_FIELDS

Selector for all available fields of RecipeText.

RECIPE_UUID

public static final RecipeTextField<UUID> RECIPE_UUID

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

LANGUAGE

public static final RecipeTextField<String> LANGUAGE

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

RECIPE_DESCRIPTION

public static final RecipeTextField<String> RECIPE_DESCRIPTION

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

RECIPE_LAST_CHANGE_DATE_TIME

public static final RecipeTextField<ZonedDateTime> RECIPE_LAST_CHANGE_DATE_TIME

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

RECIPE

public static final RecipeTextField<String> RECIPE

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

TO_RECIPE

public static final RecipeTextOneToOneLink<Recipe> TO_RECIPE

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

Constructor Detail

RecipeText

public RecipeText()

RecipeText

public RecipeText(@Nullable
                  UUID recipeUUID,
                  @Nullable
                  String language,
                  @Nullable
                  String recipeDescription,
                  @Nullable
                  ZonedDateTime recipeLastChangeDateTime,
                  @Nullable
                  String recipe,
                  @Nullable
                  Recipe toRecipe)

Method Detail

getType

@Nonnull
public Class<RecipeText> getType()

Specified by:

getType in class VdmObject<RecipeText>

Returns:

The class of this object.

setRecipeUUID

public void setRecipeUUID(@Nullable
                          UUID recipeUUID)

(Key Field) Constraints: Not nullable

Original property name from the Odata EDM: RecipeUUID

Parameters:

recipeUUID - Common Recipe GUID

setLanguage

public void setLanguage(@Nullable
                        String language)

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

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Parameters:

language - The language key indicates

setRecipeDescription

public void setRecipeDescription(@Nullable
                                 String recipeDescription)

Constraints: Not nullable, Maximum length: 132

Original property name from the Odata EDM: RecipeDescription

Parameters:

recipeDescription - Recipe Description

setRecipeLastChangeDateTime

public void setRecipeLastChangeDateTime(@Nullable
                                        ZonedDateTime recipeLastChangeDateTime)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: RecipeLastChangeDateTime

Parameters:

recipeLastChangeDateTime - UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

setRecipe

public void setRecipe(@Nullable
                      String recipe)

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: Recipe

Parameters:

recipe - Recipe ID

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<RecipeText>

getKey

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

Overrides:

getKey in class VdmObject<RecipeText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<RecipeText>

fromMap

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

Overrides:

fromMap in class VdmObject<RecipeText>

field

@Nonnull
public static <T> RecipeTextField<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> RecipeTextField<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<RecipeText>

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

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

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()

Overrides:

getDefaultServicePath in class VdmEntity<RecipeText>

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<RecipeText>

fetchRecipe

@Nullable
public Recipe fetchRecipe()
                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getRecipeOrFetch

@Nullable
public Recipe getRecipeOrFetch()
                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated Recipe entity (one to one). This corresponds to the OData navigation property to_Recipe.

If the navigation property to_Recipe of a queried RecipeText 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 Recipe 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.

getRecipeIfPresent

@Nonnull
public io.vavr.control.Option<Recipe> getRecipeIfPresent()

Retrieval of associated Recipe entity (one to one). This corresponds to the OData navigation property to_Recipe.

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

setRecipe

public void setRecipe(Recipe value)

Overwrites the associated Recipe entity for the loaded navigation property to_Recipe.

Parameters:

value - New Recipe entity.

builder

public static RecipeText.RecipeTextBuilder builder()

getRecipeUUID

@Nullable
public UUID getRecipeUUID()

(Key Field) Constraints: Not nullable

Original property name from the Odata EDM: RecipeUUID

Returns:

Common Recipe GUID

getLanguage

@Nullable
public String getLanguage()

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

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Returns:

The language key indicates

getRecipeDescription

@Nullable
public String getRecipeDescription()

Constraints: Not nullable, Maximum length: 132

Original property name from the Odata EDM: RecipeDescription

Returns:

Recipe Description

getRecipeLastChangeDateTime

@Nullable
public ZonedDateTime getRecipeLastChangeDateTime()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: RecipeLastChangeDateTime

Returns:

UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

getRecipe

@Nullable
public String getRecipe()

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: Recipe

Returns:

Recipe ID

toString

public String toString()

Overrides:

toString in class VdmObject<RecipeText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<RecipeText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<RecipeText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<RecipeText>