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

Class KanbanDelivery

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.kanbancontrolcycle.KanbanDelivery

public class KanbanDelivery
extends VdmEntity<KanbanDelivery>

Kanban Delivery

Original entity name from the Odata EDM: A_KanbanDeliveryType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KanbanDelivery.KanbanDeliveryBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static KanbanDeliverySelectable	ALL_FIELDS Selector for all available fields of KanbanDelivery.
static KanbanDeliveryField<String>	CUSTOMER_REFERENCE_NUMBER Use with available fluent helpers to apply the CustomerReferenceNumber field to query operations.
static KanbanDeliveryField<String>	DELIVERY_DOCUMENT Use with available fluent helpers to apply the DeliveryDocument field to query operations.
static KanbanDeliveryField<String>	KANBAN_CONTAINER Use with available fluent helpers to apply the KanbanContainer field to query operations.
static KanbanDeliveryField<String>	KANBAN_CONTROL_CYCLE Use with available fluent helpers to apply the KanbanControlCycle field to query operations.
static KanbanDeliveryField<ZonedDateTime>	LAST_CHANGE_DATE_TIME Use with available fluent helpers to apply the LastChangeDateTime field to query operations.
static KanbanDeliveryField<String>	PLANT Use with available fluent helpers to apply the Plant field to query operations.
static KanbanDeliveryField<String>	SOLD_TO_PARTY Use with available fluent helpers to apply the SoldToParty field to query operations.
static KanbanDeliveryLink<KanbanContainer>	TO_KANBAN_CONTAINER Use with available fluent helpers to apply the to_KanbanContainer navigation property to query operations.
static KanbanDeliveryLink<KanbanControlCycle>	TO_KANBAN_CONTROL_CYCLE Use with available fluent helpers to apply the to_KanbanControlCycle navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
KanbanDelivery()
KanbanDelivery(String kanbanContainer, String soldToParty, String customerReferenceNumber, String deliveryDocument, String plant, ZonedDateTime lastChangeDateTime, String kanbanControlCycle, ErpConfigContext erpConfigContext, KanbanContainer toKanbanContainer, KanbanControlCycle toKanbanControlCycle)

Method Summary

Modifier and Type	Method and Description
static KanbanDelivery.KanbanDeliveryBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
KanbanContainer	fetchKanbanContainer() Fetches the KanbanContainer entity (one to one) associated with this entity.
KanbanControlCycle	fetchKanbanControlCycle() Fetches the KanbanControlCycle entity (one to one) associated with this entity.
static <T> KanbanDeliveryField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> KanbanDeliveryField<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	getCustomerReferenceNumber() Constraints: Not nullable, Maximum length: 35
String	getDeliveryDocument() Constraints: Not nullable, Maximum length: 10
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
String	getKanbanContainer() (Key Field) Constraints: Not nullable, Maximum length: 10
Optional<KanbanContainer>	getKanbanContainerIfPresent() Retrieval of associated KanbanContainer entity (one to one).
KanbanContainer	getKanbanContainerOrFetch() Retrieval of associated KanbanContainer entity (one to one).
String	getKanbanControlCycle() Constraints: Not nullable, Maximum length: 7
Optional<KanbanControlCycle>	getKanbanControlCycleIfPresent() Retrieval of associated KanbanControlCycle entity (one to one).
KanbanControlCycle	getKanbanControlCycleOrFetch() Retrieval of associated KanbanControlCycle entity (one to one).
protected Map<String,Object>	getKey()
ZonedDateTime	getLastChangeDateTime() Constraints: Not nullable, Precision: 7
String	getPlant() Constraints: Not nullable, Maximum length: 4
String	getSoldToParty() Constraints: Not nullable, Maximum length: 10
Class<KanbanDelivery>	getType()
int	hashCode()
void	setCustomerReferenceNumber(String customerReferenceNumber) Constraints: Not nullable, Maximum length: 35
void	setDeliveryDocument(String deliveryDocument) Constraints: Not nullable, Maximum length: 10
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setKanbanContainer(KanbanContainer value) Overwrites the associated KanbanContainer entity for the loaded navigation property to_KanbanContainer.
void	setKanbanContainer(String kanbanContainer) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setKanbanControlCycle(KanbanControlCycle value) Overwrites the associated KanbanControlCycle entity for the loaded navigation property to_KanbanControlCycle.
void	setKanbanControlCycle(String kanbanControlCycle) Constraints: Not nullable, Maximum length: 7
void	setLastChangeDateTime(ZonedDateTime lastChangeDateTime) Constraints: Not nullable, Precision: 7
void	setPlant(String plant) Constraints: Not nullable, Maximum length: 4
void	setSoldToParty(String soldToParty) Constraints: Not nullable, Maximum length: 10
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

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

