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

Class DocumentInfoRecordAttch

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<DocumentInfoRecordAttch>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.attachment.DocumentInfoRecordAttch
public class DocumentInfoRecordAttch extends VdmEntity<DocumentInfoRecordAttch>
Attachments for Document Info Record

Original entity name from the Odata EDM: A_DocumentInfoRecordAttchType

  • Field Details

    • ALL_FIELDS

      public static final DocumentInfoRecordAttchSelectable ALL_FIELDS
      Selector for all available fields of DocumentInfoRecordAttch.

    • DOCUMENT_INFO_RECORD_DOC_TYPE

      public static final DocumentInfoRecordAttchField<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 DocumentInfoRecordAttchField<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 DocumentInfoRecordAttchField<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 DocumentInfoRecordAttchField<String> DOCUMENT_INFO_RECORD_DOC_PART
      Use with available fluent helpers to apply the DocumentInfoRecordDocPart field to query operations.

    • DOCUMENT_INFO_RECORD

      public static final DocumentInfoRecordAttchField<String> DOCUMENT_INFO_RECORD
      Use with available fluent helpers to apply the DocumentInfoRecord field to query operations.

    • DOCUMENT_DESCRIPTION

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

    • EXTERNAL_DOCUMENT_STATUS

      public static final DocumentInfoRecordAttchField<String> EXTERNAL_DOCUMENT_STATUS
      Use with available fluent helpers to apply the ExternalDocumentStatus field to query operations.

    • DOCUMENT_STATUS_NAME

      public static final DocumentInfoRecordAttchField<String> DOCUMENT_STATUS_NAME
      Use with available fluent helpers to apply the DocumentStatusName field to query operations.

    • DOC_INFO_RECD_IS_MARKED_FOR_DELETION

      public static final DocumentInfoRecordAttchField<Boolean> DOC_INFO_RECD_IS_MARKED_FOR_DELETION
      Use with available fluent helpers to apply the DocInfoRecdIsMarkedForDeletion field to query operations.

    • TO_DOCUMENT_INFO_RECORD_TO_ATTACHMENT_NAVIGATION

      public static final DocumentInfoRecordAttchLink<AttachmentContent> TO_DOCUMENT_INFO_RECORD_TO_ATTACHMENT_NAVIGATION
      Use with available fluent helpers to apply the DocumentInfoRecordToAttachmentNavigation navigation property to query operations.

  • Constructor Details

    • DocumentInfoRecordAttch

      public DocumentInfoRecordAttch()

    • DocumentInfoRecordAttch

      public DocumentInfoRecordAttch(@Nullable String documentInfoRecordDocType, @Nullable String documentInfoRecordDocNumber, @Nullable String documentInfoRecordDocVersion, @Nullable String documentInfoRecordDocPart, @Nullable String documentInfoRecord, @Nullable String documentDescription, @Nullable String externalDocumentStatus, @Nullable String documentStatusName, @Nullable Boolean docInfoRecdIsMarkedForDeletion, List<AttachmentContent> toDocumentInfoRecordToAttachmentNavigation)

  • Method Details

    • getType

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

    • 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

    • setDocumentInfoRecord

      public void setDocumentInfoRecord(@Nullable String documentInfoRecord)
      Constraints: Not nullable, Maximum length: 70

      Original property name from the Odata EDM: DocumentInfoRecord

      Parameters:
      documentInfoRecord - Document Info Record key in concatenated form

    • 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

    • setExternalDocumentStatus

      public void setExternalDocumentStatus(@Nullable String externalDocumentStatus)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: ExternalDocumentStatus

      Parameters:
      externalDocumentStatus - Status of a document (language-dependent)

    • setDocumentStatusName

      public void setDocumentStatusName(@Nullable String documentStatusName)
      Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: DocumentStatusName

      Parameters:
      documentStatusName - Description of document status

    • setDocInfoRecdIsMarkedForDeletion

      public void setDocInfoRecdIsMarkedForDeletion(@Nullable Boolean docInfoRecdIsMarkedForDeletion)
      Constraints: none

      Original property name from the Odata EDM: DocInfoRecdIsMarkedForDeletion

      Parameters:
      docInfoRecdIsMarkedForDeletion - Deletion Indicator

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> DocumentInfoRecordAttchField<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> DocumentInfoRecordAttchField<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<DocumentInfoRecordAttch>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchDocumentInfoRecordToAttachmentNavigation

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

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

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

    • getDocumentInfoRecordToAttachmentNavigationOrFetch

      @Nonnull public List<AttachmentContent> getDocumentInfoRecordToAttachmentNavigationOrFetch()
      Retrieval of associated AttachmentContent entities (one to many). This corresponds to the OData navigation property DocumentInfoRecordToAttachmentNavigation.

      If the navigation property DocumentInfoRecordToAttachmentNavigation of a queried DocumentInfoRecordAttch 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 AttachmentContent 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.

    • getDocumentInfoRecordToAttachmentNavigationIfPresent

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

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

    • setDocumentInfoRecordToAttachmentNavigation

      public void setDocumentInfoRecordToAttachmentNavigation(@Nonnull List<AttachmentContent> value)
      Overwrites the list of associated AttachmentContent entities for the loaded navigation property DocumentInfoRecordToAttachmentNavigation.

      If the navigation property DocumentInfoRecordToAttachmentNavigation of a queried DocumentInfoRecordAttch 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 AttachmentContent entities.

    • addDocumentInfoRecordToAttachmentNavigation

      public void addDocumentInfoRecordToAttachmentNavigation(AttachmentContent... entity)
      Adds elements to the list of associated AttachmentContent entities. This corresponds to the OData navigation property DocumentInfoRecordToAttachmentNavigation.

      If the navigation property DocumentInfoRecordToAttachmentNavigation of a queried DocumentInfoRecordAttch 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 AttachmentContent entities.

    • builder

      @Nonnull public static DocumentInfoRecordAttch.DocumentInfoRecordAttchBuilder builder()

    • 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

    • getDocumentInfoRecord

      @Nullable public String getDocumentInfoRecord()
      Constraints: Not nullable, Maximum length: 70

      Original property name from the Odata EDM: DocumentInfoRecord

      Returns:
      Document Info Record key in concatenated form

    • getDocumentDescription

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

      Original property name from the Odata EDM: DocumentDescription

      Returns:
      Document Description

    • getExternalDocumentStatus

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

      Original property name from the Odata EDM: ExternalDocumentStatus

      Returns:
      Status of a document (language-dependent)

    • getDocumentStatusName

      @Nullable public String getDocumentStatusName()
      Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: DocumentStatusName

      Returns:
      Description of document status

    • getDocInfoRecdIsMarkedForDeletion

      @Nullable public Boolean getDocInfoRecdIsMarkedForDeletion()
      Constraints: none

      Original property name from the Odata EDM: DocInfoRecdIsMarkedForDeletion

      Returns:
      Deletion Indicator

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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