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

Class ReturnsDeliverySrlNmbr

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customerreturnsdeliveryv2.ReturnsDeliverySrlNmbr

public class ReturnsDeliverySrlNmbr
extends VdmEntity<ReturnsDeliverySrlNmbr>

Customer Returns Dlvry Maintenance Item Object List Headers

Original entity name from the Odata EDM: A_ReturnsDeliverySrlNmbrType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ReturnsDeliverySrlNmbrSelectable	ALL_FIELDS Selector for all available fields of ReturnsDeliverySrlNmbr.
static ReturnsDeliverySrlNmbrField<LocalDateTime>	DELIVERY_DATE Use with available fluent helpers to apply the DeliveryDate field to query operations.
static ReturnsDeliverySrlNmbrField<String>	DELIVERY_DOCUMENT Use with available fluent helpers to apply the DeliveryDocument field to query operations.
static ReturnsDeliverySrlNmbrField<String>	DELIVERY_DOCUMENT_ITEM Use with available fluent helpers to apply the DeliveryDocumentItem field to query operations.
static ReturnsDeliverySrlNmbrField<Long>	MAINTENANCE_ITEM_OBJECT_LIST Use with available fluent helpers to apply the MaintenanceItemObjectList field to query operations.
static ReturnsDeliverySrlNmbrField<String>	SD_DOCUMENT_CATEGORY Use with available fluent helpers to apply the SDDocumentCategory field to query operations.
static ReturnsDeliverySrlNmbrLink<ReturnsDeliveryMaintObj>	TO_MAINTENANCE_ITEM_OBJECT Use with available fluent helpers to apply the to_MaintenanceItemObject navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
ReturnsDeliverySrlNmbr()
ReturnsDeliverySrlNmbr(LocalDateTime deliveryDate, String deliveryDocument, String deliveryDocumentItem, Long maintenanceItemObjectList, String sDDocumentCategory, List<ReturnsDeliveryMaintObj> toMaintenanceItemObject)

Method Summary

Modifier and Type	Method and Description
void	addMaintenanceItemObject(ReturnsDeliveryMaintObj... entity) Adds elements to the list of associated ReturnsDeliveryMaintObj entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static ReturnsDeliverySrlNmbr.ReturnsDeliverySrlNmbrBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<ReturnsDeliveryMaintObj>	fetchMaintenanceItemObject() Fetches the ReturnsDeliveryMaintObj entities (one to many) associated with this entity.
static <T> ReturnsDeliverySrlNmbrField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ReturnsDeliverySrlNmbrField<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.
LocalDateTime	getDeliveryDate() Constraints: Not nullable, Precision: 7
String	getDeliveryDocument() Constraints: Not nullable, Maximum length: 10
String	getDeliveryDocumentItem() Constraints: Not nullable, Maximum length: 6
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()
io.vavr.control.Option<List<ReturnsDeliveryMaintObj>>	getMaintenanceItemObjectIfPresent() Retrieval of associated ReturnsDeliveryMaintObj entities (one to many).
Long	getMaintenanceItemObjectList() (Key Field) Constraints: Not nullable
List<ReturnsDeliveryMaintObj>	getMaintenanceItemObjectOrFetch() Retrieval of associated ReturnsDeliveryMaintObj entities (one to many).
String	getSDDocumentCategory() Constraints: Not nullable, Maximum length: 4
Class<ReturnsDeliverySrlNmbr>	getType()
int	hashCode()
void	setDeliveryDate(LocalDateTime deliveryDate) Constraints: Not nullable, Precision: 7
void	setDeliveryDocument(String deliveryDocument) Constraints: Not nullable, Maximum length: 10
void	setDeliveryDocumentItem(String deliveryDocumentItem) Constraints: Not nullable, Maximum length: 6
void	setMaintenanceItemObject(List<ReturnsDeliveryMaintObj> value) Overwrites the list of associated ReturnsDeliveryMaintObj entities for the loaded navigation property to_MaintenanceItemObject.
void	setMaintenanceItemObjectList(Long maintenanceItemObjectList) (Key Field) Constraints: Not nullable
void	setSDDocumentCategory(String sDDocumentCategory) Constraints: Not nullable, Maximum length: 4
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 ReturnsDeliverySrlNmbrSelectable ALL_FIELDS

Selector for all available fields of ReturnsDeliverySrlNmbr.

DELIVERY_DATE

public static final ReturnsDeliverySrlNmbrField<LocalDateTime> DELIVERY_DATE

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

DELIVERY_DOCUMENT

public static final ReturnsDeliverySrlNmbrField<String> DELIVERY_DOCUMENT

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

DELIVERY_DOCUMENT_ITEM

public static final ReturnsDeliverySrlNmbrField<String> DELIVERY_DOCUMENT_ITEM

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

MAINTENANCE_ITEM_OBJECT_LIST

public static final ReturnsDeliverySrlNmbrField<Long> MAINTENANCE_ITEM_OBJECT_LIST

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

SD_DOCUMENT_CATEGORY

public static final ReturnsDeliverySrlNmbrField<String> SD_DOCUMENT_CATEGORY

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

TO_MAINTENANCE_ITEM_OBJECT

public static final ReturnsDeliverySrlNmbrLink<ReturnsDeliveryMaintObj> TO_MAINTENANCE_ITEM_OBJECT

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

Constructor Detail

ReturnsDeliverySrlNmbr

public ReturnsDeliverySrlNmbr()

ReturnsDeliverySrlNmbr

