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

Class DocumentTypeHier

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<DocumentTypeHier>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.masterdataforgroupreporting.DocumentTypeHier
public class DocumentTypeHier extends VdmEntity<DocumentTypeHier>
Consolidation Document Type Hierarchy

Original entity name from the Odata EDM: DocumentTypeHierType

  • Field Details

    • ALL_FIELDS

      public static final DocumentTypeHierSelectable ALL_FIELDS
      Selector for all available fields of DocumentTypeHier.

    • CONSOLIDATION_DOC_TYPE_HIERARCHY

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

    • HIERARCHY_NODE

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

    • HIERARCHY_NODE_TEXT

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

    • VALIDITY_END_DATE

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

    • VALIDITY_START_DATE

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

    • PARENT_NODE

      public static final DocumentTypeHierField<String> PARENT_NODE
      Use with available fluent helpers to apply the ParentNode field to query operations.

    • CONSOLIDATION_DOCUMENT_TYPE

      public static final DocumentTypeHierField<String> CONSOLIDATION_DOCUMENT_TYPE
      Use with available fluent helpers to apply the ConsolidationDocumentType field to query operations.

    • CONSOLIDATION_DOCUMENT_TYPE_TEXT

      public static final DocumentTypeHierField<String> CONSOLIDATION_DOCUMENT_TYPE_TEXT
      Use with available fluent helpers to apply the ConsolidationDocumentType_Text field to query operations.

    • SEQUENCE_NUMBER

      public static final DocumentTypeHierField<String> SEQUENCE_NUMBER
      Use with available fluent helpers to apply the SequenceNumber field to query operations.

    • HIERARCHY_NODE_LEVEL

      public static final DocumentTypeHierField<String> HIERARCHY_NODE_LEVEL
      Use with available fluent helpers to apply the HierarchyNodeLevel field to query operations.

    • NODE_TYPE

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

    • TO_CNSLDTN_DOCUMENT_TYPE

      public static final DocumentTypeHierOneToOneLink<ConsolidationDocumentType> TO_CNSLDTN_DOCUMENT_TYPE
      Use with available fluent helpers to apply the to_CnsldtnDocumentType navigation property to query operations.

    • TO_CNSLDTN_DOCUMENT_TYPE_HIER_T

      public static final DocumentTypeHierLink<DocumentTypeHierText> TO_CNSLDTN_DOCUMENT_TYPE_HIER_T
      Use with available fluent helpers to apply the to_CnsldtnDocumentTypeHierT navigation property to query operations.

  • Constructor Details

  • Method Details

    • getType

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

    • 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

    • setHierarchyNode_Text

      public void setHierarchyNode_Text(@Nullable String hierarchyNode_Text)
      Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: HierarchyNode_Text

      Parameters:
      hierarchyNode_Text - Hierarchy node description

    • 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

    • setParentNode

      public void setParentNode(@Nullable String parentNode)
      Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: ParentNode

      Parameters:
      parentNode - Hierarchy parent node

    • setConsolidationDocumentType

      public void setConsolidationDocumentType(@Nullable String consolidationDocumentType)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: ConsolidationDocumentType

      Parameters:
      consolidationDocumentType - Document Type

    • setConsolidationDocumentType_Text

      public void setConsolidationDocumentType_Text(@Nullable String consolidationDocumentType_Text)
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: ConsolidationDocumentType_Text

      Parameters:
      consolidationDocumentType_Text - Document Type Description

    • setSequenceNumber

      public void setSequenceNumber(@Nullable String sequenceNumber)
      Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: SequenceNumber

      Parameters:
      sequenceNumber - Hierarchy Sequence Number

    • setHierarchyNodeLevel

      public void setHierarchyNodeLevel(@Nullable String hierarchyNodeLevel)
      Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: HierarchyNodeLevel

      Parameters:
      hierarchyNodeLevel - Hierarchy Level

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> DocumentTypeHierField<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> DocumentTypeHierField<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<DocumentTypeHier>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchCnsldtnDocumentType

      @Nullable public ConsolidationDocumentType fetchCnsldtnDocumentType()
      Fetches the ConsolidationDocumentType entity (one to one) associated with this entity. This corresponds to the OData navigation property to_CnsldtnDocumentType.

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

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

    • getCnsldtnDocumentTypeOrFetch

      @Nullable public ConsolidationDocumentType getCnsldtnDocumentTypeOrFetch()
      Retrieval of associated ConsolidationDocumentType entity (one to one). This corresponds to the OData navigation property to_CnsldtnDocumentType.

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

    • getCnsldtnDocumentTypeIfPresent

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

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

    • setCnsldtnDocumentType

      public void setCnsldtnDocumentType(ConsolidationDocumentType value)
      Overwrites the associated ConsolidationDocumentType entity for the loaded navigation property to_CnsldtnDocumentType.
      Parameters:
      value - New ConsolidationDocumentType entity.

    • fetchCnsldtnDocumentTypeHierT

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

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

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

    • getCnsldtnDocumentTypeHierTOrFetch

      @Nonnull public List<DocumentTypeHierText> getCnsldtnDocumentTypeHierTOrFetch()
      Retrieval of associated DocumentTypeHierText entities (one to many). This corresponds to the OData navigation property to_CnsldtnDocumentTypeHierT.

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

    • getCnsldtnDocumentTypeHierTIfPresent

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

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

    • setCnsldtnDocumentTypeHierT

      public void setCnsldtnDocumentTypeHierT(@Nonnull List<DocumentTypeHierText> value)
      Overwrites the list of associated DocumentTypeHierText entities for the loaded navigation property to_CnsldtnDocumentTypeHierT.

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

    • addCnsldtnDocumentTypeHierT

      public void addCnsldtnDocumentTypeHierT(DocumentTypeHierText... entity)
      Adds elements to the list of associated DocumentTypeHierText entities. This corresponds to the OData navigation property to_CnsldtnDocumentTypeHierT.

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

    • builder

      @Nonnull public static DocumentTypeHier.DocumentTypeHierBuilder builder()

    • 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

    • getHierarchyNode_Text

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

      Original property name from the Odata EDM: HierarchyNode_Text

      Returns:
      Hierarchy node description

    • 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

    • getParentNode

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

      Original property name from the Odata EDM: ParentNode

      Returns:
      Hierarchy parent node

    • getConsolidationDocumentType

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

      Original property name from the Odata EDM: ConsolidationDocumentType

      Returns:
      Document Type

    • getConsolidationDocumentType_Text

      @Nullable public String getConsolidationDocumentType_Text()
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: ConsolidationDocumentType_Text

      Returns:
      Document Type Description

    • getSequenceNumber

      @Nullable public String getSequenceNumber()
      Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: SequenceNumber

      Returns:
      Hierarchy Sequence Number

    • getHierarchyNodeLevel

      @Nullable public String getHierarchyNodeLevel()
      Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: HierarchyNodeLevel

      Returns:
      Hierarchy Level

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

    • equals

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

    • canEqual

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

    • hashCode

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