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

Class PurchaseRequisitionHeader

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionHeader

public class PurchaseRequisitionHeader
extends VdmEntity<PurchaseRequisitionHeader>

CDS View for PR Header API exposure

Original entity name from the Odata EDM: A_PurchaseRequisitionHeaderType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PurchaseRequisitionHeader.PurchaseRequisitionHeaderBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static PurchaseRequisitionHeaderSelectable	ALL_FIELDS Selector for all available fields of PurchaseRequisitionHeader.
static PurchaseRequisitionHeaderField<String>	PUR_REQN_DESCRIPTION Use with available fluent helpers to apply the PurReqnDescription field to query operations.
static PurchaseRequisitionHeaderField<String>	PURCHASE_REQUISITION Use with available fluent helpers to apply the PurchaseRequisition field to query operations.
static PurchaseRequisitionHeaderField<String>	PURCHASE_REQUISITION_TYPE Use with available fluent helpers to apply the PurchaseRequisitionType field to query operations.
static PurchaseRequisitionHeaderField<Boolean>	SOURCE_DETERMINATION Use with available fluent helpers to apply the SourceDetermination field to query operations.
static PurchaseRequisitionHeaderLink<PurchaseRequisitionItem>	TO_PURCHASE_REQN_ITEM Use with available fluent helpers to apply the to_PurchaseReqnItem 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
PurchaseRequisitionHeader()
PurchaseRequisitionHeader(String purchaseRequisition, String purchaseRequisitionType, String purReqnDescription, Boolean sourceDetermination, ErpConfigContext erpConfigContext, List<PurchaseRequisitionItem> toPurchaseReqnItem)

Method Summary

Modifier and Type	Method and Description
void	addPurchaseReqnItem(PurchaseRequisitionItem... entity) Adds elements to the list of associated PurchaseRequisitionItem entities.
static PurchaseRequisitionHeader.PurchaseRequisitionHeaderBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<PurchaseRequisitionItem>	fetchPurchaseReqnItem() Fetches the PurchaseRequisitionItem entities (one to many) associated with this entity.
static <T> PurchaseRequisitionHeaderField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
protected void	fromMap(Map<String,Object> inputValues)
protected String	getEndpointUrl()
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
protected Map<String,Object>	getKey()
Optional<List<PurchaseRequisitionItem>>	getPurchaseReqnItemIfPresent() Retrieval of associated PurchaseRequisitionItem entities (one to many).
List<PurchaseRequisitionItem>	getPurchaseReqnItemOrFetch() Retrieval of associated PurchaseRequisitionItem entities (one to many).
String	getPurchaseRequisition() (Key Field) Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: PurchaseRequisition
String	getPurchaseRequisitionType() Constraints: Not nullable, Maximum length: 4 Original property name from the Odata EDM: PurchaseRequisitionType
String	getPurReqnDescription() Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: PurReqnDescription
Boolean	getSourceDetermination() Constraints: noneOriginal property name from the Odata EDM: SourceDetermination
Class<PurchaseRequisitionHeader>	getType()
int	hashCode()
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
void	setPurchaseReqnItem(List<PurchaseRequisitionItem> value) Overwrites the list of associated PurchaseRequisitionItem entities for the loaded navigation property to_PurchaseReqnItem.
void	setPurchaseRequisition(String purchaseRequisition) (Key Field) Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: PurchaseRequisition
void	setPurchaseRequisitionType(String purchaseRequisitionType) Constraints: Not nullable, Maximum length: 4 Original property name from the Odata EDM: PurchaseRequisitionType
void	setPurReqnDescription(String purReqnDescription) Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: PurReqnDescription
void	setSourceDetermination(Boolean sourceDetermination) Constraints: noneOriginal property name from the Odata EDM: SourceDetermination
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

getVersionIdentifier, 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 PurchaseRequisitionHeaderSelectable ALL_FIELDS

Selector for all available fields of PurchaseRequisitionHeader.

PURCHASE_REQUISITION

public static final PurchaseRequisitionHeaderField<String> PURCHASE_REQUISITION

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

PURCHASE_REQUISITION_TYPE

public static final PurchaseRequisitionHeaderField<String> PURCHASE_REQUISITION_TYPE

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

PUR_REQN_DESCRIPTION

public static final PurchaseRequisitionHeaderField<String> PUR_REQN_DESCRIPTION

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

SOURCE_DETERMINATION

public static final PurchaseRequisitionHeaderField<Boolean> SOURCE_DETERMINATION

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

TO_PURCHASE_REQN_ITEM

public static final PurchaseRequisitionHeaderLink<PurchaseRequisitionItem> TO_PURCHASE_REQN_ITEM

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

Constructor Detail

PurchaseRequisitionHeader

