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

Class BatchClass

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.batch.BatchClass

public class BatchClass
extends VdmEntity<BatchClass>

API for Batch Class

Original entity name from the Odata EDM: BatchClassType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static BatchClassSelectable	ALL_FIELDS Selector for all available fields of BatchClass.
static BatchClassField<String>	BATCH Use with available fluent helpers to apply the Batch field to query operations.
static BatchClassField<String>	BATCH_IDENTIFYING_PLANT Use with available fluent helpers to apply the BatchIdentifyingPlant field to query operations.
static BatchClassField<String>	CLASS_INTERNAL_ID Use with available fluent helpers to apply the ClassInternalID field to query operations.
static BatchClassField<ZonedDateTime>	LAST_CHANGE_DATE_TIME Use with available fluent helpers to apply the LastChangeDateTime field to query operations.
static BatchClassField<String>	MATERIAL Use with available fluent helpers to apply the Material field to query operations.
static BatchClassOneToOneLink<Batch>	TO_BATCH Use with available fluent helpers to apply the to_Batch navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
BatchClass()
BatchClass(String material, String batchIdentifyingPlant, String batch, String classInternalID, ZonedDateTime lastChangeDateTime, Batch toBatch)

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 BatchClass.BatchClassBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Batch	fetchBatch() Fetches the Batch entity (one to one) associated with this entity.
static <T> BatchClassField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> BatchClassField<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	getBatch() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getBatchIdentifyingPlant() (Key Field) Constraints: Not nullable, Maximum length: 4
io.vavr.control.Option<Batch>	getBatchIfPresent() Retrieval of associated Batch entity (one to one).
Batch	getBatchOrFetch() Retrieval of associated Batch entity (one to one).
String	getClassInternalID() Constraints: Not nullable, Maximum length: 10
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()
ZonedDateTime	getLastChangeDateTime() Constraints: Not nullable, Precision: 7
String	getMaterial() (Key Field) Constraints: Not nullable, Maximum length: 18
Class<BatchClass>	getType()
int	hashCode()
void	setBatch(Batch value) Overwrites the associated Batch entity for the loaded navigation property to_Batch.
void	setBatch(String batch) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setBatchIdentifyingPlant(String batchIdentifyingPlant) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setClassInternalID(String classInternalID) Constraints: Not nullable, Maximum length: 10
void	setLastChangeDateTime(ZonedDateTime lastChangeDateTime) Constraints: Not nullable, Precision: 7
void	setMaterial(String material) (Key Field) Constraints: Not nullable, Maximum length: 18
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 BatchClassSelectable ALL_FIELDS

Selector for all available fields of BatchClass.

MATERIAL

public static final BatchClassField<String> MATERIAL

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

BATCH_IDENTIFYING_PLANT

public static final BatchClassField<String> BATCH_IDENTIFYING_PLANT

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

BATCH

public static final BatchClassField<String> BATCH

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

CLASS_INTERNAL_ID

public static final BatchClassField<String> CLASS_INTERNAL_ID

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

LAST_CHANGE_DATE_TIME

public static final BatchClassField<ZonedDateTime> LAST_CHANGE_DATE_TIME

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

TO_BATCH

public static final BatchClassOneToOneLink<Batch> TO_BATCH

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

Constructor Detail

BatchClass

public BatchClass()

BatchClass

public BatchClass(@Nullable
                  String material,
                  @Nullable
                  String batchIdentifyingPlant,
                  @Nullable
                  String batch,
                  @Nullable
                  String classInternalID,
                  @Nullable
                  ZonedDateTime lastChangeDateTime,
                  @Nullable
                  Batch toBatch)

Method Detail

getType

@Nonnull
public Class<BatchClass> getType()

Specified by:

getType in class VdmObject<BatchClass>

Returns:

The class of this object.

setMaterial

public void setMaterial(@Nullable
                        String material)

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

Original property name from the Odata EDM: Material

Parameters:

material - Alphanumeric key uniquely identifying the material.

setBatchIdentifyingPlant

public void setBatchIdentifyingPlant(@Nullable
                                     String batchIdentifyingPlant)

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

Original property name from the Odata EDM: BatchIdentifyingPlant

Parameters:

batchIdentifyingPlant - Key uniquely identifying a plant.

setBatch

public void setBatch(@Nullable
                     String batch)

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

Original property name from the Odata EDM: Batch

Parameters:

batch - Assigns a material that is manufactured in batches or production lots to a specific batch.

setClassInternalID

public void setClassInternalID(@Nullable
                               String classInternalID)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: ClassInternalID

Parameters:

classInternalID - Internal Class Number

setLastChangeDateTime

public void setLastChangeDateTime(@Nullable
                                  ZonedDateTime lastChangeDateTime)

Constraints: Not nullable, Precision: 7

Original property name from the Odata EDM: LastChangeDateTime

Parameters:

lastChangeDateTime - Last Change Timestamp

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<BatchClass>

getKey

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

Overrides:

getKey in class VdmObject<BatchClass>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<BatchClass>

fromMap

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

Overrides:

fromMap in class VdmObject<BatchClass>

field

@Nonnull
public static <T> BatchClassField<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> BatchClassField<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<BatchClass>

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

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

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

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<BatchClass>

fetchBatch

@Nullable
public Batch fetchBatch()
                           throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getBatchOrFetch

@Nullable
public Batch getBatchOrFetch()
                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated Batch entity (one to one). This corresponds to the OData navigation property to_Batch.

If the navigation property to_Batch of a queried BatchClass 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 Batch 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.

getBatchIfPresent

@Nonnull
public io.vavr.control.Option<Batch> getBatchIfPresent()

Retrieval of associated Batch entity (one to one). This corresponds to the OData navigation property to_Batch.

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

setBatch

public void setBatch(Batch value)

Overwrites the associated Batch entity for the loaded navigation property to_Batch.

Parameters:

value - New Batch entity.

builder

public static BatchClass.BatchClassBuilder builder()

getMaterial

@Nullable
public String getMaterial()

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

Original property name from the Odata EDM: Material

Returns:

Alphanumeric key uniquely identifying the material.

getBatchIdentifyingPlant

@Nullable
public String getBatchIdentifyingPlant()

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

Original property name from the Odata EDM: BatchIdentifyingPlant

Returns:

Key uniquely identifying a plant.

getBatch

@Nullable
public String getBatch()

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

Original property name from the Odata EDM: Batch

Returns:

Assigns a material that is manufactured in batches or production lots to a specific batch.

getClassInternalID

@Nullable
public String getClassInternalID()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: ClassInternalID

Returns:

Internal Class Number

getLastChangeDateTime

@Nullable
public ZonedDateTime getLastChangeDateTime()

Constraints: Not nullable, Precision: 7

Original property name from the Odata EDM: LastChangeDateTime

Returns:

Last Change Timestamp

toString

public String toString()

Overrides:

toString in class VdmObject<BatchClass>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<BatchClass>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<BatchClass>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BatchClass>