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

Class DocumentInfoRecordDesc

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<DocumentInfoRecordDesc>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.documentmanagement.DocumentInfoRecordDesc
public class DocumentInfoRecordDesc extends VdmEntity<DocumentInfoRecordDesc>
Document Info Record Description

Original entity name from the Odata EDM: A_DocumentInfoRecordDescType

  • Field Details

    • ALL_FIELDS

      public static final DocumentInfoRecordDescSelectable ALL_FIELDS
      Selector for all available fields of DocumentInfoRecordDesc.

    • DELETE_MC

      public static final DocumentInfoRecordDescField<Boolean> DELETE_MC
      Use with available fluent helpers to apply the Delete_mc field to query operations.

    • UPDATE_MC

      public static final DocumentInfoRecordDescField<Boolean> UPDATE_MC
      Use with available fluent helpers to apply the Update_mc field to query operations.

    • DOCUMENT_INFO_RECORD_DOC_TYPE

      public static final DocumentInfoRecordDescField<String> DOCUMENT_INFO_RECORD_DOC_TYPE
      Use with available fluent helpers to apply the DocumentInfoRecordDocType field to query operations.

    • DOCUMENT_INFO_RECORD_DOC_NUMBER

      public static final DocumentInfoRecordDescField<String> DOCUMENT_INFO_RECORD_DOC_NUMBER
      Use with available fluent helpers to apply the DocumentInfoRecordDocNumber field to query operations.

    • DOCUMENT_INFO_RECORD_DOC_VERSION

      public static final DocumentInfoRecordDescField<String> DOCUMENT_INFO_RECORD_DOC_VERSION
      Use with available fluent helpers to apply the DocumentInfoRecordDocVersion field to query operations.

    • DOCUMENT_INFO_RECORD_DOC_PART

      public static final DocumentInfoRecordDescField<String> DOCUMENT_INFO_RECORD_DOC_PART
      Use with available fluent helpers to apply the DocumentInfoRecordDocPart field to query operations.

    • LANGUAGE

      public static final DocumentInfoRecordDescField<String> LANGUAGE
      Use with available fluent helpers to apply the Language field to query operations.

    • DOCUMENT_DESCRIPTION

      public static final DocumentInfoRecordDescField<String> DOCUMENT_DESCRIPTION
      Use with available fluent helpers to apply the DocumentDescription field to query operations.

    • LONG_TEXT_EXISTS

      public static final DocumentInfoRecordDescField<String> LONG_TEXT_EXISTS
      Use with available fluent helpers to apply the LongTextExists field to query operations.

    • DOC_INFO_RECD_SHORT_TEXT

      public static final DocumentInfoRecordDescField<String> DOC_INFO_RECD_SHORT_TEXT
      Use with available fluent helpers to apply the DocInfoRecdShortText field to query operations.

    • CHANGED_DATE_TIME

      public static final DocumentInfoRecordDescField<ZonedDateTime> CHANGED_DATE_TIME
      Use with available fluent helpers to apply the ChangedDateTime field to query operations.

    • TO_DOC_INFO_RECORD

      public static final DocumentInfoRecordDescOneToOneLink<DocumentInfoRecord> TO_DOC_INFO_RECORD
      Use with available fluent helpers to apply the to_DocInfoRecord navigation property to query operations.

  • Constructor Details

    • DocumentInfoRecordDesc

      public DocumentInfoRecordDesc()

    • DocumentInfoRecordDesc

      public DocumentInfoRecordDesc(@Nullable Boolean delete_mc, @Nullable Boolean update_mc, @Nullable String documentInfoRecordDocType, @Nullable String documentInfoRecordDocNumber, @Nullable String documentInfoRecordDocVersion, @Nullable String documentInfoRecordDocPart, @Nullable String language, @Nullable String documentDescription, @Nullable String longTextExists, @Nullable String docInfoRecdShortText, @Nullable ZonedDateTime changedDateTime, @Nullable DocumentInfoRecord toDocInfoRecord)

  • Method Details

    • getType

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

    • setDelete_mc

      public void setDelete_mc(@Nullable Boolean delete_mc)
      Constraints: none

      Original property name from the Odata EDM: Delete_mc

      Parameters:
      delete_mc - Dyn. Method Control

    • setUpdate_mc

      public void setUpdate_mc(@Nullable Boolean update_mc)
      Constraints: none

      Original property name from the Odata EDM: Update_mc

      Parameters:
      update_mc - Dyn. Method Control

    • setDocumentInfoRecordDocType

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

      Original property name from the Odata EDM: DocumentInfoRecordDocType

      Parameters:
      documentInfoRecordDocType - Document Type

    • setDocumentInfoRecordDocNumber

      public void setDocumentInfoRecordDocNumber(@Nullable String documentInfoRecordDocNumber)
      (Key Field) Constraints: Not nullable, Maximum length: 25

      Original property name from the Odata EDM: DocumentInfoRecordDocNumber

      Parameters:
      documentInfoRecordDocNumber - Document number

    • setDocumentInfoRecordDocVersion

      public void setDocumentInfoRecordDocVersion(@Nullable String documentInfoRecordDocVersion)
      (Key Field) Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: DocumentInfoRecordDocVersion

      Parameters:
      documentInfoRecordDocVersion - Document Version

    • setDocumentInfoRecordDocPart

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

      Original property name from the Odata EDM: DocumentInfoRecordDocPart

      Parameters:
      documentInfoRecordDocPart - Document Part

    • setLanguage

      public void setLanguage(@Nullable String language)
      (Key Field) Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: Language

      Parameters:
      language - Language

    • setDocumentDescription

      public void setDocumentDescription(@Nullable String documentDescription)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: DocumentDescription

      Parameters:
      documentDescription - Document Description

    • setLongTextExists

      public void setLongTextExists(@Nullable String longTextExists)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: LongTextExists

      Parameters:
      longTextExists - Long Text Exists

    • setDocInfoRecdShortText

      public void setDocInfoRecdShortText(@Nullable String docInfoRecdShortText)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: DocInfoRecdShortText

      Parameters:
      docInfoRecdShortText - DMS: Short Texts in Capital Letters

    • setChangedDateTime

      public void setChangedDateTime(@Nullable ZonedDateTime changedDateTime)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ChangedDateTime

      Parameters:
      changedDateTime - Time last change was made

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> DocumentInfoRecordDescField<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> DocumentInfoRecordDescField<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<DocumentInfoRecordDesc>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchDocInfoRecord

      @Nullable public DocumentInfoRecord fetchDocInfoRecord()
      Fetches the DocumentInfoRecord entity (one to one) associated with this entity. This corresponds to the OData navigation property to_DocInfoRecord.

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

      Returns:
      The single associated DocumentInfoRecord 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.

    • getDocInfoRecordOrFetch

      @Nullable public DocumentInfoRecord getDocInfoRecordOrFetch()
      Retrieval of associated DocumentInfoRecord entity (one to one). This corresponds to the OData navigation property to_DocInfoRecord.

      If the navigation property to_DocInfoRecord of a queried DocumentInfoRecordDesc 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 DocumentInfoRecord 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.

    • getDocInfoRecordIfPresent

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

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

    • setDocInfoRecord

      public void setDocInfoRecord(DocumentInfoRecord value)
      Overwrites the associated DocumentInfoRecord entity for the loaded navigation property to_DocInfoRecord.
      Parameters:
      value - New DocumentInfoRecord entity.

    • builder

      @Nonnull public static DocumentInfoRecordDesc.DocumentInfoRecordDescBuilder builder()

    • getDelete_mc

      @Nullable public Boolean getDelete_mc()
      Constraints: none

      Original property name from the Odata EDM: Delete_mc

      Returns:
      Dyn. Method Control

    • getUpdate_mc

      @Nullable public Boolean getUpdate_mc()
      Constraints: none

      Original property name from the Odata EDM: Update_mc

      Returns:
      Dyn. Method Control

    • getDocumentInfoRecordDocType

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

      Original property name from the Odata EDM: DocumentInfoRecordDocType

      Returns:
      Document Type

    • getDocumentInfoRecordDocNumber

      @Nullable public String getDocumentInfoRecordDocNumber()
      (Key Field) Constraints: Not nullable, Maximum length: 25

      Original property name from the Odata EDM: DocumentInfoRecordDocNumber

      Returns:
      Document number

    • getDocumentInfoRecordDocVersion

      @Nullable public String getDocumentInfoRecordDocVersion()
      (Key Field) Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: DocumentInfoRecordDocVersion

      Returns:
      Document Version

    • getDocumentInfoRecordDocPart

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

      Original property name from the Odata EDM: DocumentInfoRecordDocPart

      Returns:
      Document Part

    • getLanguage

      @Nullable public String getLanguage()
      (Key Field) Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: Language

      Returns:
      Language

    • getDocumentDescription

      @Nullable public String getDocumentDescription()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: DocumentDescription

      Returns:
      Document Description

    • getLongTextExists

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

      Original property name from the Odata EDM: LongTextExists

      Returns:
      Long Text Exists

    • getDocInfoRecdShortText

      @Nullable public String getDocInfoRecdShortText()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: DocInfoRecdShortText

      Returns:
      DMS: Short Texts in Capital Letters

    • getChangedDateTime

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

      Original property name from the Odata EDM: ChangedDateTime

      Returns:
      Time last change was made

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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