public ReturnsDeliverySrlNmbr(@Nullable
                              LocalDateTime deliveryDate,
                              @Nullable
                              String deliveryDocument,
                              @Nullable
                              String deliveryDocumentItem,
                              @Nullable
                              Long maintenanceItemObjectList,
                              @Nullable
                              String sDDocumentCategory,
                              List<ReturnsDeliveryMaintObj> toMaintenanceItemObject)

Method Detail

getType

@Nonnull
public Class<ReturnsDeliverySrlNmbr> getType()

Specified by:

getType in class VdmObject<ReturnsDeliverySrlNmbr>

Returns:

The class of this object.

setDeliveryDate

public void setDeliveryDate(@Nullable
                            LocalDateTime deliveryDate)

Constraints: Not nullable, Precision: 7

Original property name from the Odata EDM: DeliveryDate

Date in the form YYYYMMDD (where Y = year, M = month, D = day)19920301

Parameters:

deliveryDate - Date (YYYYMMDD)

setDeliveryDocument

public void setDeliveryDocument(@Nullable
                                String deliveryDocument)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: DeliveryDocument

Parameters:

deliveryDocument - The number that uniquely identifies the delivery.

setDeliveryDocumentItem

public void setDeliveryDocumentItem(@Nullable
                                    String deliveryDocumentItem)

Constraints: Not nullable, Maximum length: 6

Original property name from the Odata EDM: DeliveryDocumentItem

Parameters:

deliveryDocumentItem - The number that uniquely identifies the item in a delivery.

setMaintenanceItemObjectList

public void setMaintenanceItemObjectList(@Nullable
                                         Long maintenanceItemObjectList)

(Key Field) Constraints: Not nullable

Original property name from the Odata EDM: MaintenanceItemObjectList

Parameters:

maintenanceItemObjectList - Number identifying the object list

setSDDocumentCategory

public void setSDDocumentCategory(@Nullable
                                  String sDDocumentCategory)

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: SDDocumentCategory

The document category determines how the system stores and keeps track of document data. It enables the system to provide you with status information about delivery processing, billing, and documents that are used for reference (for example, inquiries and quotations).

Parameters:

sDDocumentCategory - A classification for the different types of documents that you can process, for example, quotations, sales orders, deliveries, and invoices.

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<ReturnsDeliverySrlNmbr>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ReturnsDeliverySrlNmbr>

fromMap

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

Overrides:

fromMap in class VdmObject<ReturnsDeliverySrlNmbr>

field

@Nonnull
public static <T> ReturnsDeliverySrlNmbrField<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> ReturnsDeliverySrlNmbrField<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<ReturnsDeliverySrlNmbr>

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

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

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

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

fetchMaintenanceItemObject

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

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

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

Returns:

List containing one or more associated ReturnsDeliveryMaintObj 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.

getMaintenanceItemObjectOrFetch

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

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

If the navigation property to_MaintenanceItemObject of a queried ReturnsDeliverySrlNmbr 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 ReturnsDeliveryMaintObj 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.

getMaintenanceItemObjectIfPresent

@Nonnull
public io.vavr.control.Option<List<ReturnsDeliveryMaintObj>> getMaintenanceItemObjectIfPresent()

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

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

setMaintenanceItemObject

public void setMaintenanceItemObject(@Nonnull
                                     List<ReturnsDeliveryMaintObj> value)

Overwrites the list of associated ReturnsDeliveryMaintObj entities for the loaded navigation property to_MaintenanceItemObject.

If the navigation property to_MaintenanceItemObject of a queried ReturnsDeliverySrlNmbr 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 ReturnsDeliveryMaintObj entities.

addMaintenanceItemObject

public void addMaintenanceItemObject(ReturnsDeliveryMaintObj... entity)

Adds elements to the list of associated ReturnsDeliveryMaintObj entities. This corresponds to the OData navigation property to_MaintenanceItemObject.

If the navigation property to_MaintenanceItemObject of a queried ReturnsDeliverySrlNmbr 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 ReturnsDeliveryMaintObj entities.

builder

@Nonnull
public static ReturnsDeliverySrlNmbr.ReturnsDeliverySrlNmbrBuilder builder()

getDeliveryDate

@Nullable
public LocalDateTime getDeliveryDate()

Constraints: Not nullable, Precision: 7

Original property name from the Odata EDM: DeliveryDate

Date in the form YYYYMMDD (where Y = year, M = month, D = day)19920301

Returns:

Date (YYYYMMDD)

getDeliveryDocument

@Nullable
public String getDeliveryDocument()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: DeliveryDocument

Returns:

The number that uniquely identifies the delivery.

getDeliveryDocumentItem

@Nullable
public String getDeliveryDocumentItem()

Constraints: Not nullable, Maximum length: 6

Original property name from the Odata EDM: DeliveryDocumentItem

Returns:

The number that uniquely identifies the item in a delivery.

getMaintenanceItemObjectList

@Nullable
public Long getMaintenanceItemObjectList()

(Key Field) Constraints: Not nullable

Original property name from the Odata EDM: MaintenanceItemObjectList

Returns:

Number identifying the object list

getSDDocumentCategory

@Nullable
public String getSDDocumentCategory()

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: SDDocumentCategory

The document category determines how the system stores and keeps track of document data. It enables the system to provide you with status information about delivery processing, billing, and documents that are used for reference (for example, inquiries and quotations).

Returns:

A classification for the different types of documents that you can process, for example, quotations, sales orders, deliveries, and invoices.

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<ReturnsDeliverySrlNmbr>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<ReturnsDeliverySrlNmbr>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<ReturnsDeliverySrlNmbr>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ReturnsDeliverySrlNmbr>