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

Class DocumentInfoRecord

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

Original entity name from the Odata EDM: A_DocumentInfoRecordType

  • Field Details

    • ALL_FIELDS

      public static final DocumentInfoRecordSelectable ALL_FIELDS
      Selector for all available fields of DocumentInfoRecord.

    • UPDATE_MC

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

    • DOC_DESC_OC

      public static final DocumentInfoRecordField<Boolean> DOC_DESC_OC
      Use with available fluent helpers to apply the to_DocDesc_oc field to query operations.

    • PRODUCT_OBJ_OC

      public static final DocumentInfoRecordField<Boolean> PRODUCT_OBJ_OC
      Use with available fluent helpers to apply the to_ProductObj_oc field to query operations.

    • DOCUMENT_INFO_RECORD_DOC_TYPE

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

    • DOCUMENT_INFO_RECORD_DOC_VERSION

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

    • DOCUMENT_INFO_RECORD_DOC_NUMBER

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

    • DOCUMENT_INFO_RECORD_DOC_PART

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

    • INTERNAL_DOCUMENT_STATUS

      public static final DocumentInfoRecordField<String> INTERNAL_DOCUMENT_STATUS
      Use with available fluent helpers to apply the InternalDocumentStatus field to query operations.

    • LABORATORY_OR_DESIGN_OFFICE

      public static final DocumentInfoRecordField<String> LABORATORY_OR_DESIGN_OFFICE
      Use with available fluent helpers to apply the LaboratoryOrDesignOffice field to query operations.

    • AUTHORIZATION_GROUP

      public static final DocumentInfoRecordField<String> AUTHORIZATION_GROUP
      Use with available fluent helpers to apply the AuthorizationGroup field to query operations.

    • CHANGE_NUMBER

      public static final DocumentInfoRecordField<String> CHANGE_NUMBER
      Use with available fluent helpers to apply the ChangeNumber field to query operations.

    • DOC_INFO_RECD_IS_MARKED_FOR_DELETION

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

    • IS_DOC_INFO_RECD_CREATED_FROM_CAD

      public static final DocumentInfoRecordField<Boolean> IS_DOC_INFO_RECD_CREATED_FROM_CAD
      Use with available fluent helpers to apply the IsDocInfoRecdCreatedFromCAD field to query operations.

    • IS_DOC_INFO_RECD_STRUCTURE

      public static final DocumentInfoRecordField<String> IS_DOC_INFO_RECD_STRUCTURE
      Use with available fluent helpers to apply the IsDocInfoRecdStructure field to query operations.

    • RESPONSIBLE_PERSON_NAME

      public static final DocumentInfoRecordField<String> RESPONSIBLE_PERSON_NAME
      Use with available fluent helpers to apply the ResponsiblePersonName field to query operations.

    • CREATION_DATE_TIME

      public static final DocumentInfoRecordField<ZonedDateTime> CREATION_DATE_TIME
      Use with available fluent helpers to apply the CreationDateTime field to query operations.

    • CREATED_BY_USER

      public static final DocumentInfoRecordField<String> CREATED_BY_USER
      Use with available fluent helpers to apply the CreatedByUser field to query operations.

    • CHANGED_DATE_TIME

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

    • LAST_CHANGED_BY_USER

      public static final DocumentInfoRecordField<String> LAST_CHANGED_BY_USER
      Use with available fluent helpers to apply the LastChangedByUser field to query operations.

    • EXTERNAL_DOCUMENT_STATUS

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

    • DOCUMENT_STATUS_NAME

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

    • TO_BOM_OBJ

      public static final DocumentInfoRecordLink<DocInfoRecdObjLinkBOM> TO_BOM_OBJ
      Use with available fluent helpers to apply the to_BomObj navigation property to query operations.

    • TO_CHARACTERISTICS

      public static final DocumentInfoRecordLink<DocumentInfoRecordCharc> TO_CHARACTERISTICS
      Use with available fluent helpers to apply the to_Characteristics navigation property to query operations.

    • TO_CHG_RECD_OBJ

      public static final DocumentInfoRecordLink<DocInfoRecdObjLinkChgRecd> TO_CHG_RECD_OBJ
      Use with available fluent helpers to apply the to_ChgRecdObj navigation property to query operations.

    • TO_CLASSIFICATION

      public static final DocumentInfoRecordLink<DocumentInfoRecordClass> TO_CLASSIFICATION
      Use with available fluent helpers to apply the to_Classification navigation property to query operations.

    • TO_DOC_DESC

      public static final DocumentInfoRecordLink<DocumentInfoRecordDesc> TO_DOC_DESC
      Use with available fluent helpers to apply the to_DocDesc navigation property to query operations.

    • TO_DOC_STATUS_VH

      public static final DocumentInfoRecordLink<DocumentInfoRecordDocStsVH> TO_DOC_STATUS_VH
      Use with available fluent helpers to apply the to_DocStatusVH navigation property to query operations.

    • TO_PRODUCT_OBJ

      public static final DocumentInfoRecordLink<DocInfoRecdObjLinkProduct> TO_PRODUCT_OBJ
      Use with available fluent helpers to apply the to_ProductObj navigation property to query operations.

  • Constructor Details

  • Method Details

    • getType

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

    • 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

    • setDocDesc_oc

      public void setDocDesc_oc(@Nullable Boolean docDesc_oc)
      Constraints: none

      Original property name from the Odata EDM: to_DocDesc_oc

      Parameters:
      docDesc_oc - Dynamic CbA-Control

    • setProductObj_oc

      public void setProductObj_oc(@Nullable Boolean productObj_oc)
      Constraints: none

      Original property name from the Odata EDM: to_ProductObj_oc

      Parameters:
      productObj_oc - Dynamic CbA-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

    • 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

    • 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

    • 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

    • setInternalDocumentStatus

      public void setInternalDocumentStatus(@Nullable String internalDocumentStatus)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: InternalDocumentStatus

      Parameters:
      internalDocumentStatus - Document Status

    • setLaboratoryOrDesignOffice

      public void setLaboratoryOrDesignOffice(@Nullable String laboratoryOrDesignOffice)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: LaboratoryOrDesignOffice

      Parameters:
      laboratoryOrDesignOffice - Laboratory/Design Office

    • setAuthorizationGroup

      public void setAuthorizationGroup(@Nullable String authorizationGroup)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: AuthorizationGroup

      Parameters:
      authorizationGroup - Authorization Group

    • setChangeNumber

      public void setChangeNumber(@Nullable String changeNumber)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: ChangeNumber

      Parameters:
      changeNumber - Change Number

    • setDocInfoRecdIsMarkedForDeletion

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

      Original property name from the Odata EDM: DocInfoRecdIsMarkedForDeletion

      Parameters:
      docInfoRecdIsMarkedForDeletion - Deletion Indicator

    • setIsDocInfoRecdCreatedFromCAD

      public void setIsDocInfoRecdCreatedFromCAD(@Nullable Boolean isDocInfoRecdCreatedFromCAD)
      Constraints: none

      Original property name from the Odata EDM: IsDocInfoRecdCreatedFromCAD

      Parameters:
      isDocInfoRecdCreatedFromCAD - CAD Indicator

    • setIsDocInfoRecdStructure

      public void setIsDocInfoRecdStructure(@Nullable String isDocInfoRecdStructure)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: IsDocInfoRecdStructure

      Parameters:
      isDocInfoRecdStructure - The isDocInfoRecdStructure to set.

    • setResponsiblePersonName

      public void setResponsiblePersonName(@Nullable String responsiblePersonName)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: ResponsiblePersonName

      Parameters:
      responsiblePersonName - Name of Person Responsible

    • setCreationDateTime

      public void setCreationDateTime(@Nullable ZonedDateTime creationDateTime)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: CreationDateTime

      Parameters:
      creationDateTime - Time Document Was Created

    • setCreatedByUser

      public void setCreatedByUser(@Nullable String createdByUser)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: CreatedByUser

      Parameters:
      createdByUser - Document Creator's Name

    • 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

    • setLastChangedByUser

      public void setLastChangedByUser(@Nullable String lastChangedByUser)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: LastChangedByUser

      Parameters:
      lastChangedByUser - Last Changed By

    • 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

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> DocumentInfoRecordField<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> DocumentInfoRecordField<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<DocumentInfoRecord>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchBomObj

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

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

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

    • getBomObjOrFetch

      @Nonnull public List<DocInfoRecdObjLinkBOM> getBomObjOrFetch()
      Retrieval of associated DocInfoRecdObjLinkBOM entities (one to many). This corresponds to the OData navigation property to_BomObj.

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

    • getBomObjIfPresent

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

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

    • setBomObj

      public void setBomObj(@Nonnull List<DocInfoRecdObjLinkBOM> value)
      Overwrites the list of associated DocInfoRecdObjLinkBOM entities for the loaded navigation property to_BomObj.

      If the navigation property to_BomObj of a queried DocumentInfoRecord 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 DocInfoRecdObjLinkBOM entities.

    • addBomObj

      public void addBomObj(DocInfoRecdObjLinkBOM... entity)
      Adds elements to the list of associated DocInfoRecdObjLinkBOM entities. This corresponds to the OData navigation property to_BomObj.

      If the navigation property to_BomObj of a queried DocumentInfoRecord 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 DocInfoRecdObjLinkBOM entities.

    • fetchCharacteristics

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

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

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

    • getCharacteristicsOrFetch

      @Nonnull public List<DocumentInfoRecordCharc> getCharacteristicsOrFetch()
      Retrieval of associated DocumentInfoRecordCharc entities (one to many). This corresponds to the OData navigation property to_Characteristics.

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

    • getCharacteristicsIfPresent

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

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

    • setCharacteristics

      public void setCharacteristics(@Nonnull List<DocumentInfoRecordCharc> value)
      Overwrites the list of associated DocumentInfoRecordCharc entities for the loaded navigation property to_Characteristics.

      If the navigation property to_Characteristics of a queried DocumentInfoRecord 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 DocumentInfoRecordCharc entities.

    • addCharacteristics

      public void addCharacteristics(DocumentInfoRecordCharc... entity)
      Adds elements to the list of associated DocumentInfoRecordCharc entities. This corresponds to the OData navigation property to_Characteristics.

      If the navigation property to_Characteristics of a queried DocumentInfoRecord 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 DocumentInfoRecordCharc entities.

    • fetchChgRecdObj

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

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

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

    • getChgRecdObjOrFetch

      @Nonnull public List<DocInfoRecdObjLinkChgRecd> getChgRecdObjOrFetch()
      Retrieval of associated DocInfoRecdObjLinkChgRecd entities (one to many). This corresponds to the OData navigation property to_ChgRecdObj.

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

    • getChgRecdObjIfPresent

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

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

    • setChgRecdObj

      public void setChgRecdObj(@Nonnull List<DocInfoRecdObjLinkChgRecd> value)
      Overwrites the list of associated DocInfoRecdObjLinkChgRecd entities for the loaded navigation property to_ChgRecdObj.

      If the navigation property to_ChgRecdObj of a queried DocumentInfoRecord 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 DocInfoRecdObjLinkChgRecd entities.

    • addChgRecdObj

      public void addChgRecdObj(DocInfoRecdObjLinkChgRecd... entity)
      Adds elements to the list of associated DocInfoRecdObjLinkChgRecd entities. This corresponds to the OData navigation property to_ChgRecdObj.

      If the navigation property to_ChgRecdObj of a queried DocumentInfoRecord 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 DocInfoRecdObjLinkChgRecd entities.

    • fetchClassification

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

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

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

    • getClassificationOrFetch

      @Nonnull public List<DocumentInfoRecordClass> getClassificationOrFetch()
      Retrieval of associated DocumentInfoRecordClass entities (one to many). This corresponds to the OData navigation property to_Classification.

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

    • getClassificationIfPresent

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

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

    • setClassification

      public void setClassification(@Nonnull List<DocumentInfoRecordClass> value)
      Overwrites the list of associated DocumentInfoRecordClass entities for the loaded navigation property to_Classification.

      If the navigation property to_Classification of a queried DocumentInfoRecord 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 DocumentInfoRecordClass entities.

    • addClassification

      public void addClassification(DocumentInfoRecordClass... entity)
      Adds elements to the list of associated DocumentInfoRecordClass entities. This corresponds to the OData navigation property to_Classification.

      If the navigation property to_Classification of a queried DocumentInfoRecord 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 DocumentInfoRecordClass entities.

    • fetchDocDesc

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

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

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

    • getDocDescOrFetch

      @Nonnull public List<DocumentInfoRecordDesc> getDocDescOrFetch()
      Retrieval of associated DocumentInfoRecordDesc entities (one to many). This corresponds to the OData navigation property to_DocDesc.

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

    • getDocDescIfPresent

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

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

    • setDocDesc

      public void setDocDesc(@Nonnull List<DocumentInfoRecordDesc> value)
      Overwrites the list of associated DocumentInfoRecordDesc entities for the loaded navigation property to_DocDesc.

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

    • addDocDesc

      public void addDocDesc(DocumentInfoRecordDesc... entity)
      Adds elements to the list of associated DocumentInfoRecordDesc entities. This corresponds to the OData navigation property to_DocDesc.

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

    • fetchDocStatusVH

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

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

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

    • getDocStatusVHOrFetch

      @Nonnull public List<DocumentInfoRecordDocStsVH> getDocStatusVHOrFetch()
      Retrieval of associated DocumentInfoRecordDocStsVH entities (one to many). This corresponds to the OData navigation property to_DocStatusVH.

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

    • getDocStatusVHIfPresent

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

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

    • setDocStatusVH

      public void setDocStatusVH(@Nonnull List<DocumentInfoRecordDocStsVH> value)
      Overwrites the list of associated DocumentInfoRecordDocStsVH entities for the loaded navigation property to_DocStatusVH.

      If the navigation property to_DocStatusVH of a queried DocumentInfoRecord 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 DocumentInfoRecordDocStsVH entities.

    • addDocStatusVH

      public void addDocStatusVH(DocumentInfoRecordDocStsVH... entity)
      Adds elements to the list of associated DocumentInfoRecordDocStsVH entities. This corresponds to the OData navigation property to_DocStatusVH.

      If the navigation property to_DocStatusVH of a queried DocumentInfoRecord 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 DocumentInfoRecordDocStsVH entities.

    • fetchProductObj

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

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

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

    • getProductObjOrFetch

      @Nonnull public List<DocInfoRecdObjLinkProduct> getProductObjOrFetch()
      Retrieval of associated DocInfoRecdObjLinkProduct entities (one to many). This corresponds to the OData navigation property to_ProductObj.

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

    • getProductObjIfPresent

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

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

    • setProductObj

      public void setProductObj(@Nonnull List<DocInfoRecdObjLinkProduct> value)
      Overwrites the list of associated DocInfoRecdObjLinkProduct entities for the loaded navigation property to_ProductObj.

      If the navigation property to_ProductObj of a queried DocumentInfoRecord 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 DocInfoRecdObjLinkProduct entities.

    • addProductObj

      public void addProductObj(DocInfoRecdObjLinkProduct... entity)
      Adds elements to the list of associated DocInfoRecdObjLinkProduct entities. This corresponds to the OData navigation property to_ProductObj.

      If the navigation property to_ProductObj of a queried DocumentInfoRecord 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 DocInfoRecdObjLinkProduct entities.

    • builder

      @Nonnull public static DocumentInfoRecord.DocumentInfoRecordBuilder builder()

    • getUpdate_mc

      @Nullable public Boolean getUpdate_mc()
      Constraints: none

      Original property name from the Odata EDM: Update_mc

      Returns:
      Dyn. Method Control

    • getDocDesc_oc

      @Nullable public Boolean getDocDesc_oc()
      Constraints: none

      Original property name from the Odata EDM: to_DocDesc_oc

      Returns:
      Dynamic CbA-Control

    • getProductObj_oc

      @Nullable public Boolean getProductObj_oc()
      Constraints: none

      Original property name from the Odata EDM: to_ProductObj_oc

      Returns:
      Dynamic CbA-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

    • getDocumentInfoRecordDocVersion

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

      Original property name from the Odata EDM: DocumentInfoRecordDocVersion

      Returns:
      Document Version

    • getDocumentInfoRecordDocNumber

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

      Original property name from the Odata EDM: DocumentInfoRecordDocNumber

      Returns:
      Document number

    • 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

    • getInternalDocumentStatus

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

      Original property name from the Odata EDM: InternalDocumentStatus

      Returns:
      Document Status

    • getLaboratoryOrDesignOffice

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

      Original property name from the Odata EDM: LaboratoryOrDesignOffice

      Returns:
      Laboratory/Design Office

    • getAuthorizationGroup

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

      Original property name from the Odata EDM: AuthorizationGroup

      Returns:
      Authorization Group

    • getChangeNumber

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

      Original property name from the Odata EDM: ChangeNumber

      Returns:
      Change Number

    • getDocInfoRecdIsMarkedForDeletion

      @Nullable public Boolean getDocInfoRecdIsMarkedForDeletion()
      Constraints: none

      Original property name from the Odata EDM: DocInfoRecdIsMarkedForDeletion

      Returns:
      Deletion Indicator

    • getIsDocInfoRecdCreatedFromCAD

      @Nullable public Boolean getIsDocInfoRecdCreatedFromCAD()
      Constraints: none

      Original property name from the Odata EDM: IsDocInfoRecdCreatedFromCAD

      Returns:
      CAD Indicator

    • getIsDocInfoRecdStructure

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

      Original property name from the Odata EDM: IsDocInfoRecdStructure

      Returns:
      The isDocInfoRecdStructure contained in this entity.

    • getResponsiblePersonName

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

      Original property name from the Odata EDM: ResponsiblePersonName

      Returns:
      Name of Person Responsible

    • getCreationDateTime

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

      Original property name from the Odata EDM: CreationDateTime

      Returns:
      Time Document Was Created

    • getCreatedByUser

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

      Original property name from the Odata EDM: CreatedByUser

      Returns:
      Document Creator's Name

    • getChangedDateTime

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

      Original property name from the Odata EDM: ChangedDateTime

      Returns:
      Time last change was made

    • getLastChangedByUser

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

      Original property name from the Odata EDM: LastChangedByUser

      Returns:
      Last Changed By

    • 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

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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