Package com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialdocument

Class MaterialDocumentHeader

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<MaterialDocumentHeader>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialdocument.MaterialDocumentHeader
public class MaterialDocumentHeader extends VdmEntity<MaterialDocumentHeader>
Document Header

Original entity name from the Odata EDM: A_MaterialDocumentHeaderType

  • Field Details

    • 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<LocalDateTime> DOCUMENT_DATE
      Use with available fluent helpers to apply the DocumentDate field to query operations.

    • POSTING_DATE

      public static final MaterialDocumentHeaderField<LocalDateTime> POSTING_DATE
      Use with available fluent helpers to apply the PostingDate field to query operations.

    • CREATION_DATE

      public static final MaterialDocumentHeaderField<LocalDateTime> CREATION_DATE
      Use with available fluent helpers to apply the CreationDate field to query operations.

    • CREATION_TIME

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

    • VERSION_FOR_PRINTING_SLIP

      public static final MaterialDocumentHeaderField<String> VERSION_FOR_PRINTING_SLIP
      Use with available fluent helpers to apply the VersionForPrintingSlip field to query operations.

    • MANUAL_PRINT_IS_TRIGGERED

      public static final MaterialDocumentHeaderField<String> MANUAL_PRINT_IS_TRIGGERED
      Use with available fluent helpers to apply the ManualPrintIsTriggered field to query operations.

    • CTRL_POSTG_FOR_EXT_WHSE_MGMT_SYST

      public static final MaterialDocumentHeaderField<String> CTRL_POSTG_FOR_EXT_WHSE_MGMT_SYST
      Use with available fluent helpers to apply the CtrlPostgForExtWhseMgmtSyst 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 Details

    • MaterialDocumentHeader

      public MaterialDocumentHeader()

    • 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 versionForPrintingSlip, @Nullable String manualPrintIsTriggered, @Nullable String ctrlPostgForExtWhseMgmtSyst, @Nullable String goodsMovementCode, List<MaterialDocumentItem> toMaterialDocumentItem)

  • Method Details

    • getType

      @Nonnull public Class<MaterialDocumentHeader> getType()
      Specified by:
      getType in class VdmObject<MaterialDocumentHeader>

    • setMaterialDocumentYear

      public void setMaterialDocumentYear(@Nullable String materialDocumentYear)
      (Key Field) Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: MaterialDocumentYear

      Parameters:
      materialDocumentYear - Material Document Year

    • setMaterialDocument

      public void setMaterialDocument(@Nullable String materialDocument)
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: MaterialDocument

      Parameters:
      materialDocument - Number of Material Document

    • setInventoryTransactionType

      public void setInventoryTransactionType(@Nullable String inventoryTransactionType)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: InventoryTransactionType

      Parameters:
      inventoryTransactionType - Transaction/Event Type

    • setDocumentDate

      public void setDocumentDate(@Nullable LocalDateTime documentDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: DocumentDate

      Parameters:
      documentDate - Document Date in Document

    • setPostingDate

      public void setPostingDate(@Nullable LocalDateTime postingDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: PostingDate

      Parameters:
      postingDate - Posting Date in the Document

    • setCreationDate

      public void setCreationDate(@Nullable LocalDateTime creationDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: CreationDate

      Parameters:
      creationDate - Day On Which Accounting Document Was Entered

    • setCreationTime

      public void setCreationTime(@Nullable LocalTime creationTime)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: CreationTime

      Parameters:
      creationTime - Time of Entry

    • setCreatedByUser

      public void setCreatedByUser(@Nullable String createdByUser)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: CreatedByUser

      Parameters:
      createdByUser - User Name

    • setMaterialDocumentHeaderText

      public void setMaterialDocumentHeaderText(@Nullable String materialDocumentHeaderText)
      Constraints: Not nullable, Maximum length: 25

      Original property name from the Odata EDM: MaterialDocumentHeaderText

      Parameters:
      materialDocumentHeaderText - Document Header Text

    • setReferenceDocument

      public void setReferenceDocument(@Nullable String referenceDocument)
      Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: ReferenceDocument

      Parameters:
      referenceDocument - Reference Document Number

    • setVersionForPrintingSlip

      public void setVersionForPrintingSlip(@Nullable String versionForPrintingSlip)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: VersionForPrintingSlip

      Parameters:
      versionForPrintingSlip - Version for Printing GR/GI Slip

    • setManualPrintIsTriggered

      public void setManualPrintIsTriggered(@Nullable String manualPrintIsTriggered)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: ManualPrintIsTriggered

      Parameters:
      manualPrintIsTriggered - Print via Output Control

    • setCtrlPostgForExtWhseMgmtSyst

      public void setCtrlPostgForExtWhseMgmtSyst(@Nullable String ctrlPostgForExtWhseMgmtSyst)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: CtrlPostgForExtWhseMgmtSyst

      Parameters:
      ctrlPostgForExtWhseMgmtSyst - Control posting for external WMS

    • setGoodsMovementCode

      public void setGoodsMovementCode(@Nullable String goodsMovementCode)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: GoodsMovementCode

      Parameters:
      goodsMovementCode - Goods Movement Code

    • getEntityCollection

      protected String getEntityCollection()
      Specified by:
      getEntityCollection in class VdmEntity<MaterialDocumentHeader>

    • getKey

      @Nonnull protected Map<String,Object> getKey()
      Overrides:
      getKey in class VdmObject<MaterialDocumentHeader>

    • toMapOfFields

      @Nonnull protected Map<String,Object> toMapOfFields()
      Overrides:
      toMapOfFields in class VdmObject<MaterialDocumentHeader>

    • fromMap

      protected void fromMap(Map<String,Object> inputValues)
      Overrides:
      fromMap in class VdmObject<MaterialDocumentHeader>

    • field

      @Nonnull public static <T> MaterialDocumentHeaderField<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> MaterialDocumentHeaderField<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<T, DomainT> 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.

    • getDestinationForFetch

      @Nullable public HttpDestinationProperties getDestinationForFetch()
      Overrides:
      getDestinationForFetch in class VdmEntity<MaterialDocumentHeader>

    • setServicePathForFetch

      protected void setServicePathForFetch(@Nullable String servicePathForFetch)
      Overrides:
      setServicePathForFetch in class VdmEntity<MaterialDocumentHeader>

    • attachToService

      public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
      Overrides:
      attachToService in class VdmEntity<MaterialDocumentHeader>

    • getDefaultServicePath

      protected String getDefaultServicePath()
      Overrides:
      getDefaultServicePath in class VdmEntity<MaterialDocumentHeader>

    • toMapOfNavigationProperties

      @Nonnull protected Map<String,Object> toMapOfNavigationProperties()
      Overrides:
      toMapOfNavigationProperties in class VdmObject<MaterialDocumentHeader>

    • fetchMaterialDocumentItem

      @Nonnull public List<MaterialDocumentItem> fetchMaterialDocumentItem()
      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.datamodel.odata.client.exception.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

      @Nonnull public List<MaterialDocumentItem> getMaterialDocumentItemOrFetch()
      Retrieval of associated MaterialDocumentItem entities (one to many). This corresponds to the OData 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.

      Returns:
      List of associated MaterialDocumentItem entities.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.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.

    • getMaterialDocumentItemIfPresent

      @Nonnull public io.vavr.control.Option<List<MaterialDocumentItem>> getMaterialDocumentItemIfPresent()
      Retrieval of associated MaterialDocumentItem entities (one to many). This corresponds to the OData navigation property to_MaterialDocumentItem.

      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.

      Returns:
      If the information for navigation property to_MaterialDocumentItem is already loaded, the result will contain the MaterialDocumentItem entities. If not, an Option with result state empty 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. This corresponds to the OData 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:
      entity - Array of MaterialDocumentItem entities.

    • builder

      @Nonnull public static MaterialDocumentHeader.MaterialDocumentHeaderBuilder builder()

    • getMaterialDocumentYear

      @Nullable public String getMaterialDocumentYear()
      (Key Field) Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: MaterialDocumentYear

      Returns:
      Material Document Year

    • getMaterialDocument

      @Nullable public String getMaterialDocument()
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: MaterialDocument

      Returns:
      Number of Material Document

    • getInventoryTransactionType

      @Nullable public String getInventoryTransactionType()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: InventoryTransactionType

      Returns:
      Transaction/Event Type

    • getDocumentDate

      @Nullable public LocalDateTime getDocumentDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: DocumentDate

      Returns:
      Document Date in Document

    • getPostingDate

      @Nullable public LocalDateTime getPostingDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: PostingDate

      Returns:
      Posting Date in the Document

    • getCreationDate

      @Nullable public LocalDateTime getCreationDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: CreationDate

      Returns:
      Day On Which Accounting Document Was Entered

    • getCreationTime

      @Nullable public LocalTime getCreationTime()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: CreationTime

      Returns:
      Time of Entry

    • getCreatedByUser

      @Nullable public String getCreatedByUser()
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: CreatedByUser

      Returns:
      User Name

    • getMaterialDocumentHeaderText

      @Nullable public String getMaterialDocumentHeaderText()
      Constraints: Not nullable, Maximum length: 25

      Original property name from the Odata EDM: MaterialDocumentHeaderText

      Returns:
      Document Header Text

    • getReferenceDocument

      @Nullable public String getReferenceDocument()
      Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: ReferenceDocument

      Returns:
      Reference Document Number

    • getVersionForPrintingSlip

      @Nullable public String getVersionForPrintingSlip()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: VersionForPrintingSlip

      Returns:
      Version for Printing GR/GI Slip

    • getManualPrintIsTriggered

      @Nullable public String getManualPrintIsTriggered()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: ManualPrintIsTriggered

      Returns:
      Print via Output Control

    • getCtrlPostgForExtWhseMgmtSyst

      @Nullable public String getCtrlPostgForExtWhseMgmtSyst()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: CtrlPostgForExtWhseMgmtSyst

      Returns:
      Control posting for external WMS

    • getGoodsMovementCode

      @Nullable public String getGoodsMovementCode()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: GoodsMovementCode

      Returns:
      Goods Movement Code

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class VdmObject<MaterialDocumentHeader>

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class VdmEntity<MaterialDocumentHeader>

    • canEqual

      protected boolean canEqual(@Nullable Object other)
      Overrides:
      canEqual in class VdmEntity<MaterialDocumentHeader>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class VdmEntity<MaterialDocumentHeader>