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

Class MaterialDocumentHeader

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processmaterialdocuments.MaterialDocumentHeader

public class MaterialDocumentHeader
extends VdmEntity<MaterialDocumentHeader>

API exposure Material Document Header

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MaterialDocumentHeader.MaterialDocumentHeaderBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static MaterialDocumentHeaderSelectable	ALL_FIELDS Selector for all available fields of MaterialDocumentHeader.
static MaterialDocumentHeaderField<String>	CREATED_BY_USER Use with available fluent helpers to apply the CreatedByUser field to query operations.
static MaterialDocumentHeaderField<Calendar>	CREATION_DATE Use with available fluent helpers to apply the CreationDate field to query operations.
static MaterialDocumentHeaderField<Calendar>	CREATION_TIME Use with available fluent helpers to apply the CreationTime field to query operations.
static MaterialDocumentHeaderField<Calendar>	DOCUMENT_DATE Use with available fluent helpers to apply the DocumentDate field to query operations.
static MaterialDocumentHeaderField<String>	GOODS_MOVEMENT_CODE Use with available fluent helpers to apply the GoodsMovementCode field to query operations.
static MaterialDocumentHeaderField<String>	INVENTORY_TRANSACTION_TYPE Use with available fluent helpers to apply the InventoryTransactionType field to query operations.
static MaterialDocumentHeaderField<String>	MATERIAL_DOCUMENT Use with available fluent helpers to apply the MaterialDocument field to query operations.
static MaterialDocumentHeaderField<String>	MATERIAL_DOCUMENT_HEADER_TEXT Use with available fluent helpers to apply the MaterialDocumentHeaderText field to query operations.
static MaterialDocumentHeaderField<String>	MATERIAL_DOCUMENT_YEAR Use with available fluent helpers to apply the MaterialDocumentYear field to query operations.
static MaterialDocumentHeaderField<Calendar>	POSTING_DATE Use with available fluent helpers to apply the PostingDate field to query operations.
static MaterialDocumentHeaderField<String>	REFERENCE_DOCUMENT Use with available fluent helpers to apply the ReferenceDocument field to query operations.
static MaterialDocumentHeaderLink<MaterialDocumentItem>	TO_MATERIAL_DOCUMENT_ITEM Use with available fluent helpers to apply the to_MaterialDocumentItem navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
MaterialDocumentHeader()
MaterialDocumentHeader(String materialDocumentYear, String materialDocument, String inventoryTransactionType, Calendar documentDate, Calendar postingDate, Calendar creationDate, Calendar creationTime, String createdByUser, String materialDocumentHeaderText, String referenceDocument, String goodsMovementCode, ErpConfigContext erpConfigContext, List<MaterialDocumentItem> toMaterialDocumentItem)

Method Summary

Modifier and Type	Method and Description
void	addMaterialDocumentItem(MaterialDocumentItem... entity) Adds elements to the list of associated MaterialDocumentItem entities.
static MaterialDocumentHeader.MaterialDocumentHeaderBuilder	builder()
boolean	equals(Object o)
List<MaterialDocumentItem>	fetchMaterialDocumentItem() Fetches the MaterialDocumentItem entities (one to many) associated with this entity.
static <T> MaterialDocumentHeaderField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getCreatedByUser() Constraints: Not nullable, Maximum length: 12
Calendar	getCreationDate() Constraints: Not nullable, Precision: 0
Calendar	getCreationTime() Constraints: Not nullable, Precision: 0
Calendar	getDocumentDate() Constraints: Not nullable, Precision: 0
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
String	getGoodsMovementCode() Constraints: Not nullable, Maximum length: 2
String	getInventoryTransactionType() Constraints: Not nullable, Maximum length: 2
String	getMaterialDocument() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getMaterialDocumentHeaderText() Constraints: Not nullable, Maximum length: 25
List<MaterialDocumentItem>	getMaterialDocumentItemOrFetch() Retrieval of associated MaterialDocumentItem entities (one to many).
com.google.common.base.Optional<List<MaterialDocumentItem>>	getMaterialDocumentItemOrNull() Retrieval of associated MaterialDocumentItem entities (one to many).
String	getMaterialDocumentYear() (Key Field) Constraints: Not nullable, Maximum length: 4
Calendar	getPostingDate() Constraints: Not nullable, Precision: 0
String	getReferenceDocument() Constraints: Not nullable, Maximum length: 16
Class<MaterialDocumentHeader>	getType()
int	hashCode()
void	setCreatedByUser(String createdByUser) Constraints: Not nullable, Maximum length: 12
void	setCreationDate(Calendar creationDate) Constraints: Not nullable, Precision: 0
void	setCreationTime(Calendar creationTime) Constraints: Not nullable, Precision: 0
void	setDocumentDate(Calendar documentDate) Constraints: Not nullable, Precision: 0
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setGoodsMovementCode(String goodsMovementCode) Constraints: Not nullable, Maximum length: 2
void	setInventoryTransactionType(String inventoryTransactionType) Constraints: Not nullable, Maximum length: 2
void	setMaterialDocument(String materialDocument) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setMaterialDocumentHeaderText(String materialDocumentHeaderText) Constraints: Not nullable, Maximum length: 25
void	setMaterialDocumentItem(List<MaterialDocumentItem> value) Overwrites the list of associated MaterialDocumentItem entities for the loaded navigation property to_MaterialDocumentItem.
void	setMaterialDocumentYear(String materialDocumentYear) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setPostingDate(Calendar postingDate) Constraints: Not nullable, Precision: 0
void	setReferenceDocument(String referenceDocument) Constraints: Not nullable, Maximum length: 16
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 MaterialDocumentHeaderSelectable ALL_FIELDS

