public class MaterialDocumentHeader extends VdmEntity<MaterialDocumentHeader>
Original entity name from the Odata EDM: A_MaterialDocumentHeaderType
Modifier and Type | Class and Description |
---|---|
static class |
MaterialDocumentHeader.MaterialDocumentHeaderBuilder
Helper class to allow for fluent creation of MaterialDocumentHeader instances.
|
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<LocalDateTime> |
CREATION_DATE
Use with available fluent helpers to apply the CreationDate field to query operations.
|
static MaterialDocumentHeaderField<LocalTime> |
CREATION_TIME
Use with available fluent helpers to apply the CreationTime field to query operations.
|
static MaterialDocumentHeaderField<LocalDateTime> |
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<LocalDateTime> |
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.
|
changedOriginalFields
Constructor and Description |
---|
MaterialDocumentHeader() |
MaterialDocumentHeader(String materialDocumentYear,
String materialDocument,
String inventoryTransactionType,
LocalDateTime documentDate,
LocalDateTime postingDate,
LocalDateTime creationDate,
LocalTime creationTime,
String createdByUser,
String materialDocumentHeaderText,
String referenceDocument,
String goodsMovementCode,
List<MaterialDocumentItem> toMaterialDocumentItem) |
Modifier and Type | Method and Description |
---|---|
void |
addMaterialDocumentItem(MaterialDocumentItem... entity)
Adds elements to the list of associated MaterialDocumentItem entities.
|
void |
attachToService(String servicePath,
HttpDestinationProperties destination) |
static MaterialDocumentHeader.MaterialDocumentHeaderBuilder |
builder() |
protected boolean |
canEqual(Object other) |
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.
|
static <T,DomainT> |
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) |
String |
getCreatedByUser()
Constraints: Not nullable, Maximum length: 12
|
LocalDateTime |
getCreationDate()
Constraints: Not nullable, Precision: 0
|
LocalTime |
getCreationTime()
Constraints: Not nullable, Precision: 0
|
protected String |
getDefaultServicePath() |
HttpDestinationProperties |
getDestinationForFetch()
Convienence field for reusing the same destination with multiple queries (e.g.
|
LocalDateTime |
getDocumentDate()
Constraints: Not nullable, Precision: 0
|
protected String |
getEntityCollection() |
String |
getGoodsMovementCode()
Constraints: Not nullable, Maximum length: 2
|
String |
getInventoryTransactionType()
Constraints: Not nullable, Maximum length: 2
|
protected Map<String,Object> |
getKey() |
String |
getMaterialDocument()
(Key Field) Constraints: Not nullable, Maximum length: 10
|
String |
getMaterialDocumentHeaderText()
Constraints: Not nullable, Maximum length: 25
|
io.vavr.control.Option<List<MaterialDocumentItem>> |
getMaterialDocumentItemIfPresent()
Retrieval of associated MaterialDocumentItem entities (one to many).
|
List<MaterialDocumentItem> |
getMaterialDocumentItemOrFetch()
Retrieval of associated MaterialDocumentItem entities (one to many).
|
String |
getMaterialDocumentYear()
(Key Field) Constraints: Not nullable, Maximum length: 4
|
LocalDateTime |
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(LocalDateTime creationDate)
Constraints: Not nullable, Precision: 0
|
void |
setCreationTime(LocalTime creationTime)
Constraints: Not nullable, Precision: 0
|
void |
setDocumentDate(LocalDateTime documentDate)
Constraints: Not nullable, Precision: 0
|
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(LocalDateTime postingDate)
Constraints: Not nullable, Precision: 0
|
void |
setReferenceDocument(String referenceDocument)
Constraints: Not nullable, Maximum length: 16
|
protected void |
setServicePathForFetch(String servicePathForFetch)
The service path only used for the fetch commands of this entity.
|
protected Map<String,Object> |
toMapOfFields() |
protected Map<String,Object> |
toMapOfNavigationProperties() |
String |
toString() |
getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields
public static final MaterialDocumentHeaderSelectable ALL_FIELDS
public static final MaterialDocumentHeaderField<String> MATERIAL_DOCUMENT_YEAR
public static final MaterialDocumentHeaderField<String> MATERIAL_DOCUMENT
public static final MaterialDocumentHeaderField<String> INVENTORY_TRANSACTION_TYPE
public static final MaterialDocumentHeaderField<LocalDateTime> DOCUMENT_DATE
public static final MaterialDocumentHeaderField<LocalDateTime> POSTING_DATE
public static final MaterialDocumentHeaderField<LocalDateTime> CREATION_DATE
public static final MaterialDocumentHeaderField<LocalTime> CREATION_TIME
public static final MaterialDocumentHeaderField<String> CREATED_BY_USER
public static final MaterialDocumentHeaderField<String> MATERIAL_DOCUMENT_HEADER_TEXT
public static final MaterialDocumentHeaderField<String> REFERENCE_DOCUMENT
public static final MaterialDocumentHeaderField<String> GOODS_MOVEMENT_CODE
public static final MaterialDocumentHeaderLink<MaterialDocumentItem> TO_MATERIAL_DOCUMENT_ITEM
public MaterialDocumentHeader()
public MaterialDocumentHeader(@Nullable String materialDocumentYear, @Nullable String materialDocument, @Nullable String inventoryTransactionType, @Nullable LocalDateTime documentDate, @Nullable LocalDateTime postingDate, @Nullable LocalDateTime creationDate, @Nullable LocalTime creationTime, @Nullable String createdByUser, @Nullable String materialDocumentHeaderText, @Nullable String referenceDocument, @Nullable String goodsMovementCode, List<MaterialDocumentItem> toMaterialDocumentItem)
@Nonnull public Class<MaterialDocumentHeader> getType()
getType
in class VdmObject<MaterialDocumentHeader>
public void setMaterialDocumentYear(@Nullable String materialDocumentYear)
Original property name from the Odata EDM: MaterialDocumentYear
materialDocumentYear
- Material Document Yearpublic void setMaterialDocument(@Nullable String materialDocument)
Original property name from the Odata EDM: MaterialDocument
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.
materialDocument
- Alphanumeric key uniquely identifying the document.public void setInventoryTransactionType(@Nullable String inventoryTransactionType)
Original property name from the Odata EDM: InventoryTransactionType
inventoryTransactionType
- Identifier for a certain transaction or event. (Example: GR for "Goods receipt against a purchase
order".)public void setDocumentDate(@Nullable LocalDateTime documentDate)
Original property name from the Odata EDM: DocumentDate
documentDate
- The document date is the date on which the original document was issued.public void setPostingDate(@Nullable LocalDateTime postingDate)
Original property name from the Odata EDM: PostingDate
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).
postingDate
- Date which is used when entering the document in Financial Accounting or Controlling.public void setCreationDate(@Nullable LocalDateTime creationDate)
Original property name from the Odata EDM: CreationDate
NoteThe posting date can differ from the entry date (date of entry in the system) and the document date.
creationDate
- Specifies the date on which the accounting document is entered.public void setCreationTime(@Nullable LocalTime creationTime)
Original property name from the Odata EDM: CreationTime
creationTime
- Time of Entrypublic void setCreatedByUser(@Nullable String createdByUser)
Original property name from the Odata EDM: CreatedByUser
createdByUser
- User Namepublic void setMaterialDocumentHeaderText(@Nullable String materialDocumentHeaderText)
Original property name from the Odata EDM: MaterialDocumentHeaderText
materialDocumentHeaderText
- The document header text contains explanations or notes which apply to the document as a whole, that
is, not only for certain line items.public void setReferenceDocument(@Nullable String referenceDocument)
Original property name from the Odata EDM: ReferenceDocument
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 "*".
referenceDocument
- The reference document number can contain the document number of the customer/vendor. However it may
contain a different value.public void setGoodsMovementCode(@Nullable String goodsMovementCode)
Original property name from the Odata EDM: GoodsMovementCode
goodsMovementCode
- Goods Movement Codeprotected String getEntityCollection()
getEntityCollection
in class VdmEntity<MaterialDocumentHeader>
@Nonnull protected Map<String,Object> getKey()
getKey
in class VdmObject<MaterialDocumentHeader>
@Nonnull protected Map<String,Object> toMapOfFields()
toMapOfFields
in class VdmObject<MaterialDocumentHeader>
protected void fromMap(Map<String,Object> inputValues)
fromMap
in class VdmObject<MaterialDocumentHeader>
@Nonnull public static <T> MaterialDocumentHeaderField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
T
- The type of the extension field when performing value comparisons.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.@Nonnull public static <T,DomainT> MaterialDocumentHeaderField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
T
- The type of the extension field when performing value comparisons.DomainT
- The type of the extension field as returned by the OData service.typeConverter
- A TypeConverterfieldName
- The name of the extension field as returned by the OData service.@Nullable public HttpDestinationProperties getDestinationForFetch()
VdmEntity
getDestinationForFetch
in class VdmEntity<MaterialDocumentHeader>
protected void setServicePathForFetch(@Nullable String servicePathForFetch)
VdmEntity
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.
setServicePathForFetch
in class VdmEntity<MaterialDocumentHeader>
public void attachToService(@Nullable String servicePath, @Nullable HttpDestinationProperties destination)
attachToService
in class VdmEntity<MaterialDocumentHeader>
protected String getDefaultServicePath()
getDefaultServicePath
in class VdmEntity<MaterialDocumentHeader>
@Nonnull protected Map<String,Object> toMapOfNavigationProperties()
toMapOfNavigationProperties
in class VdmObject<MaterialDocumentHeader>
@Nonnull public List<MaterialDocumentItem> fetchMaterialDocumentItem() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
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.@Nonnull public List<MaterialDocumentItem> getMaterialDocumentItemOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
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.
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.@Nonnull public io.vavr.control.Option<List<MaterialDocumentItem>> getMaterialDocumentItemIfPresent()
If the navigation property for an entity MaterialDocumentHeader has not been resolved yet, this method
will not query further information. Instead its Option
result state will be
empty
.
Option
with result state
empty
is returned.public void setMaterialDocumentItem(@Nonnull List<MaterialDocumentItem> value)
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.
value
- List of MaterialDocumentItem entities.public void addMaterialDocumentItem(MaterialDocumentItem... entity)
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.
entity
- Array of MaterialDocumentItem entities.public static MaterialDocumentHeader.MaterialDocumentHeaderBuilder builder()
@Nullable public String getMaterialDocumentYear()
Original property name from the Odata EDM: MaterialDocumentYear
@Nullable public String getMaterialDocument()
Original property name from the Odata EDM: MaterialDocument
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.
@Nullable public String getInventoryTransactionType()
Original property name from the Odata EDM: InventoryTransactionType
@Nullable public LocalDateTime getDocumentDate()
Original property name from the Odata EDM: DocumentDate
@Nullable public LocalDateTime getPostingDate()
Original property name from the Odata EDM: PostingDate
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).
@Nullable public LocalDateTime getCreationDate()
Original property name from the Odata EDM: CreationDate
NoteThe posting date can differ from the entry date (date of entry in the system) and the document date.
@Nullable public LocalTime getCreationTime()
Original property name from the Odata EDM: CreationTime
@Nullable public String getCreatedByUser()
Original property name from the Odata EDM: CreatedByUser
@Nullable public String getMaterialDocumentHeaderText()
Original property name from the Odata EDM: MaterialDocumentHeaderText
@Nullable public String getReferenceDocument()
Original property name from the Odata EDM: ReferenceDocument
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 "*".
@Nullable public String getGoodsMovementCode()
Original property name from the Odata EDM: GoodsMovementCode
public String toString()
toString
in class VdmObject<MaterialDocumentHeader>
public boolean equals(Object o)
equals
in class VdmObject<MaterialDocumentHeader>
protected boolean canEqual(Object other)
canEqual
in class VdmObject<MaterialDocumentHeader>
public int hashCode()
hashCode
in class VdmObject<MaterialDocumentHeader>
Copyright © 2019 SAP SE. All rights reserved.