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

Class OutbDeliveryDocFlow

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readcreateupdateanddeleteoutbounddeliveries.OutbDeliveryDocFlow

public class OutbDeliveryDocFlow
extends VdmEntity<OutbDeliveryDocFlow>

A_OutbDeliveryDocFlowType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OutbDeliveryDocFlow.OutbDeliveryDocFlowBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static EntityFieldAll<OutbDeliveryDocFlow>	ALL_FIELDS Selector for all available fields of OutbDeliveryDocFlow.
static OutbDeliveryDocFlowField<String>	DELIVERYVERSION Use with available fluent helpers to apply the Deliveryversion field to query operations.
static OutbDeliveryDocFlowField<String>	PRECEDING_DOCUMENT Use with available fluent helpers to apply the PrecedingDocument field to query operations.
static OutbDeliveryDocFlowField<String>	PRECEDING_DOCUMENT_CATEGORY Use with available fluent helpers to apply the PrecedingDocumentCategory field to query operations.
static OutbDeliveryDocFlowField<String>	PRECEDING_DOCUMENT_ITEM Use with available fluent helpers to apply the PrecedingDocumentItem field to query operations.
static OutbDeliveryDocFlowField<BigDecimal>	QUANTITY_IN_BASE_UNIT Use with available fluent helpers to apply the QuantityInBaseUnit field to query operations.
static OutbDeliveryDocFlowField<String>	SD_FULFILLMENT_CALCULATION_RULE Use with available fluent helpers to apply the SDFulfillmentCalculationRule field to query operations.
static OutbDeliveryDocFlowField<String>	SUBSEQUENT_DOCUMENT_CATEGORY Use with available fluent helpers to apply the SubsequentDocumentCategory field to query operations.
static OutbDeliveryDocFlowField<String>	SUBSEQUENT_DOCUMENT_ITEM Use with available fluent helpers to apply the SubsequentDocumentItem field to query operations.
static OutbDeliveryDocFlowField<String>	SUBSEQUENTDOCUMENT Use with available fluent helpers to apply the Subsequentdocument field to query operations.
static OutbDeliveryDocFlowField<Boolean>	TRANSFER_ORDER_IN_WRHS_MGMT_IS_CONFD Use with available fluent helpers to apply the TransferOrderInWrhsMgmtIsConfd field to query operations.

Constructor Summary

Constructors

Constructor and Description
OutbDeliveryDocFlow()
OutbDeliveryDocFlow(String deliveryversion, String precedingDocument, String precedingDocumentCategory, String precedingDocumentItem, String subsequentdocument, BigDecimal quantityInBaseUnit, String subsequentDocumentItem, String sDFulfillmentCalculationRule, String subsequentDocumentCategory, Boolean transferOrderInWrhsMgmtIsConfd, ErpConfigContext erpConfigContext)

Method Summary

Modifier and Type	Method and Description
static OutbDeliveryDocFlow.OutbDeliveryDocFlowBuilder	builder()
boolean	equals(Object o)
static <T> OutbDeliveryDocFlowField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getDeliveryversion() Constraints: Not nullable, Maximum length: 4
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
String	getPrecedingDocument() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getPrecedingDocumentCategory() Constraints: Not nullable, Maximum length: 4
String	getPrecedingDocumentItem() (Key Field) Constraints: Not nullable, Maximum length: 6
BigDecimal	getQuantityInBaseUnit() Constraints: Not nullable, Precision: 15, Scale: 3
String	getSDFulfillmentCalculationRule() Constraints: Not nullable, Maximum length: 1
String	getSubsequentdocument() Constraints: Not nullable, Maximum length: 10
String	getSubsequentDocumentCategory() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getSubsequentDocumentItem() Constraints: Not nullable, Maximum length: 6
Boolean	getTransferOrderInWrhsMgmtIsConfd() Constraints: none
Class<OutbDeliveryDocFlow>	getType()
int	hashCode()
void	setDeliveryversion(String deliveryversion) Constraints: Not nullable, Maximum length: 4
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setPrecedingDocument(String precedingDocument) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setPrecedingDocumentCategory(String precedingDocumentCategory) Constraints: Not nullable, Maximum length: 4
void	setPrecedingDocumentItem(String precedingDocumentItem) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setQuantityInBaseUnit(BigDecimal quantityInBaseUnit) Constraints: Not nullable, Precision: 15, Scale: 3
void	setSDFulfillmentCalculationRule(String sDFulfillmentCalculationRule) Constraints: Not nullable, Maximum length: 1
void	setSubsequentdocument(String subsequentdocument) Constraints: Not nullable, Maximum length: 10
void	setSubsequentDocumentCategory(String subsequentDocumentCategory) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setSubsequentDocumentItem(String subsequentDocumentItem) Constraints: Not nullable, Maximum length: 6
void	setTransferOrderInWrhsMgmtIsConfd(Boolean transferOrderInWrhsMgmtIsConfd) Constraints: none
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 EntityFieldAll<OutbDeliveryDocFlow> ALL_FIELDS

