Package com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.paymentrequisition

Class Requisition

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<Requisition>
com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.paymentrequisition.Requisition
All Implemented Interfaces:
VdmEntitySet
public class Requisition extends VdmEntity<Requisition> implements VdmEntitySet
Payment Requisitions

Original entity name from the Odata EDM: RequisitionType

  • Field Details

  • Constructor Details

  • Method Details

    • getType

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

    • setPaymentRequisitionUUID

      public void setPaymentRequisitionUUID(@Nullable UUID paymentRequisitionUUID)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: PaymentRequisitionUUID

      Parameters:
      paymentRequisitionUUID - Payment Requisition UUID

    • setPaymentRequisitionNumber

      public void setPaymentRequisitionNumber(@Nullable String paymentRequisitionNumber)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: PaymentRequisitionNumber

      Parameters:
      paymentRequisitionNumber - Payment Requisition Number

    • setCompanyCode

      public void setCompanyCode(@Nullable String companyCode)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: CompanyCode

      Parameters:
      companyCode - Company Code

    • setSupplier

      public void setSupplier(@Nullable String supplier)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: Supplier

      Parameters:
      supplier - Account Number of Supplier

    • setPaymentRequisitionStatus

      public void setPaymentRequisitionStatus(@Nullable String paymentRequisitionStatus)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: PaymentRequisitionStatus

      Parameters:
      paymentRequisitionStatus - Payment Requisition Status

    • setPlannedPaymentDate

      public void setPlannedPaymentDate(@Nullable LocalDate plannedPaymentDate)
      Constraints: Nullable

      Original property name from the Odata EDM: PlannedPaymentDate

      Parameters:
      plannedPaymentDate - Planned Payment Date

    • setPaymentRequisitionPriority

      public void setPaymentRequisitionPriority(@Nullable String paymentRequisitionPriority)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PaymentRequisitionPriority

      Parameters:
      paymentRequisitionPriority - Priority

    • setPaytRequisitionAmtInTransCrcy

      public void setPaytRequisitionAmtInTransCrcy(@Nullable BigDecimal paytRequisitionAmtInTransCrcy)
      Constraints: Not nullable, Precision: 23, Scale: 0

      Original property name from the Odata EDM: PaytRequisitionAmtInTransCrcy

      Parameters:
      paytRequisitionAmtInTransCrcy - Payment Requisition Amount

    • setCurrency

      public void setCurrency(@Nullable String currency)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: Currency

      Parameters:
      currency - Currency Key

    • setPaymentRequisitionType

      public void setPaymentRequisitionType(@Nullable String paymentRequisitionType)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PaymentRequisitionType

      Parameters:
      paymentRequisitionType - Payment Requisition Type

    • setPaymentMethod

      public void setPaymentMethod(@Nullable String paymentMethod)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PaymentMethod

      Parameters:
      paymentMethod - Preferred Payment Method

    • setNoteText

      public void setNoteText(@Nullable String noteText)
      Constraints: Not nullable, Maximum length: 200

      Original property name from the Odata EDM: NoteText

      Parameters:
      noteText - Remark

    • setWorkflowApproverNote

      public void setWorkflowApproverNote(@Nullable String workflowApproverNote)
      Constraints: Not nullable, Maximum length: 200

      Original property name from the Odata EDM: WorkflowApproverNote

      Parameters:
      workflowApproverNote - Reject Reason

    • setPaymentDifferenceReason

      public void setPaymentDifferenceReason(@Nullable String paymentDifferenceReason)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: PaymentDifferenceReason

      Parameters:
      paymentDifferenceReason - Reason Code for Payment Differences

    • setCreationDateTime

      public void setCreationDateTime(@Nullable OffsetDateTime creationDateTime)
      Constraints: Nullable, Precision: 7

      Original property name from the Odata EDM: CreationDateTime

      Parameters:
      creationDateTime - Creation Date and Time

    • setChangedOnDateTime

      public void setChangedOnDateTime(@Nullable OffsetDateTime changedOnDateTime)
      Constraints: Nullable, Precision: 7

      Original property name from the Odata EDM: ChangedOnDateTime

      Parameters:
      changedOnDateTime - Change Date and Time

    • set_Messages

      public void set_Messages(@Nullable Collection<SAP__Message> _Messages)
      Constraints: Not nullable

      Original property name from the Odata EDM: SAP__Messages

      Parameters:
      _Messages - The _Messages to set.

    • getEntityCollection

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

    • getKey

      @Nonnull protected ODataEntityKey getKey()
      Overrides:
      getKey in class VdmObject<Requisition>

    • toMapOfFields

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

    • fromMap

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • getPaymentStrategyIfPresent

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

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

    • setPaymentStrategy

      public void setPaymentStrategy(@Nonnull List<PaymentStrategy> value)
      Overwrites the list of associated PaymentStrategy entities for the loaded navigation property _PaymentStrategy.

      If the navigation property _PaymentStrategy of a queried Requisition 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 PaymentStrategy entities.

    • addPaymentStrategy

      public void addPaymentStrategy(PaymentStrategy... entity)
      Adds elements to the list of associated PaymentStrategy entities. This corresponds to the OData navigation property _PaymentStrategy.

      If the navigation property _PaymentStrategy of a queried Requisition 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 PaymentStrategy entities.

    • getRequisitionItemIfPresent

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

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

    • setRequisitionItem

      public void setRequisitionItem(@Nonnull List<RequisitionItem> value)
      Overwrites the list of associated RequisitionItem entities for the loaded navigation property _RequisitionItem.

      If the navigation property _RequisitionItem of a queried Requisition 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 RequisitionItem entities.

    • addRequisitionItem

      public void addRequisitionItem(RequisitionItem... entity)
      Adds elements to the list of associated RequisitionItem entities. This corresponds to the OData navigation property _RequisitionItem.

      If the navigation property _RequisitionItem of a queried Requisition 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 RequisitionItem entities.

    • approvePaymentRequisition

      @Nonnull public static BoundAction.SingleToSingle<Requisition,Requisition> approvePaymentRequisition()
      Action that can be applied to any entity object of this class.

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

      To execute it use the service.forEntity(entity).applyAction(thisAction) API.

    • rejectPaymentRequisition

      @Nonnull public static BoundAction.SingleToSingle<Requisition,Requisition> rejectPaymentRequisition(@Nonnull String workflowApproverNote)
      Action that can be applied to any entity object of this class.

      Parameters:
      workflowApproverNote - Constraints: Not nullable, Maximum length: 200

      Original parameter name from the Odata EDM: WorkflowApproverNote

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

      To execute it use the service.forEntity(entity).applyAction(thisAction) API.

    • submit

      @Nonnull public static BoundAction.SingleToSingle<Requisition,Requisition> submit()
      Action that can be applied to any entity object of this class.

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

      To execute it use the service.forEntity(entity).applyAction(thisAction) API.

    • builder

      @Nonnull public static Requisition.RequisitionBuilder builder()

    • getPaymentRequisitionUUID

      @Nullable public UUID getPaymentRequisitionUUID()
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: PaymentRequisitionUUID

      Returns:
      Payment Requisition UUID

    • getPaymentRequisitionNumber

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

      Original property name from the Odata EDM: PaymentRequisitionNumber

      Returns:
      Payment Requisition Number

    • getCompanyCode

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

      Original property name from the Odata EDM: CompanyCode

      Returns:
      Company Code

    • getSupplier

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

      Original property name from the Odata EDM: Supplier

      Returns:
      Account Number of Supplier

    • getPaymentRequisitionStatus

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

      Original property name from the Odata EDM: PaymentRequisitionStatus

      Returns:
      Payment Requisition Status

    • getPlannedPaymentDate

      @Nullable public LocalDate getPlannedPaymentDate()
      Constraints: Nullable

      Original property name from the Odata EDM: PlannedPaymentDate

      Returns:
      Planned Payment Date

    • getPaymentRequisitionPriority

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

      Original property name from the Odata EDM: PaymentRequisitionPriority

      Returns:
      Priority

    • getPaytRequisitionAmtInTransCrcy

      @Nullable public BigDecimal getPaytRequisitionAmtInTransCrcy()
      Constraints: Not nullable, Precision: 23, Scale: 0

      Original property name from the Odata EDM: PaytRequisitionAmtInTransCrcy

      Returns:
      Payment Requisition Amount

    • getCurrency

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

      Original property name from the Odata EDM: Currency

      Returns:
      Currency Key

    • getPaymentRequisitionType

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

      Original property name from the Odata EDM: PaymentRequisitionType

      Returns:
      Payment Requisition Type

    • getPaymentMethod

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

      Original property name from the Odata EDM: PaymentMethod

      Returns:
      Preferred Payment Method

    • getNoteText

      @Nullable public String getNoteText()
      Constraints: Not nullable, Maximum length: 200

      Original property name from the Odata EDM: NoteText

      Returns:
      Remark

    • getWorkflowApproverNote

      @Nullable public String getWorkflowApproverNote()
      Constraints: Not nullable, Maximum length: 200

      Original property name from the Odata EDM: WorkflowApproverNote

      Returns:
      Reject Reason

    • getPaymentDifferenceReason

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

      Original property name from the Odata EDM: PaymentDifferenceReason

      Returns:
      Reason Code for Payment Differences

    • getCreationDateTime

      @Nullable public OffsetDateTime getCreationDateTime()
      Constraints: Nullable, Precision: 7

      Original property name from the Odata EDM: CreationDateTime

      Returns:
      Creation Date and Time

    • getChangedOnDateTime

      @Nullable public OffsetDateTime getChangedOnDateTime()
      Constraints: Nullable, Precision: 7

      Original property name from the Odata EDM: ChangedOnDateTime

      Returns:
      Change Date and Time

    • get_Messages

      @Nullable public Collection<SAP__Message> get_Messages()
      Constraints: Not nullable

      Original property name from the Odata EDM: SAP__Messages

      Returns:
      The _Messages contained in this VdmEntity.

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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

    • getOdataType

      public String getOdataType()
      Specified by:
      getOdataType in class VdmObject<Requisition>