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

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

public class PurchaseRequisitionHeader
extends VdmEntity<PurchaseRequisitionHeader>

CDS View for PR Header API exposure

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.

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()
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.
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
List<PurchaseRequisitionItem>	getPurchaseReqnItemOrFetch() Retrieval of associated PurchaseRequisitionItem entities (one to many).
com.google.common.base.Optional<List<PurchaseRequisitionItem>>	getPurchaseReqnItemOrNull() 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	getSourceDetermination() Constraints: none
Class<PurchaseRequisitionHeader>	getType()
int	hashCode()
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
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	setSourceDetermination(Boolean sourceDetermination) 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 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

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

PurchaseRequisitionHeader

@ConstructorProperties(value={"purchaseRequisition","purchaseRequisitionType","purReqnDescription","sourceDetermination","erpConfigContext","toPurchaseReqnItem"})
 @Generated(value="lombok")
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.

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.

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).

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.

getPurchaseReqnItemOrNull

public com.google.common.base.Optional<List<PurchaseRequisitionItem>> getPurchaseReqnItemOrNull()

Retrieval of associated PurchaseRequisitionItem entities (one to many).

If the navigation property to_PurchaseReqnItem for an entity PurchaseRequisitionHeader 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_PurchaseReqnItem is already loaded, the result will contain the PurchaseRequisitionItem entities. If not, a null value state 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.

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

@Generated(value="lombok")
public static PurchaseRequisitionHeader.PurchaseRequisitionHeaderBuilder builder()

getPurchaseRequisition

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

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

Returns:

Purchase requisition number

getPurchaseRequisitionType

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

Constraints: Not nullable, Maximum length: 4

Returns:

Purchase Requisition Document Type

getPurReqnDescription

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

Constraints: Not nullable, Maximum length: 40

Returns:

Short Text

getSourceDetermination

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

Constraints: none

Returns:

Checkbox

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.

setPurchaseRequisition

@Generated(value="lombok")
public void setPurchaseRequisition(@Nullable
                                                              String purchaseRequisition)

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

Parameters:

purchaseRequisition -

setPurchaseRequisitionType

@Generated(value="lombok")
public void setPurchaseRequisitionType(@Nullable
                                                                  String purchaseRequisitionType)

Constraints: Not nullable, Maximum length: 4

Parameters:

purchaseRequisitionType -

setPurReqnDescription

@Generated(value="lombok")
public void setPurReqnDescription(@Nullable
                                                             String purReqnDescription)

Constraints: Not nullable, Maximum length: 40

Parameters:

purReqnDescription -

setSourceDetermination

@Generated(value="lombok")
public void setSourceDetermination(@Nullable
                                                              Boolean sourceDetermination)

Constraints: none

Parameters:

sourceDetermination -

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

equals

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

Overrides:

equals in class VdmObject<PurchaseRequisitionHeader>

hashCode

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

Overrides:

hashCode in class VdmObject<PurchaseRequisitionHeader>