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

Class ReturnsDeliverySrlNmbr

java.lang.Object

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

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

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

public class ReturnsDeliverySrlNmbr
extends VdmEntity<ReturnsDeliverySrlNmbr>

A_ReturnsDeliverySrlNmbrType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReturnsDeliverySrlNmbr.ReturnsDeliverySrlNmbrBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static ReturnsDeliverySrlNmbrSelectable	ALL_FIELDS Selector for all available fields of ReturnsDeliverySrlNmbr.
static ReturnsDeliverySrlNmbrField<Calendar>	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<Integer>	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.

Constructor Summary

Constructors

Constructor and Description
ReturnsDeliverySrlNmbr()
ReturnsDeliverySrlNmbr(Calendar deliveryDate, String deliveryDocument, String deliveryDocumentItem, Integer maintenanceItemObjectList, String sDDocumentCategory, ErpConfigContext erpConfigContext, List<ReturnsDeliveryMaintObj> toMaintenanceItemObject)

Method Summary

Modifier and Type	Method and Description
void	addMaintenanceItemObject(ReturnsDeliveryMaintObj... entity) Adds elements to the list of associated ReturnsDeliveryMaintObj entities.
static ReturnsDeliverySrlNmbr.ReturnsDeliverySrlNmbrBuilder	builder()
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.
Calendar	getDeliveryDate() Constraints: Not nullable, Precision: 7 Date in the form YYYYMMDD (where Y = year, M = month, D = day)19920301
String	getDeliveryDocument() Constraints: Not nullable, Maximum length: 10
String	getDeliveryDocumentItem() Constraints: Not nullable, Maximum length: 6
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
Integer	getMaintenanceItemObjectList() (Key Field) Constraints: Not nullable
List<ReturnsDeliveryMaintObj>	getMaintenanceItemObjectOrFetch() Retrieval of associated ReturnsDeliveryMaintObj entities (one to many).
com.google.common.base.Optional<List<ReturnsDeliveryMaintObj>>	getMaintenanceItemObjectOrNull() Retrieval of associated ReturnsDeliveryMaintObj entities (one to many).
String	getSDDocumentCategory() Constraints: Not nullable, Maximum length: 4 The document category determines how the system stores and keeps track of document data.
Class<ReturnsDeliverySrlNmbr>	getType()
int	hashCode()
void	setDeliveryDate(Calendar deliveryDate) Constraints: Not nullable, Precision: 7 Date in the form YYYYMMDD (where Y = year, M = month, D = day)19920301
void	setDeliveryDocument(String deliveryDocument) Constraints: Not nullable, Maximum length: 10
void	setDeliveryDocumentItem(String deliveryDocumentItem) Constraints: Not nullable, Maximum length: 6
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
void	setMaintenanceItemObject(List<ReturnsDeliveryMaintObj> value) Overwrites the list of associated ReturnsDeliveryMaintObj entities for the loaded navigation property to_MaintenanceItemObject.
void	setMaintenanceItemObjectList(Integer maintenanceItemObjectList) (Key Field) Constraints: Not nullable
void	setSDDocumentCategory(String sDDocumentCategory) Constraints: Not nullable, Maximum length: 4 The document category determines how the system stores and keeps track of document data.
String	toString()

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

getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object

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<Calendar> 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<Integer> 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
                              Calendar deliveryDate,
                              @Nullable
                              String deliveryDocument,
                              @Nullable
                              String deliveryDocumentItem,
                              @Nullable
                              Integer maintenanceItemObjectList,
                              @Nullable
                              String sDDocumentCategory,
                              @Nullable
                              ErpConfigContext erpConfigContext,
                              List<ReturnsDeliveryMaintObj> toMaintenanceItemObject)

Method Detail

getType

public Class<ReturnsDeliverySrlNmbr> getType()

Specified by:

getType in class VdmObject<ReturnsDeliverySrlNmbr>

Returns:

The class of this object.

field

public static <T> ReturnsDeliverySrlNmbrField<T> field(String fieldName,
                                                       Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

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.

fetchMaintenanceItemObject

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

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

Retrieval of associated ReturnsDeliveryMaintObj entities (one to many).

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.

getMaintenanceItemObjectOrNull

public com.google.common.base.Optional<List<ReturnsDeliveryMaintObj>> getMaintenanceItemObjectOrNull()

Retrieval of associated ReturnsDeliveryMaintObj entities (one to many).

If the navigation property to_MaintenanceItemObject for an entity ReturnsDeliverySrlNmbr has not been resolved yet, this method will not query further information. Instead its Optional result state will be null.

Returns:

If the information for navigation property to_MaintenanceItemObject is already loaded, the result will contain the ReturnsDeliveryMaintObj entities. If not, a null value state 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.

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

public static ReturnsDeliverySrlNmbr.ReturnsDeliverySrlNmbrBuilder builder()

getDeliveryDate

@Nullable
public Calendar getDeliveryDate()

Constraints: Not nullable, Precision: 7

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

Returns:

The number that uniquely identifies the delivery.

getDeliveryDocumentItem

@Nullable
public String getDeliveryDocumentItem()

Constraints: Not nullable, Maximum length: 6

Returns:

The number that uniquely identifies the item in a delivery.

getMaintenanceItemObjectList

@Nullable
public Integer getMaintenanceItemObjectList()

(Key Field) Constraints: Not nullable

Returns:

Number identifying the object list

getSDDocumentCategory

@Nullable
public String getSDDocumentCategory()

Constraints: Not nullable, Maximum length: 4

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 in the sales and distribution system (for example: quotations, sales orders, deliveries, and invoices).

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setDeliveryDate

public void setDeliveryDate(@Nullable
                            Calendar deliveryDate)

Constraints: Not nullable, Precision: 7

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

Parameters:

deliveryDate -

setDeliveryDocument

public void setDeliveryDocument(@Nullable
                                String deliveryDocument)

Constraints: Not nullable, Maximum length: 10

Parameters:

deliveryDocument -

setDeliveryDocumentItem

public void setDeliveryDocumentItem(@Nullable
                                    String deliveryDocumentItem)

Constraints: Not nullable, Maximum length: 6

Parameters:

deliveryDocumentItem -

setMaintenanceItemObjectList

public void setMaintenanceItemObjectList(@Nullable
                                         Integer maintenanceItemObjectList)

(Key Field) Constraints: Not nullable

Parameters:

maintenanceItemObjectList -

setSDDocumentCategory

public void setSDDocumentCategory(@Nullable
                                  String sDDocumentCategory)

Constraints: Not nullable, Maximum length: 4

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 -

setErpConfigContext

public void setErpConfigContext(@Nullable
                                ErpConfigContext erpConfigContext)

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<ReturnsDeliverySrlNmbr>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<ReturnsDeliverySrlNmbr>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ReturnsDeliverySrlNmbr>