Selector for all available fields of OutbDeliveryDocFlow.

DELIVERYVERSION

public static final OutbDeliveryDocFlowField<String> DELIVERYVERSION

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

PRECEDING_DOCUMENT

public static final OutbDeliveryDocFlowField<String> PRECEDING_DOCUMENT

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

PRECEDING_DOCUMENT_CATEGORY

public static final OutbDeliveryDocFlowField<String> PRECEDING_DOCUMENT_CATEGORY

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

PRECEDING_DOCUMENT_ITEM

public static final OutbDeliveryDocFlowField<String> PRECEDING_DOCUMENT_ITEM

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

SUBSEQUENTDOCUMENT

public static final OutbDeliveryDocFlowField<String> SUBSEQUENTDOCUMENT

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

QUANTITY_IN_BASE_UNIT

public static final OutbDeliveryDocFlowField<BigDecimal> QUANTITY_IN_BASE_UNIT

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

SUBSEQUENT_DOCUMENT_ITEM

public static final OutbDeliveryDocFlowField<String> SUBSEQUENT_DOCUMENT_ITEM

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

SD_FULFILLMENT_CALCULATION_RULE

public static final OutbDeliveryDocFlowField<String> SD_FULFILLMENT_CALCULATION_RULE

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

SUBSEQUENT_DOCUMENT_CATEGORY

public static final OutbDeliveryDocFlowField<String> SUBSEQUENT_DOCUMENT_CATEGORY

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

TRANSFER_ORDER_IN_WRHS_MGMT_IS_CONFD

public static final OutbDeliveryDocFlowField<Boolean> TRANSFER_ORDER_IN_WRHS_MGMT_IS_CONFD

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

Constructor Detail

OutbDeliveryDocFlow

@Generated(value="lombok")
public OutbDeliveryDocFlow()

OutbDeliveryDocFlow

@ConstructorProperties(value={"deliveryversion","precedingDocument","precedingDocumentCategory","precedingDocumentItem","subsequentdocument","quantityInBaseUnit","subsequentDocumentItem","sDFulfillmentCalculationRule","subsequentDocumentCategory","transferOrderInWrhsMgmtIsConfd","erpConfigContext"})
 @Generated(value="lombok")
public OutbDeliveryDocFlow(@Nullable
                                                                                                                                                                                                                                                                                                                                                                    String deliveryversion,
                                                                                                                                                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                                                                                                                                                    String precedingDocument,
                                                                                                                                                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                                                                                                                                                    String precedingDocumentCategory,
                                                                                                                                                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                                                                                                                                                    String precedingDocumentItem,
                                                                                                                                                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                                                                                                                                                    String subsequentdocument,
                                                                                                                                                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                                                                                                                                                    BigDecimal quantityInBaseUnit,
                                                                                                                                                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                                                                                                                                                    String subsequentDocumentItem,
                                                                                                                                                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                                                                                                                                                    String sDFulfillmentCalculationRule,
                                                                                                                                                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                                                                                                                                                    String subsequentDocumentCategory,
                                                                                                                                                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                                                                                                                                                    Boolean transferOrderInWrhsMgmtIsConfd,
                                                                                                                                                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                                                                                                                                                    ErpConfigContext erpConfigContext)

