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

Class RecipeClass

java.lang.Object

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

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

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

public class RecipeClass
extends VdmEntity<RecipeClass>

API for Recipe Class

Original entity name from the Odata EDM: A_RecipeClassType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static RecipeClassSelectable	ALL_FIELDS Selector for all available fields of RecipeClass.
static RecipeClassField<String>	CLASS_INTERNAL_ID Use with available fluent helpers to apply the ClassInternalID field to query operations.
static RecipeClassField<String>	CLASS_TYPE Use with available fluent helpers to apply the ClassType field to query operations.
static RecipeClassField<LocalDateTime>	KEY_DATE Use with available fluent helpers to apply the KeyDate field to query operations.
static RecipeClassField<UUID>	RECIPE_UUID Use with available fluent helpers to apply the RecipeUUID field to query operations.
static RecipeClassLink<RecipeClassCharc>	TO_CHARACTERISTICS Use with available fluent helpers to apply the to_Characteristics navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
RecipeClass()
RecipeClass(UUID recipeUUID, String classInternalID, LocalDateTime keyDate, String classType, List<RecipeClassCharc> toCharacteristics)

Method Summary

Modifier and Type	Method and Description
void	addCharacteristics(RecipeClassCharc... entity) Adds elements to the list of associated RecipeClassCharc entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static RecipeClass.RecipeClassBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<RecipeClassCharc>	fetchCharacteristics() Fetches the RecipeClassCharc entities (one to many) associated with this entity.
static <T> RecipeClassField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> RecipeClassField<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<List<RecipeClassCharc>>	getCharacteristicsIfPresent() Retrieval of associated RecipeClassCharc entities (one to many).
List<RecipeClassCharc>	getCharacteristicsOrFetch() Retrieval of associated RecipeClassCharc entities (one to many).
String	getClassInternalID() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getClassType() Constraints: Not nullable, Maximum length: 3
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()
LocalDateTime	getKeyDate() Constraints: Not nullable, Precision: 0
UUID	getRecipeUUID() (Key Field) Constraints: Not nullable
Class<RecipeClass>	getType()
int	hashCode()
void	setCharacteristics(List<RecipeClassCharc> value) Overwrites the list of associated RecipeClassCharc entities for the loaded navigation property to_Characteristics.
void	setClassInternalID(String classInternalID) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setClassType(String classType) Constraints: Not nullable, Maximum length: 3
void	setKeyDate(LocalDateTime keyDate) 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 RecipeClassSelectable ALL_FIELDS

Selector for all available fields of RecipeClass.

RECIPE_UUID

public static final RecipeClassField<UUID> RECIPE_UUID

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

CLASS_INTERNAL_ID

public static final RecipeClassField<String> CLASS_INTERNAL_ID

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

KEY_DATE

public static final RecipeClassField<LocalDateTime> KEY_DATE

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

CLASS_TYPE

public static final RecipeClassField<String> CLASS_TYPE

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

TO_CHARACTERISTICS

public static final RecipeClassLink<RecipeClassCharc> TO_CHARACTERISTICS

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

Constructor Detail

RecipeClass

public RecipeClass()

RecipeClass

public RecipeClass(@Nullable
                   UUID recipeUUID,
                   @Nullable
                   String classInternalID,
                   @Nullable
                   LocalDateTime keyDate,
                   @Nullable
                   String classType,
                   List<RecipeClassCharc> toCharacteristics)

Method Detail

getType

@Nonnull
public Class<RecipeClass> getType()

Specified by:

getType in class VdmObject<RecipeClass>

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

setClassInternalID

public void setClassInternalID(@Nullable
                               String classInternalID)

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

Original property name from the Odata EDM: ClassInternalID

Parameters:

classInternalID - Internal Class Number

setKeyDate

public void setKeyDate(@Nullable
                       LocalDateTime keyDate)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: KeyDate

Parameters:

keyDate - The keyDate to set.

setClassType

public void setClassType(@Nullable
                         String classType)

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: ClassType

Parameters:

classType - Uniquely identifies the class type

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<RecipeClass>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<RecipeClass>

fromMap

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

Overrides:

fromMap in class VdmObject<RecipeClass>

field

@Nonnull
public static <T> RecipeClassField<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> RecipeClassField<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<RecipeClass>

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

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

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

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

fetchCharacteristics

@Nonnull
public List<RecipeClassCharc> fetchCharacteristics()
                                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the RecipeClassCharc entities (one to many) associated with this entity. This corresponds to the OData navigation property to_Characteristics.

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

Returns:

List containing one or more associated RecipeClassCharc entities. If no entities are associated then an empty list is returned.

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.

getCharacteristicsOrFetch

@Nonnull
public List<RecipeClassCharc> getCharacteristicsOrFetch()
                                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated RecipeClassCharc entities (one to many). This corresponds to the OData navigation property to_Characteristics.

If the navigation property to_Characteristics of a queried RecipeClass 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 RecipeClassCharc entities.

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.

getCharacteristicsIfPresent

@Nonnull
public io.vavr.control.Option<List<RecipeClassCharc>> getCharacteristicsIfPresent()

Retrieval of associated RecipeClassCharc entities (one to many). This corresponds to the OData navigation property to_Characteristics.

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

setCharacteristics

public void setCharacteristics(@Nonnull
                               List<RecipeClassCharc> value)

Overwrites the list of associated RecipeClassCharc entities for the loaded navigation property to_Characteristics.

If the navigation property to_Characteristics of a queried RecipeClass 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.

Parameters:

value - List of RecipeClassCharc entities.

addCharacteristics

public void addCharacteristics(RecipeClassCharc... entity)

Adds elements to the list of associated RecipeClassCharc entities. This corresponds to the OData navigation property to_Characteristics.

If the navigation property to_Characteristics of a queried RecipeClass 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.

Parameters:

entity - Array of RecipeClassCharc entities.

builder

public static RecipeClass.RecipeClassBuilder builder()

getRecipeUUID

@Nullable
public UUID getRecipeUUID()

(Key Field) Constraints: Not nullable

Original property name from the Odata EDM: RecipeUUID

Returns:

Common Recipe GUID

getClassInternalID

@Nullable
public String getClassInternalID()

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

Original property name from the Odata EDM: ClassInternalID

Returns:

Internal Class Number

getKeyDate

@Nullable
public LocalDateTime getKeyDate()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: KeyDate

Returns:

The keyDate contained in this entity.

getClassType

@Nullable
public String getClassType()

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: ClassType

Returns:

Uniquely identifies the class type

toString

public String toString()

Overrides:

toString in class VdmObject<RecipeClass>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<RecipeClass>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<RecipeClass>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<RecipeClass>