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

Class SAP__DocumentDescription

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<SAP__DocumentDescription>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.SAP__DocumentDescription
public class SAP__DocumentDescription extends VdmEntity<SAP__DocumentDescription>

Original entity name from the Odata EDM: SAP__DocumentDescription

  • Field Details

  • Constructor Details

  • Method Details

    • getType

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

    • setId

      public void setId(@Nullable UUID id)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: Id

      Parameters:
      id - UUID

    • setCreatedBy

      public void setCreatedBy(@Nullable String createdBy)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: CreatedBy

      Parameters:
      createdBy - The createdBy to set.

    • setCreatedAt

      public void setCreatedAt(@Nullable LocalDateTime createdAt)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: CreatedAt

      Parameters:
      createdAt - Time Stamp

    • setFileName

      public void setFileName(@Nullable String fileName)
      Constraints: Not nullable, Maximum length: 256

      Original property name from the Odata EDM: FileName

      Parameters:
      fileName - The fileName to set.

    • setTitle

      public void setTitle(@Nullable String title)
      Constraints: Not nullable, Maximum length: 256

      Original property name from the Odata EDM: Title

      Parameters:
      title - The title to set.

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> SAP__DocumentDescriptionField<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> SAP__DocumentDescriptionField<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<SAP__DocumentDescription>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchFormat

      @Nullable public SAP__Format fetchFormat()
      Fetches the SAP__Format entity (one to one) associated with this entity. This corresponds to the OData navigation property Format.

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

      Returns:
      The single associated SAP__Format entity, or null if an entity is not associated.
      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.

    • getFormatOrFetch

      @Nullable public SAP__Format getFormatOrFetch()
      Retrieval of associated SAP__Format entity (one to one). This corresponds to the OData navigation property Format.

      If the navigation property Format of a queried SAP__DocumentDescription 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 SAP__Format entity.
      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.

    • getFormatIfPresent

      @Nonnull public io.vavr.control.Option<SAP__Format> getFormatIfPresent()
      Retrieval of associated SAP__Format entity (one to one). This corresponds to the OData navigation property Format.

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

    • setFormat

      public void setFormat(SAP__Format value)
      Overwrites the associated SAP__Format entity for the loaded navigation property Format.
      Parameters:
      value - New SAP__Format entity.

    • fetchTableColumns

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

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

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

    • getTableColumnsOrFetch

      @Nonnull public List<SAP__TableColumns> getTableColumnsOrFetch()
      Retrieval of associated SAP__TableColumns entities (one to many). This corresponds to the OData navigation property TableColumns.

      If the navigation property TableColumns of a queried SAP__DocumentDescription 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 SAP__TableColumns 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.

    • getTableColumnsIfPresent

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

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

    • setTableColumns

      public void setTableColumns(@Nonnull List<SAP__TableColumns> value)
      Overwrites the list of associated SAP__TableColumns entities for the loaded navigation property TableColumns.

      If the navigation property TableColumns of a queried SAP__DocumentDescription 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 SAP__TableColumns entities.

    • addTableColumns

      public void addTableColumns(SAP__TableColumns... entity)
      Adds elements to the list of associated SAP__TableColumns entities. This corresponds to the OData navigation property TableColumns.

      If the navigation property TableColumns of a queried SAP__DocumentDescription 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 SAP__TableColumns entities.

    • fetchCoverPage

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

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

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

    • getCoverPageOrFetch

      @Nonnull public List<SAP__CoverPage> getCoverPageOrFetch()
      Retrieval of associated SAP__CoverPage entities (one to many). This corresponds to the OData navigation property CoverPage.

      If the navigation property CoverPage of a queried SAP__DocumentDescription 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 SAP__CoverPage 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.

    • getCoverPageIfPresent

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

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

    • setCoverPage

      public void setCoverPage(@Nonnull List<SAP__CoverPage> value)
      Overwrites the list of associated SAP__CoverPage entities for the loaded navigation property CoverPage.

      If the navigation property CoverPage of a queried SAP__DocumentDescription 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 SAP__CoverPage entities.

    • addCoverPage

      public void addCoverPage(SAP__CoverPage... entity)
      Adds elements to the list of associated SAP__CoverPage entities. This corresponds to the OData navigation property CoverPage.

      If the navigation property CoverPage of a queried SAP__DocumentDescription 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 SAP__CoverPage entities.

    • fetchSignature

      @Nullable public SAP__Signature fetchSignature()
      Fetches the SAP__Signature entity (one to one) associated with this entity. This corresponds to the OData navigation property Signature.

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

      Returns:
      The single associated SAP__Signature entity, or null if an entity is not associated.
      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.

    • getSignatureOrFetch

      @Nullable public SAP__Signature getSignatureOrFetch()
      Retrieval of associated SAP__Signature entity (one to one). This corresponds to the OData navigation property Signature.

      If the navigation property Signature of a queried SAP__DocumentDescription 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 SAP__Signature entity.
      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.

    • getSignatureIfPresent

      @Nonnull public io.vavr.control.Option<SAP__Signature> getSignatureIfPresent()
      Retrieval of associated SAP__Signature entity (one to one). This corresponds to the OData navigation property Signature.

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

    • setSignature

      public void setSignature(SAP__Signature value)
      Overwrites the associated SAP__Signature entity for the loaded navigation property Signature.
      Parameters:
      value - New SAP__Signature entity.

    • fetchPDFStandard

      @Nullable public SAP__PDFStandard fetchPDFStandard()
      Fetches the SAP__PDFStandard entity (one to one) associated with this entity. This corresponds to the OData navigation property PDFStandard.

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

      Returns:
      The single associated SAP__PDFStandard entity, or null if an entity is not associated.
      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.

    • getPDFStandardOrFetch

      @Nullable public SAP__PDFStandard getPDFStandardOrFetch()
      Retrieval of associated SAP__PDFStandard entity (one to one). This corresponds to the OData navigation property PDFStandard.

      If the navigation property PDFStandard of a queried SAP__DocumentDescription 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 SAP__PDFStandard entity.
      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.

    • getPDFStandardIfPresent

      @Nonnull public io.vavr.control.Option<SAP__PDFStandard> getPDFStandardIfPresent()
      Retrieval of associated SAP__PDFStandard entity (one to one). This corresponds to the OData navigation property PDFStandard.

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

    • setPDFStandard

      public void setPDFStandard(SAP__PDFStandard value)
      Overwrites the associated SAP__PDFStandard entity for the loaded navigation property PDFStandard.
      Parameters:
      value - New SAP__PDFStandard entity.

    • builder

      @Nonnull public static SAP__DocumentDescription.SAP__DocumentDescriptionBuilder builder()

    • getId

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

      Original property name from the Odata EDM: Id

      Returns:
      UUID

    • getCreatedBy

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

      Original property name from the Odata EDM: CreatedBy

      Returns:
      The createdBy contained in this entity.

    • getCreatedAt

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

      Original property name from the Odata EDM: CreatedAt

      Returns:
      Time Stamp

    • getFileName

      @Nullable public String getFileName()
      Constraints: Not nullable, Maximum length: 256

      Original property name from the Odata EDM: FileName

      Returns:
      The fileName contained in this entity.

    • getTitle

      @Nullable public String getTitle()
      Constraints: Not nullable, Maximum length: 256

      Original property name from the Odata EDM: Title

      Returns:
      The title contained in this entity.

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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