getEndpointUrl, getServicePathForFetch, getVersionIdentifier, setServicePathForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.s4hana.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 KanbanDeliverySelectable ALL_FIELDS

Selector for all available fields of KanbanDelivery.

KANBAN_CONTAINER

public static final KanbanDeliveryField<String> KANBAN_CONTAINER

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

SOLD_TO_PARTY

public static final KanbanDeliveryField<String> SOLD_TO_PARTY

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

CUSTOMER_REFERENCE_NUMBER

public static final KanbanDeliveryField<String> CUSTOMER_REFERENCE_NUMBER

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

DELIVERY_DOCUMENT

public static final KanbanDeliveryField<String> DELIVERY_DOCUMENT

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

PLANT

public static final KanbanDeliveryField<String> PLANT

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

LAST_CHANGE_DATE_TIME

public static final KanbanDeliveryField<ZonedDateTime> LAST_CHANGE_DATE_TIME

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

KANBAN_CONTROL_CYCLE

public static final KanbanDeliveryField<String> KANBAN_CONTROL_CYCLE

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

TO_KANBAN_CONTAINER

public static final KanbanDeliveryLink<KanbanContainer> TO_KANBAN_CONTAINER

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

TO_KANBAN_CONTROL_CYCLE

public static final KanbanDeliveryLink<KanbanControlCycle> TO_KANBAN_CONTROL_CYCLE

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

Constructor Detail

KanbanDelivery

public KanbanDelivery()

KanbanDelivery

public KanbanDelivery(@Nullable
                      String kanbanContainer,
                      @Nullable
                      String soldToParty,
                      @Nullable
                      String customerReferenceNumber,
                      @Nullable
                      String deliveryDocument,
                      @Nullable
                      String plant,
                      @Nullable
                      ZonedDateTime lastChangeDateTime,
                      @Nullable
                      String kanbanControlCycle,
                      @Nullable
                      ErpConfigContext erpConfigContext,
                      @Nullable
                      KanbanContainer toKanbanContainer,
                      @Nullable
                      KanbanControlCycle toKanbanControlCycle)

Method Detail

getType

@Nonnull
public Class<KanbanDelivery> getType()

Specified by:

getType in class VdmObject<KanbanDelivery>

Returns:

The class of this object.

setKanbanContainer

public void setKanbanContainer(@Nullable
                               String kanbanContainer)

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

Original property name from the Odata EDM: KanbanContainer

Additional information for Kanban ID numbersEvery kanban is given a number, which is valid across the control cycle from a number range for kanban ID numbers.If you work with barcodes, the first ten figures of the barcode consist of the Kanban number.

Parameters:

kanbanContainer - Determines the Kanban number.

setSoldToParty

public void setSoldToParty(@Nullable
                           String soldToParty)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: SoldToParty

Parameters:

soldToParty - The customer who orders the goods or services. The sold-to party is contractually responsible for sales orders.

setCustomerReferenceNumber

public void setCustomerReferenceNumber(@Nullable
                                       String customerReferenceNumber)

Constraints: Not nullable, Maximum length: 35

Original property name from the Odata EDM: CustomerReferenceNumber

The number creates the link between the customer purchase order and the sales document that you create. You can use the number used by the customer during correspondence with the customer to find certain document information. If the number refers to a purchase order, you can also print it on the documents that you send to the customer (e.g. on the delivery note).

Parameters:

customerReferenceNumber - Number that the customer uses to uniquely identify a purchasing document (e.g. an inquiry or a purchase order).

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.

setPlant

public void setPlant(@Nullable
                     String plant)

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: Plant

Parameters:

plant - Key uniquely identifying a plant.

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

setKanbanControlCycle

public void setKanbanControlCycle(@Nullable
                                  String kanbanControlCycle)

Constraints: Not nullable, Maximum length: 7

Original property name from the Odata EDM: KanbanControlCycle

The following data is defined and linked in the kanban control cycle used in Kanban and JIT Outbound processing:Production supply areaMaterialNumber of kanbans or containers and the kanban quantity or call-off quantityReplenishment strategiesIf necessary, the source of replenishment depending on the replenishment strategy

Parameters:

kanbanControlCycle - Number, that specifically identifies the control cycle.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<KanbanDelivery>

getKey

protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<KanbanDelivery>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<KanbanDelivery>

fromMap

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

Overrides:

fromMap in class VdmObject<KanbanDelivery>

field

