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

Class DocumentTypeHierText

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<DocumentTypeHierText>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.masterdataforgroupreporting.DocumentTypeHierText
public class DocumentTypeHierText extends VdmEntity<DocumentTypeHierText>
Consolidation Doc Type HierNode - Text

Original entity name from the Odata EDM: DocumentTypeHierTextType

  • Field Details

    • ALL_FIELDS

      public static final DocumentTypeHierTextSelectable ALL_FIELDS
      Selector for all available fields of DocumentTypeHierText.

    • LANGUAGE

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

    • CONSOLIDATION_DOC_TYPE_HIERARCHY

      public static final DocumentTypeHierTextField<String> CONSOLIDATION_DOC_TYPE_HIERARCHY
      Use with available fluent helpers to apply the ConsolidationDocTypeHierarchy field to query operations.

    • HIERARCHY_NODE

      public static final DocumentTypeHierTextField<String> HIERARCHY_NODE
      Use with available fluent helpers to apply the HierarchyNode field to query operations.

    • VALIDITY_END_DATE

      public static final DocumentTypeHierTextField<LocalDateTime> VALIDITY_END_DATE
      Use with available fluent helpers to apply the ValidityEndDate field to query operations.

    • VALIDITY_START_DATE

      public static final DocumentTypeHierTextField<LocalDateTime> VALIDITY_START_DATE
      Use with available fluent helpers to apply the ValidityStartDate field to query operations.

    • HIERARCHY_NODE_TEXT

      public static final DocumentTypeHierTextField<String> HIERARCHY_NODE_TEXT
      Use with available fluent helpers to apply the HierarchyNodeText field to query operations.

    • NODE_TYPE

      public static final DocumentTypeHierTextField<String> NODE_TYPE
      Use with available fluent helpers to apply the NodeType field to query operations.

    • TO_CNSLDTN_DOCUMENT_TYPE_HIER

      public static final DocumentTypeHierTextOneToOneLink<DocumentTypeHier> TO_CNSLDTN_DOCUMENT_TYPE_HIER
      Use with available fluent helpers to apply the to_CnsldtnDocumentTypeHier navigation property to query operations.

  • Constructor Details

    • DocumentTypeHierText

      public DocumentTypeHierText()

    • DocumentTypeHierText

      public DocumentTypeHierText(@Nullable String language, @Nullable String consolidationDocTypeHierarchy, @Nullable String hierarchyNode, @Nullable LocalDateTime validityEndDate, @Nullable LocalDateTime validityStartDate, @Nullable String hierarchyNodeText, @Nullable String nodeType, @Nullable DocumentTypeHier toCnsldtnDocumentTypeHier)

  • Method Details

    • getType

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

    • 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 Key

    • setConsolidationDocTypeHierarchy

      public void setConsolidationDocTypeHierarchy(@Nullable String consolidationDocTypeHierarchy)
      (Key Field) Constraints: Not nullable, Maximum length: 42

      Original property name from the Odata EDM: ConsolidationDocTypeHierarchy

      Parameters:
      consolidationDocTypeHierarchy - Hierarchy ID

    • setHierarchyNode

      public void setHierarchyNode(@Nullable String hierarchyNode)
      (Key Field) Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: HierarchyNode

      Parameters:
      hierarchyNode - Hierarchy node

    • setValidityEndDate

      public void setValidityEndDate(@Nullable LocalDateTime validityEndDate)
      (Key Field) Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ValidityEndDate

      Parameters:
      validityEndDate - Valid To Date

    • setValidityStartDate

      public void setValidityStartDate(@Nullable LocalDateTime validityStartDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ValidityStartDate

      Parameters:
      validityStartDate - Valid-From Date

    • setHierarchyNodeText

      public void setHierarchyNodeText(@Nullable String hierarchyNodeText)
      Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: HierarchyNodeText

      Parameters:
      hierarchyNodeText - Hierarchy node description

    • setNodeType

      public void setNodeType(@Nullable String nodeType)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: NodeType

      Parameters:
      nodeType - Hierarchy node type

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> DocumentTypeHierTextField<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> DocumentTypeHierTextField<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<DocumentTypeHierText>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchCnsldtnDocumentTypeHier

      @Nullable public DocumentTypeHier fetchCnsldtnDocumentTypeHier()
      Fetches the DocumentTypeHier entity (one to one) associated with this entity. This corresponds to the OData navigation property to_CnsldtnDocumentTypeHier.

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

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

    • getCnsldtnDocumentTypeHierOrFetch

      @Nullable public DocumentTypeHier getCnsldtnDocumentTypeHierOrFetch()
      Retrieval of associated DocumentTypeHier entity (one to one). This corresponds to the OData navigation property to_CnsldtnDocumentTypeHier.

      If the navigation property to_CnsldtnDocumentTypeHier of a queried DocumentTypeHierText 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 DocumentTypeHier 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.

    • getCnsldtnDocumentTypeHierIfPresent

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

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

    • setCnsldtnDocumentTypeHier

      public void setCnsldtnDocumentTypeHier(DocumentTypeHier value)
      Overwrites the associated DocumentTypeHier entity for the loaded navigation property to_CnsldtnDocumentTypeHier.
      Parameters:
      value - New DocumentTypeHier entity.

    • builder

      @Nonnull public static DocumentTypeHierText.DocumentTypeHierTextBuilder builder()

    • getLanguage

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

      Original property name from the Odata EDM: Language

      Returns:
      Language Key

    • getConsolidationDocTypeHierarchy

      @Nullable public String getConsolidationDocTypeHierarchy()
      (Key Field) Constraints: Not nullable, Maximum length: 42

      Original property name from the Odata EDM: ConsolidationDocTypeHierarchy

      Returns:
      Hierarchy ID

    • getHierarchyNode

      @Nullable public String getHierarchyNode()
      (Key Field) Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: HierarchyNode

      Returns:
      Hierarchy node

    • getValidityEndDate

      @Nullable public LocalDateTime getValidityEndDate()
      (Key Field) Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ValidityEndDate

      Returns:
      Valid To Date

    • getValidityStartDate

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

      Original property name from the Odata EDM: ValidityStartDate

      Returns:
      Valid-From Date

    • getHierarchyNodeText

      @Nullable public String getHierarchyNodeText()
      Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: HierarchyNodeText

      Returns:
      Hierarchy node description

    • getNodeType

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

      Original property name from the Odata EDM: NodeType

      Returns:
      Hierarchy node type

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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