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

Class DocumentInfoRecordCharc

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<DocumentInfoRecordCharc>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.documentmanagement.DocumentInfoRecordCharc
public class DocumentInfoRecordCharc extends VdmEntity<DocumentInfoRecordCharc>
Classification Characteristics

Original entity name from the Odata EDM: A_DocumentInfoRecordCharcType

  • Field Details

    • ALL_FIELDS

      public static final DocumentInfoRecordCharcSelectable ALL_FIELDS
      Selector for all available fields of DocumentInfoRecordCharc.

    • DOCUMENT_INFO_RECORD_DOC_TYPE

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

    • CHARC_INTERNAL_ID

      public static final DocumentInfoRecordCharcField<String> CHARC_INTERNAL_ID
      Use with available fluent helpers to apply the CharcInternalID field to query operations.

    • CLASS_TYPE

      public static final DocumentInfoRecordCharcField<String> CLASS_TYPE
      Use with available fluent helpers to apply the ClassType field to query operations.

    • KEY_DATE

      public static final DocumentInfoRecordCharcField<LocalDateTime> KEY_DATE
      Use with available fluent helpers to apply the KeyDate field to query operations.

    • TO_VALUATION

      public static final DocumentInfoRecordCharcLink<DocumentInfoRecordCharcValue> TO_VALUATION
      Use with available fluent helpers to apply the to_Valuation navigation property to query operations.

  • Constructor Details

    • DocumentInfoRecordCharc

      public DocumentInfoRecordCharc()

    • DocumentInfoRecordCharc

      public DocumentInfoRecordCharc(@Nullable String documentInfoRecordDocType, @Nullable String documentInfoRecordDocNumber, @Nullable String documentInfoRecordDocVersion, @Nullable String documentInfoRecordDocPart, @Nullable String charcInternalID, @Nullable String classType, @Nullable LocalDateTime keyDate, List<DocumentInfoRecordCharcValue> toValuation)

  • Method Details

    • getType

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

    • 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

    • setCharcInternalID

      public void setCharcInternalID(@Nullable String charcInternalID)
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: CharcInternalID

      Parameters:
      charcInternalID - Characteristic Internal ID

    • setClassType

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

      Original property name from the Odata EDM: ClassType

      Parameters:
      classType - Class Type

    • setKeyDate

      public void setKeyDate(@Nullable LocalDateTime keyDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: KeyDate

      Parameters:
      keyDate - The keyDate to set.

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> DocumentInfoRecordCharcField<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> DocumentInfoRecordCharcField<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<DocumentInfoRecordCharc>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchValuation

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

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

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

    • getValuationOrFetch

      @Nonnull public List<DocumentInfoRecordCharcValue> getValuationOrFetch()
      Retrieval of associated DocumentInfoRecordCharcValue entities (one to many). This corresponds to the OData navigation property to_Valuation.

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

    • getValuationIfPresent

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

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

    • setValuation

      public void setValuation(@Nonnull List<DocumentInfoRecordCharcValue> value)
      Overwrites the list of associated DocumentInfoRecordCharcValue entities for the loaded navigation property to_Valuation.

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

    • addValuation

      public void addValuation(DocumentInfoRecordCharcValue... entity)
      Adds elements to the list of associated DocumentInfoRecordCharcValue entities. This corresponds to the OData navigation property to_Valuation.

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

    • builder

      @Nonnull public static DocumentInfoRecordCharc.DocumentInfoRecordCharcBuilder 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

    • getCharcInternalID

      @Nullable public String getCharcInternalID()
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: CharcInternalID

      Returns:
      Characteristic Internal ID

    • getClassType

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

      Original property name from the Odata EDM: ClassType

      Returns:
      Class Type

    • getKeyDate

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

      Original property name from the Odata EDM: KeyDate

      Returns:
      The keyDate contained in this entity.

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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