@Nonnull
public static <T> KanbanDeliveryField<T> field(@Nonnull
                                                        String fieldName,
                                                        @Nonnull
                                                        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.

field

@Nonnull
public static <T,DomainT> KanbanDeliveryField<T> field(@Nonnull
                                                                String fieldName,
                                                                @Nonnull
                                                                TypeConverter<T,DomainT> typeConverter)

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

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.

toMapOfNavigationProperties

protected Map<String,Object> toMapOfNavigationProperties()

Overrides:

toMapOfNavigationProperties in class VdmObject<KanbanDelivery>

fetchKanbanContainer

@Nullable
public KanbanContainer fetchKanbanContainer()
                                               throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getKanbanContainerOrFetch

@Nullable
public KanbanContainer getKanbanContainerOrFetch()
                                                    throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated KanbanContainer entity (one to one). This corresponds to the OData navigation property to_KanbanContainer.

If the navigation property to_KanbanContainer of a queried KanbanDelivery 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 KanbanContainer 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.

getKanbanContainerIfPresent

@Nonnull
public Optional<KanbanContainer> getKanbanContainerIfPresent()

Retrieval of associated KanbanContainer entity (one to one). This corresponds to the OData navigation property to_KanbanContainer.

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

Returns:

If the information for navigation property to_KanbanContainer is already loaded, the result will contain the KanbanContainer entity. If not, an Optional with result state empty is returned.

setKanbanContainer

public void setKanbanContainer(KanbanContainer value)

Overwrites the associated KanbanContainer entity for the loaded navigation property to_KanbanContainer.

Parameters:

value - New KanbanContainer entity.

fetchKanbanControlCycle

@Nullable
public KanbanControlCycle fetchKanbanControlCycle()
                                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getKanbanControlCycleOrFetch

@Nullable
public KanbanControlCycle getKanbanControlCycleOrFetch()
                                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated KanbanControlCycle entity (one to one). This corresponds to the OData navigation property to_KanbanControlCycle.

If the navigation property to_KanbanControlCycle of a queried KanbanDelivery 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 KanbanControlCycle 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.

getKanbanControlCycleIfPresent

@Nonnull
public Optional<KanbanControlCycle> getKanbanControlCycleIfPresent()

Retrieval of associated KanbanControlCycle entity (one to one). This corresponds to the OData navigation property to_KanbanControlCycle.

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

Returns:

If the information for navigation property to_KanbanControlCycle is already loaded, the result will contain the KanbanControlCycle entity. If not, an Optional with result state empty is returned.

setKanbanControlCycle

public void setKanbanControlCycle(KanbanControlCycle value)

Overwrites the associated KanbanControlCycle entity for the loaded navigation property to_KanbanControlCycle.

Parameters:

value - New KanbanControlCycle entity.

builder

public static KanbanDelivery.KanbanDeliveryBuilder builder()

getKanbanContainer

@Nullable
public String getKanbanContainer()

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

Original property name from the Odata EDM: KanbanContainer

Additional information for Kanban ID numbersEvery kanban is given a number, which is valid across the control cycle from a number range for kanban ID numbers.If you work with barcodes, the first ten figures of the barcode consist of the Kanban number.

Returns:

Determines the Kanban number.

getSoldToParty

@Nullable
public String getSoldToParty()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: SoldToParty

Returns:

The customer who orders the goods or services. The sold-to party is contractually responsible for sales orders.

getCustomerReferenceNumber

@Nullable
public String getCustomerReferenceNumber()

Constraints: Not nullable, Maximum length: 35

Original property name from the Odata EDM: CustomerReferenceNumber

The number creates the link between the customer purchase order and the sales document that you create. You can use the number used by the customer during correspondence with the customer to find certain document information. If the number refers to a purchase order, you can also print it on the documents that you send to the customer (e.g. on the delivery note).

Returns:

Number that the customer uses to uniquely identify a purchasing document (e.g. an inquiry or a purchase order).

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.

getPlant

@Nullable
public String getPlant()

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: Plant

Returns:

Key uniquely identifying a plant.

getLastChangeDateTime

@Nullable
public ZonedDateTime getLastChangeDateTime()

Constraints: Not nullable, Precision: 7

Original property name from the Odata EDM: LastChangeDateTime

Returns:

Last Change Timestamp

getKanbanControlCycle

@Nullable
public String getKanbanControlCycle()

Constraints: Not nullable, Maximum length: 7

Original property name from the Odata EDM: KanbanControlCycle

The following data is defined and linked in the kanban control cycle used in Kanban and JIT Outbound processing:Production supply areaMaterialNumber of kanbans or containers and the kanban quantity or call-off quantityReplenishment strategiesIf necessary, the source of replenishment depending on the replenishment strategy

Returns:

Number, that specifically identifies the control cycle.

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.

setErpConfigContext

public void setErpConfigContext(@Nullable
                                ErpConfigContext erpConfigContext)

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

Overrides:

setErpConfigContext in class VdmEntity<KanbanDelivery>

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<KanbanDelivery>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<KanbanDelivery>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<KanbanDelivery>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<KanbanDelivery>