Method Detail

getType

public Class<OutbDeliveryDocFlow> getType()

Specified by:

getType in class VdmObject<OutbDeliveryDocFlow>

Returns:

The class of this object.

field

public static <T> OutbDeliveryDocFlowField<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.

builder

@Generated(value="lombok")
public static OutbDeliveryDocFlow.OutbDeliveryDocFlowBuilder builder()

getDeliveryversion

@Nullable
 @Generated(value="lombok")
public String getDeliveryversion()

Constraints: Not nullable, Maximum length: 4

Returns:

Delivery Version

getPrecedingDocument

@Nullable
 @Generated(value="lombok")
public String getPrecedingDocument()

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

Returns:

Number that uniquely identifies the preceding sales, delivery, or billing document (for example, the quotation from which you created a sales order).

getPrecedingDocumentCategory

@Nullable
 @Generated(value="lombok")
public String getPrecedingDocumentCategory()

Constraints: Not nullable, Maximum length: 4

Returns:

Specifies the sales document category of the preceding sales, delivery, or billing document.

getPrecedingDocumentItem

@Nullable
 @Generated(value="lombok")
public String getPrecedingDocumentItem()

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

Returns:

Preceding Item of an SD Document

getSubsequentdocument

@Nullable
 @Generated(value="lombok")
public String getSubsequentdocument()

Constraints: Not nullable, Maximum length: 10

Returns:

Number that uniquely identifies the subsequent sales, delivery, or billing document (for example, the sales order that you create from a previous quotation).

getQuantityInBaseUnit

@Nullable
 @Generated(value="lombok")
public BigDecimal getQuantityInBaseUnit()

Constraints: Not nullable, Precision: 15, Scale: 3

A sales order item has an order quantity of 100 pieces. You create two delivery notes against the order: the first for 20 pieces, the second for 80 pieces. In the first case, the referenced quantity is 20 pieces; in the second case, 80 pieces.

Returns:

Specifies how much of an item quantity has already been processed in a subsequent document. The referenced quantity is expressed in basic stock units.

getSubsequentDocumentItem

@Nullable
 @Generated(value="lombok")
public String getSubsequentDocumentItem()

Constraints: Not nullable, Maximum length: 6

Returns:

Number that uniquely identifies the item in the subsequent document (for example, in a sales order that you created from a quotation).

getSDFulfillmentCalculationRule

@Nullable
 @Generated(value="lombok")
public String getSDFulfillmentCalculationRule()

Constraints: Not nullable, Maximum length: 1

The system uses this indicator to determine how the quantity in the source document is affected. For example, if you Create a quotation item for 100 pieces, Copy the quotation into a sales order, and Create a sales order item for 80 pieces, the copying has a positive effect on the quotation. In effect, you have added 80 pieces to the quotation quantity that is now considered complete. 20 pieces in the quotation remain to be completed. If you do not make an entry in this field, or set indicator 0, the source document is not blocked, which allows you to create several target documents at once (for example, when using EDI and frequent contract releases). While the source document (such as quotation or quantity contract) is being processed, it is blocked. For instance, if you are working on a quantity contract, no one can create a release order for that contract). In sales documents, for example, you can expect the following results: Quotation -> Sales order: positive Contract -> Return: negative Sales order -> Sales order: no effect In billing documents, for example, you can expect the following results: Delivery -> Invoice: positive Delivery -> Cancellation: negative Delivery -> Pro-forma invoice: no effect

Returns:

Indicates whether, during copying, the quantity or value in the target document has a negative effect, positive effect, or no effect at all on the quantity still to be completed in the source document.

getSubsequentDocumentCategory

@Nullable
 @Generated(value="lombok")
public String getSubsequentDocumentCategory()

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

Returns:

The document category of the sales document that you have created from a preceding document (for example, a delivery note that has been created from a sales order).

getTransferOrderInWrhsMgmtIsConfd

@Nullable
 @Generated(value="lombok")
public Boolean getTransferOrderInWrhsMgmtIsConfd()