Selector for all available fields of MaterialDocumentHeader.

MATERIAL_DOCUMENT_YEAR

public static final MaterialDocumentHeaderField<String> MATERIAL_DOCUMENT_YEAR

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

MATERIAL_DOCUMENT

public static final MaterialDocumentHeaderField<String> MATERIAL_DOCUMENT

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

INVENTORY_TRANSACTION_TYPE

public static final MaterialDocumentHeaderField<String> INVENTORY_TRANSACTION_TYPE

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

DOCUMENT_DATE

public static final MaterialDocumentHeaderField<Calendar> DOCUMENT_DATE

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

POSTING_DATE

public static final MaterialDocumentHeaderField<Calendar> POSTING_DATE

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

CREATION_DATE

public static final MaterialDocumentHeaderField<Calendar> CREATION_DATE

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

CREATION_TIME

public static final MaterialDocumentHeaderField<Calendar> CREATION_TIME

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

CREATED_BY_USER

public static final MaterialDocumentHeaderField<String> CREATED_BY_USER

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

MATERIAL_DOCUMENT_HEADER_TEXT

public static final MaterialDocumentHeaderField<String> MATERIAL_DOCUMENT_HEADER_TEXT

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

REFERENCE_DOCUMENT

public static final MaterialDocumentHeaderField<String> REFERENCE_DOCUMENT

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

GOODS_MOVEMENT_CODE

public static final MaterialDocumentHeaderField<String> GOODS_MOVEMENT_CODE

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

TO_MATERIAL_DOCUMENT_ITEM

public static final MaterialDocumentHeaderLink<MaterialDocumentItem> TO_MATERIAL_DOCUMENT_ITEM

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

Constructor Detail

MaterialDocumentHeader

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

MaterialDocumentHeader

@ConstructorProperties(value={"materialDocumentYear","materialDocument","inventoryTransactionType","documentDate","postingDate","creationDate","creationTime","createdByUser","materialDocumentHeaderText","referenceDocument","goodsMovementCode","erpConfigContext","toMaterialDocumentItem"})
 @Generated(value="lombok")