public PurchaseRequisitionHeader()

PurchaseRequisitionHeader

public PurchaseRequisitionHeader(@Nullable
                                 String purchaseRequisition,
                                 @Nullable
                                 String purchaseRequisitionType,
                                 @Nullable
                                 String purReqnDescription,
                                 @Nullable
                                 Boolean sourceDetermination,
                                 @Nullable
                                 ErpConfigContext erpConfigContext,
                                 List<PurchaseRequisitionItem> toPurchaseReqnItem)

Method Detail

getType

public Class<PurchaseRequisitionHeader> getType()

Specified by:

getType in class VdmObject<PurchaseRequisitionHeader>

Returns:

The class of this object.

setPurchaseRequisition

public void setPurchaseRequisition(@Nullable
                                   String purchaseRequisition)

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

Original property name from the Odata EDM: PurchaseRequisition

Parameters:

purchaseRequisition - Purchase requisition number

setPurchaseRequisitionType

public void setPurchaseRequisitionType(@Nullable
                                       String purchaseRequisitionType)

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: PurchaseRequisitionType

Parameters:

purchaseRequisitionType - Purchase Requisition Document Type

setPurReqnDescription

public void setPurReqnDescription(@Nullable
                                  String purReqnDescription)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: PurReqnDescription

Parameters:

purReqnDescription - Short Text

setSourceDetermination

public void setSourceDetermination(@Nullable
                                   Boolean sourceDetermination)

Constraints: none

Original property name from the Odata EDM: SourceDetermination

Parameters:

sourceDetermination - Checkbox

getEndpointUrl

protected String getEndpointUrl()

Specified by:

getEndpointUrl in class VdmEntity<PurchaseRequisitionHeader>

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<PurchaseRequisitionHeader>

getKey

protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<PurchaseRequisitionHeader>

Returns:

The compound key of this object.

toMapOfFields

protected Map<String,Object> toMapOfFields()

Overrides:

toMapOfFields in class VdmObject<PurchaseRequisitionHeader>

fromMap

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

Overrides:

fromMap in class VdmObject<PurchaseRequisitionHeader>

field

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

toMapOfNavigationProperties

protected Map<String,Object> toMapOfNavigationProperties()

Overrides:

toMapOfNavigationProperties in class VdmObject<PurchaseRequisitionHeader>

fetchPurchaseReqnItem

public List<PurchaseRequisitionItem> fetchPurchaseReqnItem()
                                                    throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getPurchaseReqnItemOrFetch

public List<PurchaseRequisitionItem> getPurchaseReqnItemOrFetch()
                                                         throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

If the navigation property to_PurchaseReqnItem of a queried PurchaseRequisitionHeader 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 PurchaseRequisitionItem 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.

getPurchaseReqnItemIfPresent

public Optional<List<PurchaseRequisitionItem>> getPurchaseReqnItemIfPresent()

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

If the navigation property for an entity PurchaseRequisitionHeader 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_PurchaseReqnItem is already loaded, the result will contain the PurchaseRequisitionItem entities. If not, an Optional with result state empty is returned.

setPurchaseReqnItem

public void setPurchaseReqnItem(@NonNull
                                List<PurchaseRequisitionItem> value)

Overwrites the list of associated PurchaseRequisitionItem entities for the loaded navigation property to_PurchaseReqnItem.

If the navigation property to_PurchaseReqnItem of a queried PurchaseRequisitionHeader 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 PurchaseRequisitionItem entities.

addPurchaseReqnItem

public void addPurchaseReqnItem(PurchaseRequisitionItem... entity)

Adds elements to the list of associated PurchaseRequisitionItem entities. This corresponds to the OData navigation property to_PurchaseReqnItem.

If the navigation property to_PurchaseReqnItem of a queried PurchaseRequisitionHeader 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 PurchaseRequisitionItem entities.

builder

public static PurchaseRequisitionHeader.PurchaseRequisitionHeaderBuilder builder()

getPurchaseRequisition

@Nullable
public String getPurchaseRequisition()

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

Original property name from the Odata EDM: PurchaseRequisition

Returns:

Purchase requisition number

getPurchaseRequisitionType

@Nullable
public String getPurchaseRequisitionType()

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: PurchaseRequisitionType

Returns:

Purchase Requisition Document Type

getPurReqnDescription

@Nullable
public String getPurReqnDescription()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: PurReqnDescription

Returns:

Short Text

getSourceDetermination

@Nullable
public Boolean getSourceDetermination()

Constraints: none

Original property name from the Odata EDM: SourceDetermination

Returns:

Checkbox

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

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<PurchaseRequisitionHeader>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<PurchaseRequisitionHeader>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<PurchaseRequisitionHeader>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<PurchaseRequisitionHeader>