Constraints: none

Returns:

Indicates whether the transfer order in the warehouse management (WM) system is confirmed.

getErpConfigContext

@Nullable
 @Generated(value="lombok")
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.

setDeliveryversion

@Generated(value="lombok")
public void setDeliveryversion(@Nullable
                                                          String deliveryversion)

Constraints: Not nullable, Maximum length: 4

Parameters:

deliveryversion -

setPrecedingDocument

@Generated(value="lombok")
public void setPrecedingDocument(@Nullable
                                                            String precedingDocument)

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

Parameters:

precedingDocument -

setPrecedingDocumentCategory

@Generated(value="lombok")
public void setPrecedingDocumentCategory(@Nullable
                                                                    String precedingDocumentCategory)

Constraints: Not nullable, Maximum length: 4

Parameters:

precedingDocumentCategory -

setPrecedingDocumentItem

@Generated(value="lombok")
public void setPrecedingDocumentItem(@Nullable
                                                                String precedingDocumentItem)

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

Parameters:

precedingDocumentItem -

setSubsequentdocument

@Generated(value="lombok")
public void setSubsequentdocument(@Nullable
                                                             String subsequentdocument)

Constraints: Not nullable, Maximum length: 10

Parameters:

subsequentdocument -

setQuantityInBaseUnit

@Generated(value="lombok")
public void setQuantityInBaseUnit(@Nullable
                                                             BigDecimal quantityInBaseUnit)

Constraints: Not nullable, Precision: 15, Scale: 3

A sales order item has an order quantity of 100 pieces. You create two delivery notes against the order: the first for 20 pieces, the second for 80 pieces. In the first case, the referenced quantity is 20 pieces; in the second case, 80 pieces.

Parameters:

quantityInBaseUnit -

setSubsequentDocumentItem

@Generated(value="lombok")
public void setSubsequentDocumentItem(@Nullable
                                                                 String subsequentDocumentItem)

Constraints: Not nullable, Maximum length: 6

Parameters:

subsequentDocumentItem -

setSDFulfillmentCalculationRule

@Generated(value="lombok")
public void setSDFulfillmentCalculationRule(@Nullable
                                                                       String sDFulfillmentCalculationRule)

Constraints: Not nullable, Maximum length: 1

The system uses this indicator to determine how the quantity in the source document is affected. For example, if you Create a quotation item for 100 pieces, Copy the quotation into a sales order, and Create a sales order item for 80 pieces, the copying has a positive effect on the quotation. In effect, you have added 80 pieces to the quotation quantity that is now considered complete. 20 pieces in the quotation remain to be completed. If you do not make an entry in this field, or set indicator 0, the source document is not blocked, which allows you to create several target documents at once (for example, when using EDI and frequent contract releases). While the source document (such as quotation or quantity contract) is being processed, it is blocked. For instance, if you are working on a quantity contract, no one can create a release order for that contract). In sales documents, for example, you can expect the following results: Quotation -> Sales order: positive Contract -> Return: negative Sales order -> Sales order: no effect In billing documents, for example, you can expect the following results: Delivery -> Invoice: positive Delivery -> Cancellation: negative Delivery -> Pro-forma invoice: no effect

Parameters:

sDFulfillmentCalculationRule -

setSubsequentDocumentCategory

@Generated(value="lombok")
public void setSubsequentDocumentCategory(@Nullable
                                                                     String subsequentDocumentCategory)

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

Parameters:

subsequentDocumentCategory -

setTransferOrderInWrhsMgmtIsConfd

@Generated(value="lombok")
public void setTransferOrderInWrhsMgmtIsConfd(@Nullable
                                                                         Boolean transferOrderInWrhsMgmtIsConfd)

Constraints: none

Parameters:

transferOrderInWrhsMgmtIsConfd -

setErpConfigContext

@Generated(value="lombok")
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

@Generated(value="lombok")
public String toString()

Overrides:

toString in class VdmObject<OutbDeliveryDocFlow>

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class VdmObject<OutbDeliveryDocFlow>

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class VdmObject<OutbDeliveryDocFlow>