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

Class LockboxBatch

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<LockboxBatch>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.postlockbox.LockboxBatch
public class LockboxBatch extends VdmEntity<LockboxBatch>
Lockbox Batch

Original entity name from the Odata EDM: LockboxBatchType

  • Field Details

    • ALL_FIELDS

      public static final LockboxBatchSelectable ALL_FIELDS
      Selector for all available fields of LockboxBatch.

    • LOCKBOX_BATCH_INTERNAL_KEY

      public static final LockboxBatchField<String> LOCKBOX_BATCH_INTERNAL_KEY
      Use with available fluent helpers to apply the LockboxBatchInternalKey field to query operations.

    • LOCKBOX_BATCH

      public static final LockboxBatchField<String> LOCKBOX_BATCH
      Use with available fluent helpers to apply the LockboxBatch field to query operations.

    • LOCKBOX

      public static final LockboxBatchField<String> LOCKBOX
      Use with available fluent helpers to apply the Lockbox field to query operations.

    • COMPANY_CODE

      public static final LockboxBatchField<String> COMPANY_CODE
      Use with available fluent helpers to apply the CompanyCode field to query operations.

    • LOCKBOX_BATCH_DESTINATION

      public static final LockboxBatchField<String> LOCKBOX_BATCH_DESTINATION
      Use with available fluent helpers to apply the LockboxBatchDestination field to query operations.

    • LOCKBOX_BATCH_ORIGIN

      public static final LockboxBatchField<String> LOCKBOX_BATCH_ORIGIN
      Use with available fluent helpers to apply the LockboxBatchOrigin field to query operations.

    • DEPOSIT_DATE_TIME

      public static final LockboxBatchField<ZonedDateTime> DEPOSIT_DATE_TIME
      Use with available fluent helpers to apply the DepositDateTime field to query operations.

    • INCOMING_PAYMENT_FILE

      public static final LockboxBatchField<String> INCOMING_PAYMENT_FILE
      Use with available fluent helpers to apply the IncomingPaymentFile field to query operations.

    • LOCKBOX_BATCH_STATUS

      public static final LockboxBatchField<String> LOCKBOX_BATCH_STATUS
      Use with available fluent helpers to apply the LockboxBatchStatus field to query operations.

    • LOCKBOX_BATCH_STATUS_NAME

      public static final LockboxBatchField<String> LOCKBOX_BATCH_STATUS_NAME
      Use with available fluent helpers to apply the LockboxBatchStatusName field to query operations.

    • NUMBER_OF_ITEMS

      public static final LockboxBatchField<Short> NUMBER_OF_ITEMS
      Use with available fluent helpers to apply the NumberOfItems field to query operations.

    • CURRENCY

      public static final LockboxBatchField<String> CURRENCY
      Use with available fluent helpers to apply the Currency field to query operations.

    • AMOUNT_IN_TRANSACTION_CURRENCY

      public static final LockboxBatchField<BigDecimal> AMOUNT_IN_TRANSACTION_CURRENCY
      Use with available fluent helpers to apply the AmountInTransactionCurrency field to query operations.

    • NUMBER_OF_INCOMPLETE_CHEQUES

      public static final LockboxBatchField<Short> NUMBER_OF_INCOMPLETE_CHEQUES
      Use with available fluent helpers to apply the NumberOfIncompleteCheques field to query operations.

    • BATCH_IS_LATEST

      public static final LockboxBatchField<String> BATCH_IS_LATEST
      Use with available fluent helpers to apply the BatchIsLatest field to query operations.

    • JOURNAL_ENTRY_IS_NOT_TO_BE_POSTED

      public static final LockboxBatchField<String> JOURNAL_ENTRY_IS_NOT_TO_BE_POSTED
      Use with available fluent helpers to apply the JournalEntryIsNotToBePosted field to query operations.

    • TO_ITEM

      public static final LockboxBatchLink<LockboxBatchItem> TO_ITEM
      Use with available fluent helpers to apply the to_Item navigation property to query operations.

  • Constructor Details

    • LockboxBatch

      public LockboxBatch()

    • LockboxBatch

      public LockboxBatch(@Nullable String lockboxBatchInternalKey, @Nullable String lockboxBatch, @Nullable String lockbox, @Nullable String companyCode, @Nullable String lockboxBatchDestination, @Nullable String lockboxBatchOrigin, @Nullable ZonedDateTime depositDateTime, @Nullable String incomingPaymentFile, @Nullable String lockboxBatchStatus, @Nullable String lockboxBatchStatusName, @Nullable Short numberOfItems, @Nullable String currency, @Nullable BigDecimal amountInTransactionCurrency, @Nullable Short numberOfIncompleteCheques, @Nullable String batchIsLatest, @Nullable String journalEntryIsNotToBePosted, List<LockboxBatchItem> toItem)

  • Method Details

    • getType

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

    • setLockboxBatchInternalKey

      public void setLockboxBatchInternalKey(@Nullable String lockboxBatchInternalKey)
      (Key Field) Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: LockboxBatchInternalKey

      Parameters:
      lockboxBatchInternalKey - Short Key for Bank Statement (Surrogate Key)

    • setLockboxBatch

      public void setLockboxBatch(@Nullable String lockboxBatch)
      (Key Field) Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: LockboxBatch

      Parameters:
      lockboxBatch - Batch number (bundle number)

    • setLockbox

      public void setLockbox(@Nullable String lockbox)
      Constraints: Not nullable, Maximum length: 7

      Original property name from the Odata EDM: Lockbox

      Parameters:
      lockbox - Lockbox 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

    • setLockboxBatchDestination

      public void setLockboxBatchDestination(@Nullable String lockboxBatchDestination)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: LockboxBatchDestination

      Parameters:
      lockboxBatchDestination - The lockboxBatchDestination to set.

    • setLockboxBatchOrigin

      public void setLockboxBatchOrigin(@Nullable String lockboxBatchOrigin)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: LockboxBatchOrigin

      Parameters:
      lockboxBatchOrigin - The lockboxBatchOrigin to set.

    • setDepositDateTime

      public void setDepositDateTime(@Nullable ZonedDateTime depositDateTime)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: DepositDateTime

      Parameters:
      depositDateTime - Deposit Date and Time

    • setIncomingPaymentFile

      public void setIncomingPaymentFile(@Nullable String incomingPaymentFile)
      Constraints: Not nullable, Maximum length: 14

      Original property name from the Odata EDM: IncomingPaymentFile

      Parameters:
      incomingPaymentFile - Incoming Payment File ID

    • setLockboxBatchStatus

      public void setLockboxBatchStatus(@Nullable String lockboxBatchStatus)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: LockboxBatchStatus

      Parameters:
      lockboxBatchStatus - Lockbox Batch Status Code

    • setLockboxBatchStatusName

      public void setLockboxBatchStatusName(@Nullable String lockboxBatchStatusName)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: LockboxBatchStatusName

      Parameters:
      lockboxBatchStatusName - Lockbox Batch Status Description

    • setNumberOfItems

      public void setNumberOfItems(@Nullable Short numberOfItems)
      Constraints: none

      Original property name from the Odata EDM: NumberOfItems

      Parameters:
      numberOfItems - Number of Checks in Lockbox Batch

    • setCurrency

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

      Original property name from the Odata EDM: Currency

      Parameters:
      currency - The currency to set.

    • setAmountInTransactionCurrency

      public void setAmountInTransactionCurrency(@Nullable BigDecimal amountInTransactionCurrency)
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: AmountInTransactionCurrency

      Parameters:
      amountInTransactionCurrency - Payment Amount

    • setNumberOfIncompleteCheques

      public void setNumberOfIncompleteCheques(@Nullable Short numberOfIncompleteCheques)
      Constraints: none

      Original property name from the Odata EDM: NumberOfIncompleteCheques

      Parameters:
      numberOfIncompleteCheques - Number of Incomplete Cheques in Lockbox Batch

    • setBatchIsLatest

      public void setBatchIsLatest(@Nullable String batchIsLatest)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: BatchIsLatest

      Parameters:
      batchIsLatest - Latest Lockbox Batch

    • setJournalEntryIsNotToBePosted

      public void setJournalEntryIsNotToBePosted(@Nullable String journalEntryIsNotToBePosted)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: JournalEntryIsNotToBePosted

      Parameters:
      journalEntryIsNotToBePosted - The journalEntryIsNotToBePosted to set.

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> LockboxBatchField<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> LockboxBatchField<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<LockboxBatch>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchItem

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

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

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

    • getItemOrFetch

      @Nonnull public List<LockboxBatchItem> getItemOrFetch()
      Retrieval of associated LockboxBatchItem entities (one to many). This corresponds to the OData navigation property to_Item.

      If the navigation property to_Item of a queried LockboxBatch 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 LockboxBatchItem 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.

    • getItemIfPresent

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

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

    • setItem

      public void setItem(@Nonnull List<LockboxBatchItem> value)
      Overwrites the list of associated LockboxBatchItem entities for the loaded navigation property to_Item.

      If the navigation property to_Item of a queried LockboxBatch 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 LockboxBatchItem entities.

    • addItem

      public void addItem(LockboxBatchItem... entity)
      Adds elements to the list of associated LockboxBatchItem entities. This corresponds to the OData navigation property to_Item.

      If the navigation property to_Item of a queried LockboxBatch 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 LockboxBatchItem entities.

    • builder

      @Nonnull public static LockboxBatch.LockboxBatchBuilder builder()

    • getLockboxBatchInternalKey

      @Nullable public String getLockboxBatchInternalKey()
      (Key Field) Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: LockboxBatchInternalKey

      Returns:
      Short Key for Bank Statement (Surrogate Key)

    • getLockboxBatch

      @Nullable public String getLockboxBatch()
      (Key Field) Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: LockboxBatch

      Returns:
      Batch number (bundle number)

    • getLockbox

      @Nullable public String getLockbox()
      Constraints: Not nullable, Maximum length: 7

      Original property name from the Odata EDM: Lockbox

      Returns:
      Lockbox Number

    • getCompanyCode

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

      Original property name from the Odata EDM: CompanyCode

      Returns:
      Company Code

    • getLockboxBatchDestination

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

      Original property name from the Odata EDM: LockboxBatchDestination

      Returns:
      The lockboxBatchDestination contained in this entity.

    • getLockboxBatchOrigin

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

      Original property name from the Odata EDM: LockboxBatchOrigin

      Returns:
      The lockboxBatchOrigin contained in this entity.

    • getDepositDateTime

      @Nullable public ZonedDateTime getDepositDateTime()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: DepositDateTime

      Returns:
      Deposit Date and Time

    • getIncomingPaymentFile

      @Nullable public String getIncomingPaymentFile()
      Constraints: Not nullable, Maximum length: 14

      Original property name from the Odata EDM: IncomingPaymentFile

      Returns:
      Incoming Payment File ID

    • getLockboxBatchStatus

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

      Original property name from the Odata EDM: LockboxBatchStatus

      Returns:
      Lockbox Batch Status Code

    • getLockboxBatchStatusName

      @Nullable public String getLockboxBatchStatusName()
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: LockboxBatchStatusName

      Returns:
      Lockbox Batch Status Description

    • getNumberOfItems

      @Nullable public Short getNumberOfItems()
      Constraints: none

      Original property name from the Odata EDM: NumberOfItems

      Returns:
      Number of Checks in Lockbox Batch

    • getCurrency

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

      Original property name from the Odata EDM: Currency

      Returns:
      The currency contained in this entity.

    • getAmountInTransactionCurrency

      @Nullable public BigDecimal getAmountInTransactionCurrency()
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: AmountInTransactionCurrency

      Returns:
      Payment Amount

    • getNumberOfIncompleteCheques

      @Nullable public Short getNumberOfIncompleteCheques()
      Constraints: none

      Original property name from the Odata EDM: NumberOfIncompleteCheques

      Returns:
      Number of Incomplete Cheques in Lockbox Batch

    • getBatchIsLatest

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

      Original property name from the Odata EDM: BatchIsLatest

      Returns:
      Latest Lockbox Batch

    • getJournalEntryIsNotToBePosted

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

      Original property name from the Odata EDM: JournalEntryIsNotToBePosted

      Returns:
      The journalEntryIsNotToBePosted contained in this entity.

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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