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 Helper class to allow for fluent creation of PurchaseRequisitionHeader instances.

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<Boolean>	PUR_REQN_DO_ONLY_VALIDATION Use with available fluent helpers to apply the PurReqnDoOnlyValidation 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, Boolean purReqnDoOnlyValidation, List<PurchaseRequisitionItem> toPurchaseReqnItem)

Method Summary

Modifier and Type	Method and Description
void	addPurchaseReqnItem(PurchaseRequisitionItem... entity) Adds elements to the list of associated PurchaseRequisitionItem entities.
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
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.
static <T,DomainT> PurchaseRequisitionHeaderField<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()
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
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
String	getPurchaseRequisitionType() Constraints: Not nullable, Maximum length: 4
String	getPurReqnDescription() Constraints: Not nullable, Maximum length: 40
Boolean	getPurReqnDoOnlyValidation() Constraints: none
Boolean	getSourceDetermination() Constraints: none
Class<PurchaseRequisitionHeader>	getType()
int	hashCode()
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
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
void	setPurchaseRequisitionType(String purchaseRequisitionType) Constraints: Not nullable, Maximum length: 4
void	setPurReqnDescription(String purReqnDescription) Constraints: Not nullable, Maximum length: 40
void	setPurReqnDoOnlyValidation(Boolean purReqnDoOnlyValidation) Constraints: none
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setSourceDetermination(Boolean sourceDetermination) Constraints: none
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, 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.

PUR_REQN_DO_ONLY_VALIDATION

public static final PurchaseRequisitionHeaderField<Boolean> PUR_REQN_DO_ONLY_VALIDATION

Use with available fluent helpers to apply the PurReqnDoOnlyValidation 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
                                 Boolean purReqnDoOnlyValidation,
                                 List<PurchaseRequisitionItem> toPurchaseReqnItem)

Method Detail

getType

@Nonnull
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

Using the document type, you can, for instance, differentiate between a standard purchase requisition and a requisition relating to a stock transport order, although both documents belong to the purchasing document category purchase requisition.The document type controls number assignment and the selection of fields to be maintained.

Parameters:

purchaseRequisitionType - Allows a distinction to be made between various kinds of purchase requisition.

setPurReqnDescription

public void setPurReqnDescription(@Nullable
                                  String purReqnDescription)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: PurReqnDescription

Parameters:

purReqnDescription - Short description of the material.

setSourceDetermination

public void setSourceDetermination(@Nullable
                                   Boolean sourceDetermination)

Constraints: none

Original property name from the Odata EDM: SourceDetermination

Parameters:

sourceDetermination - Checkbox

setPurReqnDoOnlyValidation

public void setPurReqnDoOnlyValidation(@Nullable
                                       Boolean purReqnDoOnlyValidation)

Constraints: none

Original property name from the Odata EDM: PurReqnDoOnlyValidation

Parameters:

purReqnDoOnlyValidation - Boolean Variable (X = True, - = False, Space = Unknown)

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<PurchaseRequisitionHeader>

getKey

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

Overrides:

getKey in class VdmObject<PurchaseRequisitionHeader>

Returns:

The compound key of this object.

toMapOfFields

@Nonnull
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

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

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities). New ERP configuration context to apply to this entity

Overrides:

getErpConfigContext in class VdmEntity<PurchaseRequisitionHeader>

Returns:

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

setErpConfigContext

@Deprecated
public void setErpConfigContext(@Nullable
                                            ErpConfigContext erpConfigContext)

Deprecated. Use attachToService(String, ErpConfigContext) instead.

Description copied from class: VdmEntity

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 - New ERP configuration context to apply to this entity

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

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nullable
                            ErpConfigContext configContext)

Description copied from class: VdmEntity

Sets the service path and ERP configuration context for the fetch commands of this entity. Ensures that both are set to some value by using defaults if null values are provided in the arguments. Existing values are preserved if null values are provided in the arguments. 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<PurchaseRequisitionHeader>

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.

configContext - Optional parameter. New ERP configuration context to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the ERP configuration context has never been set, then the ERP configuration context will be set to a new instance of ErpConfigContext.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<PurchaseRequisitionHeader>

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<PurchaseRequisitionHeader>

fetchPurchaseReqnItem

@Nonnull
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

@Nonnull
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

@Nonnull
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

Using the document type, you can, for instance, differentiate between a standard purchase requisition and a requisition relating to a stock transport order, although both documents belong to the purchasing document category purchase requisition.The document type controls number assignment and the selection of fields to be maintained.

Returns:

Allows a distinction to be made between various kinds of purchase requisition.

getPurReqnDescription

@Nullable
public String getPurReqnDescription()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: PurReqnDescription

Returns:

Short description of the material.

getSourceDetermination

@Nullable
public Boolean getSourceDetermination()

Constraints: none

Original property name from the Odata EDM: SourceDetermination

Returns:

Checkbox

getPurReqnDoOnlyValidation

@Nullable
public Boolean getPurReqnDoOnlyValidation()

Constraints: none

Original property name from the Odata EDM: PurReqnDoOnlyValidation

Returns:

Boolean Variable (X = True, - = False, Space = Unknown)

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>