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

Class ReservationDocumentHeader

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

Original entity name from the Odata EDM: A_ReservationDocumentHeaderType

  • Field Details

    • ALL_FIELDS

      public static final ReservationDocumentHeaderSelectable ALL_FIELDS
      Selector for all available fields of ReservationDocumentHeader.

    • RESERVATION

      public static final ReservationDocumentHeaderField<String> RESERVATION
      Use with available fluent helpers to apply the Reservation field to query operations.

    • ORDER_ID

      public static final ReservationDocumentHeaderField<String> ORDER_ID
      Use with available fluent helpers to apply the OrderID field to query operations.

    • GOODS_MOVEMENT_TYPE

      public static final ReservationDocumentHeaderField<String> GOODS_MOVEMENT_TYPE
      Use with available fluent helpers to apply the GoodsMovementType field to query operations.

    • COST_CENTER

      public static final ReservationDocumentHeaderField<String> COST_CENTER
      Use with available fluent helpers to apply the CostCenter field to query operations.

    • GOODS_RECIPIENT_NAME

      public static final ReservationDocumentHeaderField<String> GOODS_RECIPIENT_NAME
      Use with available fluent helpers to apply the GoodsRecipientName field to query operations.

    • RESERVATION_DATE

      public static final ReservationDocumentHeaderField<LocalDateTime> RESERVATION_DATE
      Use with available fluent helpers to apply the ReservationDate field to query operations.

    • IS_CHECKED_AGAINST_FACTORY_CAL

      public static final ReservationDocumentHeaderField<Boolean> IS_CHECKED_AGAINST_FACTORY_CAL
      Use with available fluent helpers to apply the IsCheckedAgainstFactoryCal field to query operations.

    • CUSTOMER

      public static final ReservationDocumentHeaderField<String> CUSTOMER
      Use with available fluent helpers to apply the Customer field to query operations.

    • WBS_ELEMENT

      public static final ReservationDocumentHeaderField<String> WBS_ELEMENT
      Use with available fluent helpers to apply the WBSElement field to query operations.

    • CONTROLLING_AREA

      public static final ReservationDocumentHeaderField<String> CONTROLLING_AREA
      Use with available fluent helpers to apply the ControllingArea field to query operations.

    • SALES_ORDER

      public static final ReservationDocumentHeaderField<String> SALES_ORDER
      Use with available fluent helpers to apply the SalesOrder field to query operations.

    • SALES_ORDER_ITEM

      public static final ReservationDocumentHeaderField<String> SALES_ORDER_ITEM
      Use with available fluent helpers to apply the SalesOrderItem field to query operations.

    • SALES_ORDER_SCHEDULE_LINE

      public static final ReservationDocumentHeaderField<String> SALES_ORDER_SCHEDULE_LINE
      Use with available fluent helpers to apply the SalesOrderScheduleLine field to query operations.

    • ASSET_NUMBER

      public static final ReservationDocumentHeaderField<String> ASSET_NUMBER
      Use with available fluent helpers to apply the AssetNumber field to query operations.

    • ASSET_SUB_NUMBER

      public static final ReservationDocumentHeaderField<String> ASSET_SUB_NUMBER
      Use with available fluent helpers to apply the AssetSubNumber field to query operations.

    • NETWORK_NUMBER_FOR_ACCT_ASSGMT

      public static final ReservationDocumentHeaderField<String> NETWORK_NUMBER_FOR_ACCT_ASSGMT
      Use with available fluent helpers to apply the NetworkNumberForAcctAssgmt field to query operations.

    • ISSUING_OR_RECEIVING_PLANT

      public static final ReservationDocumentHeaderField<String> ISSUING_OR_RECEIVING_PLANT
      Use with available fluent helpers to apply the IssuingOrReceivingPlant field to query operations.

    • ISSUING_OR_RECEIVING_STORAGE_LOC

      public static final ReservationDocumentHeaderField<String> ISSUING_OR_RECEIVING_STORAGE_LOC
      Use with available fluent helpers to apply the IssuingOrReceivingStorageLoc field to query operations.

    • TO_RESERVATION_DOCUMENT_ITEM

      public static final ReservationDocumentHeaderLink<ReservationDocumentItem> TO_RESERVATION_DOCUMENT_ITEM
      Use with available fluent helpers to apply the to_ReservationDocumentItem navigation property to query operations.

  • Constructor Details

    • ReservationDocumentHeader

      public ReservationDocumentHeader()

    • ReservationDocumentHeader

      public ReservationDocumentHeader(@Nullable String reservation, @Nullable String orderID, @Nullable String goodsMovementType, @Nullable String costCenter, @Nullable String goodsRecipientName, @Nullable LocalDateTime reservationDate, @Nullable Boolean isCheckedAgainstFactoryCal, @Nullable String customer, @Nullable String wBSElement, @Nullable String controllingArea, @Nullable String salesOrder, @Nullable String salesOrderItem, @Nullable String salesOrderScheduleLine, @Nullable String assetNumber, @Nullable String assetSubNumber, @Nullable String networkNumberForAcctAssgmt, @Nullable String issuingOrReceivingPlant, @Nullable String issuingOrReceivingStorageLoc, List<ReservationDocumentItem> toReservationDocumentItem)

  • Method Details

    • getType

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

    • setReservation

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

      Original property name from the Odata EDM: Reservation

      Parameters:
      reservation - Number of reservation/dependent requirements

    • setOrderID

      public void setOrderID(@Nullable String orderID)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: OrderID

      Parameters:
      orderID - Order Number

    • setGoodsMovementType

      public void setGoodsMovementType(@Nullable String goodsMovementType)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: GoodsMovementType

      Parameters:
      goodsMovementType - Movement Type (Inventory Management)

    • setCostCenter

      public void setCostCenter(@Nullable String costCenter)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: CostCenter

      Parameters:
      costCenter - Cost Center

    • setGoodsRecipientName

      public void setGoodsRecipientName(@Nullable String goodsRecipientName)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: GoodsRecipientName

      Parameters:
      goodsRecipientName - Goods Recipient

    • setReservationDate

      public void setReservationDate(@Nullable LocalDateTime reservationDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ReservationDate

      Parameters:
      reservationDate - Base date for reservation

    • setIsCheckedAgainstFactoryCal

      public void setIsCheckedAgainstFactoryCal(@Nullable Boolean isCheckedAgainstFactoryCal)
      Constraints: none

      Original property name from the Odata EDM: IsCheckedAgainstFactoryCal

      Parameters:
      isCheckedAgainstFactoryCal - Check date against factory calendar

    • setCustomer

      public void setCustomer(@Nullable String customer)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: Customer

      Parameters:
      customer - Account number of customer

    • setWBSElement

      public void setWBSElement(@Nullable String wBSElement)
      Constraints: Not nullable, Maximum length: 24

      Original property name from the Odata EDM: WBSElement

      Parameters:
      wBSElement - Work Breakdown Structure Element (WBS Element)

    • setControllingArea

      public void setControllingArea(@Nullable String controllingArea)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: ControllingArea

      Parameters:
      controllingArea - Controlling Area

    • setSalesOrder

      public void setSalesOrder(@Nullable String salesOrder)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: SalesOrder

      Parameters:
      salesOrder - Sales Order Number

    • setSalesOrderItem

      public void setSalesOrderItem(@Nullable String salesOrderItem)
      Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: SalesOrderItem

      Parameters:
      salesOrderItem - Item Number in Sales Order

    • setSalesOrderScheduleLine

      public void setSalesOrderScheduleLine(@Nullable String salesOrderScheduleLine)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SalesOrderScheduleLine

      Parameters:
      salesOrderScheduleLine - Delivery schedule for sales order

    • setAssetNumber

      public void setAssetNumber(@Nullable String assetNumber)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: AssetNumber

      Parameters:
      assetNumber - Main Asset Number

    • setAssetSubNumber

      public void setAssetSubNumber(@Nullable String assetSubNumber)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: AssetSubNumber

      Parameters:
      assetSubNumber - Asset Subnumber

    • setNetworkNumberForAcctAssgmt

      public void setNetworkNumberForAcctAssgmt(@Nullable String networkNumberForAcctAssgmt)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: NetworkNumberForAcctAssgmt

      Parameters:
      networkNumberForAcctAssgmt - Network Number for Account Assignment

    • setIssuingOrReceivingPlant

      public void setIssuingOrReceivingPlant(@Nullable String issuingOrReceivingPlant)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: IssuingOrReceivingPlant

      Parameters:
      issuingOrReceivingPlant - Receiving plant/issuing plant

    • setIssuingOrReceivingStorageLoc

      public void setIssuingOrReceivingStorageLoc(@Nullable String issuingOrReceivingStorageLoc)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: IssuingOrReceivingStorageLoc

      Parameters:
      issuingOrReceivingStorageLoc - Receiving/issuing storage location

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> ReservationDocumentHeaderField<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> ReservationDocumentHeaderField<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<ReservationDocumentHeader>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchReservationDocumentItem

      @Nonnull public List<ReservationDocumentItem> fetchReservationDocumentItem()
      Fetches the ReservationDocumentItem entities (one to many) associated with this entity. This corresponds to the OData navigation property to_ReservationDocumentItem.

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

      Returns:
      List containing one or more associated ReservationDocumentItem 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.

    • getReservationDocumentItemOrFetch

      @Nonnull public List<ReservationDocumentItem> getReservationDocumentItemOrFetch()
      Retrieval of associated ReservationDocumentItem entities (one to many). This corresponds to the OData navigation property to_ReservationDocumentItem.

      If the navigation property to_ReservationDocumentItem of a queried ReservationDocumentHeader 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 ReservationDocumentItem 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.

    • getReservationDocumentItemIfPresent

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

      If the navigation property for an entity ReservationDocumentHeader 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_ReservationDocumentItem is already loaded, the result will contain the ReservationDocumentItem entities. If not, an Option with result state empty is returned.

    • setReservationDocumentItem

      public void setReservationDocumentItem(@Nonnull List<ReservationDocumentItem> value)
      Overwrites the list of associated ReservationDocumentItem entities for the loaded navigation property to_ReservationDocumentItem.

      If the navigation property to_ReservationDocumentItem of a queried ReservationDocumentHeader 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 ReservationDocumentItem entities.

    • addReservationDocumentItem

      public void addReservationDocumentItem(ReservationDocumentItem... entity)
      Adds elements to the list of associated ReservationDocumentItem entities. This corresponds to the OData navigation property to_ReservationDocumentItem.

      If the navigation property to_ReservationDocumentItem of a queried ReservationDocumentHeader 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 ReservationDocumentItem entities.

    • builder

      @Nonnull public static ReservationDocumentHeader.ReservationDocumentHeaderBuilder builder()

    • getReservation

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

      Original property name from the Odata EDM: Reservation

      Returns:
      Number of reservation/dependent requirements

    • getOrderID

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

      Original property name from the Odata EDM: OrderID

      Returns:
      Order Number

    • getGoodsMovementType

      @Nullable public String getGoodsMovementType()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: GoodsMovementType

      Returns:
      Movement Type (Inventory Management)

    • getCostCenter

      @Nullable public String getCostCenter()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: CostCenter

      Returns:
      Cost Center

    • getGoodsRecipientName

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

      Original property name from the Odata EDM: GoodsRecipientName

      Returns:
      Goods Recipient

    • getReservationDate

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

      Original property name from the Odata EDM: ReservationDate

      Returns:
      Base date for reservation

    • getIsCheckedAgainstFactoryCal

      @Nullable public Boolean getIsCheckedAgainstFactoryCal()
      Constraints: none

      Original property name from the Odata EDM: IsCheckedAgainstFactoryCal

      Returns:
      Check date against factory calendar

    • getCustomer

      @Nullable public String getCustomer()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: Customer

      Returns:
      Account number of customer

    • getWBSElement

      @Nullable public String getWBSElement()
      Constraints: Not nullable, Maximum length: 24

      Original property name from the Odata EDM: WBSElement

      Returns:
      Work Breakdown Structure Element (WBS Element)

    • getControllingArea

      @Nullable public String getControllingArea()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: ControllingArea

      Returns:
      Controlling Area

    • getSalesOrder

      @Nullable public String getSalesOrder()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: SalesOrder

      Returns:
      Sales Order Number

    • getSalesOrderItem

      @Nullable public String getSalesOrderItem()
      Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: SalesOrderItem

      Returns:
      Item Number in Sales Order

    • getSalesOrderScheduleLine

      @Nullable public String getSalesOrderScheduleLine()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SalesOrderScheduleLine

      Returns:
      Delivery schedule for sales order

    • getAssetNumber

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

      Original property name from the Odata EDM: AssetNumber

      Returns:
      Main Asset Number

    • getAssetSubNumber

      @Nullable public String getAssetSubNumber()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: AssetSubNumber

      Returns:
      Asset Subnumber

    • getNetworkNumberForAcctAssgmt

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

      Original property name from the Odata EDM: NetworkNumberForAcctAssgmt

      Returns:
      Network Number for Account Assignment

    • getIssuingOrReceivingPlant

      @Nullable public String getIssuingOrReceivingPlant()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: IssuingOrReceivingPlant

      Returns:
      Receiving plant/issuing plant

    • getIssuingOrReceivingStorageLoc

      @Nullable public String getIssuingOrReceivingStorageLoc()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: IssuingOrReceivingStorageLoc

      Returns:
      Receiving/issuing storage location

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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