public MaterialDocumentHeader(@Nullable
                                                                                                                                                                                                                                                                                                                                                           String materialDocumentYear,
                                                                                                                                                                                                                                                                                                                                                           @Nullable
                                                                                                                                                                                                                                                                                                                                                           String materialDocument,
                                                                                                                                                                                                                                                                                                                                                           @Nullable
                                                                                                                                                                                                                                                                                                                                                           String inventoryTransactionType,
                                                                                                                                                                                                                                                                                                                                                           @Nullable
                                                                                                                                                                                                                                                                                                                                                           Calendar documentDate,
                                                                                                                                                                                                                                                                                                                                                           @Nullable
                                                                                                                                                                                                                                                                                                                                                           Calendar postingDate,
                                                                                                                                                                                                                                                                                                                                                           @Nullable
                                                                                                                                                                                                                                                                                                                                                           Calendar creationDate,
                                                                                                                                                                                                                                                                                                                                                           @Nullable
                                                                                                                                                                                                                                                                                                                                                           Calendar creationTime,
                                                                                                                                                                                                                                                                                                                                                           @Nullable
                                                                                                                                                                                                                                                                                                                                                           String createdByUser,
                                                                                                                                                                                                                                                                                                                                                           @Nullable
                                                                                                                                                                                                                                                                                                                                                           String materialDocumentHeaderText,
                                                                                                                                                                                                                                                                                                                                                           @Nullable
                                                                                                                                                                                                                                                                                                                                                           String referenceDocument,
                                                                                                                                                                                                                                                                                                                                                           @Nullable
                                                                                                                                                                                                                                                                                                                                                           String goodsMovementCode,
                                                                                                                                                                                                                                                                                                                                                           @Nullable
                                                                                                                                                                                                                                                                                                                                                           ErpConfigContext erpConfigContext,
                                                                                                                                                                                                                                                                                                                                                           List<MaterialDocumentItem> toMaterialDocumentItem)

Method Detail

getType

public Class<MaterialDocumentHeader> getType()

Specified by:

getType in class VdmObject<MaterialDocumentHeader>

Returns:

The class of this object.

field

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

fetchMaterialDocumentItem

public List<MaterialDocumentItem> fetchMaterialDocumentItem()
                                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getMaterialDocumentItemOrFetch

public List<MaterialDocumentItem> getMaterialDocumentItemOrFetch()
                                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated MaterialDocumentItem entities (one to many).

If the navigation property to_MaterialDocumentItem of a queried MaterialDocumentHeader 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 MaterialDocumentItem 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.

getMaterialDocumentItemOrNull

public com.google.common.base.Optional<List<MaterialDocumentItem>> getMaterialDocumentItemOrNull()

Retrieval of associated MaterialDocumentItem entities (one to many).

If the navigation property to_MaterialDocumentItem for an entity MaterialDocumentHeader 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_MaterialDocumentItem is already loaded, the result will contain the MaterialDocumentItem entities. If not, a null value state is returned.

setMaterialDocumentItem

public void setMaterialDocumentItem(@NonNull
                                    List<MaterialDocumentItem> value)

Overwrites the list of associated MaterialDocumentItem entities for the loaded navigation property to_MaterialDocumentItem.

If the navigation property to_MaterialDocumentItem of a queried MaterialDocumentHeader 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 MaterialDocumentItem entities.

addMaterialDocumentItem

public void addMaterialDocumentItem(MaterialDocumentItem... entity)

Adds elements to the list of associated MaterialDocumentItem entities.

If the navigation property to_MaterialDocumentItem of a queried MaterialDocumentHeader 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 MaterialDocumentItem entities.

builder

@Generated(value="lombok")
public static MaterialDocumentHeader.MaterialDocumentHeaderBuilder builder()

getMaterialDocumentYear

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

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

Returns:

Material Document Year

getMaterialDocument

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

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

Number of the material document with which a goods movement was posted. Together with the material document year, the document number constitutes the key via which a material document is accessed.

Returns:

Alphanumeric key uniquely identifying the document.

getInventoryTransactionType

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

Constraints: Not nullable, Maximum length: 2

Returns:

Identifier for a certain transaction or event. (Example: GR for "Goods receipt against a purchase order".)

getDocumentDate

@Nullable
 @Generated(value="lombok")
public Calendar getDocumentDate()

Constraints: Not nullable, Precision: 0

Returns:

The document date is the date on which the original document was issued.

getPostingDate

@Nullable
 @Generated(value="lombok")
public Calendar getPostingDate()

Constraints: Not nullable, Precision: 0

The fiscal year and the period for which an update of the accounts specified in the document or cost elements is made, are derived from the posting date. When entering documents, the system checks whether the posting date entered is allowed by means of the posting period permitted. The posting date can differ from both the entry date (day of entry into the system) and the document date (day of creation of the original document).

Returns:

Date which is used when entering the document in Financial Accounting or Controlling.

getCreationDate

@Nullable
 @Generated(value="lombok")
public Calendar getCreationDate()

Constraints: Not nullable, Precision: 0

Note The posting date can differ from the entry date (date of entry in the system) and the document date.

Returns:

Specifies the date on which the accounting document is entered.

getCreationTime

@Nullable
 @Generated(value="lombok")
public Calendar getCreationTime()

Constraints: Not nullable, Precision: 0

Returns:

Time of Entry

getCreatedByUser

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

Constraints: Not nullable, Maximum length: 12

Returns:

User Name

getMaterialDocumentHeaderText

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

Constraints: Not nullable, Maximum length: 25

Returns:

The document header text contains explanations or notes which apply to the document as a whole, that is, not only for certain line items.

getReferenceDocument

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

Constraints: Not nullable, Maximum length: 16

The reference document number is used as a search criterion when displaying or changing documents. In correspondence, the reference document number is sometimes printed in place of the document number. Enter the number specified by the business partner. If the document was created in-house and you do not know the business partner document number, you can copy the document number into the reference number field by entering "*".

Returns:

The reference document number can contain the document number of the customer/vendor. However it may contain a different value.

getGoodsMovementCode

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

Constraints: Not nullable, Maximum length: 2

Returns:

Goods Movement Code

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.

setMaterialDocumentYear

@Generated(value="lombok")
public void setMaterialDocumentYear(@Nullable
                                                               String materialDocumentYear)

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

Parameters:

materialDocumentYear -

setMaterialDocument

@Generated(value="lombok")
public void setMaterialDocument(@Nullable
                                                           String materialDocument)

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

Number of the material document with which a goods movement was posted. Together with the material document year, the document number constitutes the key via which a material document is accessed.

Parameters:

materialDocument -

setInventoryTransactionType

@Generated(value="lombok")
public void setInventoryTransactionType(@Nullable
                                                                   String inventoryTransactionType)

Constraints: Not nullable, Maximum length: 2

Parameters:

inventoryTransactionType -

setDocumentDate

@Generated(value="lombok")
public void setDocumentDate(@Nullable
                                                       Calendar documentDate)

Constraints: Not nullable, Precision: 0

Parameters:

documentDate -

setPostingDate

@Generated(value="lombok")
public void setPostingDate(@Nullable
                                                      Calendar postingDate)

Constraints: Not nullable, Precision: 0

The fiscal year and the period for which an update of the accounts specified in the document or cost elements is made, are derived from the posting date. When entering documents, the system checks whether the posting date entered is allowed by means of the posting period permitted. The posting date can differ from both the entry date (day of entry into the system) and the document date (day of creation of the original document).

Parameters:

postingDate -

setCreationDate

@Generated(value="lombok")
public void setCreationDate(@Nullable
                                                       Calendar creationDate)

Constraints: Not nullable, Precision: 0

Note The posting date can differ from the entry date (date of entry in the system) and the document date.

Parameters:

creationDate -

setCreationTime

@Generated(value="lombok")
public void setCreationTime(@Nullable
                                                       Calendar creationTime)

Constraints: Not nullable, Precision: 0

Parameters:

creationTime -

setCreatedByUser

@Generated(value="lombok")
public void setCreatedByUser(@Nullable
                                                        String createdByUser)

Constraints: Not nullable, Maximum length: 12

Parameters:

createdByUser -

setMaterialDocumentHeaderText

@Generated(value="lombok")
public void setMaterialDocumentHeaderText(@Nullable
                                                                     String materialDocumentHeaderText)

Constraints: Not nullable, Maximum length: 25

Parameters:

materialDocumentHeaderText -

setReferenceDocument

@Generated(value="lombok")
public void setReferenceDocument(@Nullable
                                                            String referenceDocument)

Constraints: Not nullable, Maximum length: 16

The reference document number is used as a search criterion when displaying or changing documents. In correspondence, the reference document number is sometimes printed in place of the document number. Enter the number specified by the business partner. If the document was created in-house and you do not know the business partner document number, you can copy the document number into the reference number field by entering "*".

Parameters:

referenceDocument -

setGoodsMovementCode

@Generated(value="lombok")
public void setGoodsMovementCode(@Nullable
                                                            String goodsMovementCode)

Constraints: Not nullable, Maximum length: 2

Parameters:

goodsMovementCode -

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

equals

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

Overrides:

equals in class VdmObject<MaterialDocumentHeader>

hashCode

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

Overrides:

hashCode in class VdmObject<MaterialDocumentHeader>