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

Class FunctionalAreaHier

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<FunctionalAreaHier>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.masterdataforgroupreporting.FunctionalAreaHier
public class FunctionalAreaHier extends VdmEntity<FunctionalAreaHier>
Combined Functional Area Hierarchy

Original entity name from the Odata EDM: FunctionalAreaHierType

  • Field Details

    • ALL_FIELDS

      public static final FunctionalAreaHierSelectable ALL_FIELDS
      Selector for all available fields of FunctionalAreaHier.

    • ADDITIONAL_MASTER_DATA_HIERARCHY

      public static final FunctionalAreaHierField<String> ADDITIONAL_MASTER_DATA_HIERARCHY
      Use with available fluent helpers to apply the AdditionalMasterDataHierarchy field to query operations.

    • HIERARCHY_NODE

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

    • HIERARCHY_NODE_TEXT

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

    • VALIDITY_END_DATE

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

    • PARENT_NODE

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

    • VALIDITY_START_DATE

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

    • FUNCTIONAL_AREA

      public static final FunctionalAreaHierField<String> FUNCTIONAL_AREA
      Use with available fluent helpers to apply the FunctionalArea field to query operations.

    • FUNCTIONAL_AREA_TEXT

      public static final FunctionalAreaHierField<String> FUNCTIONAL_AREA_TEXT
      Use with available fluent helpers to apply the FunctionalArea_Text field to query operations.

    • SEQUENCE_NUMBER

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

    • HIERARCHY_NODE_SEQUENCE

      public static final FunctionalAreaHierField<String> HIERARCHY_NODE_SEQUENCE
      Use with available fluent helpers to apply the HierarchyNodeSequence field to query operations.

    • HIERARCHY_NODE_LEVEL

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

    • NODE_TYPE

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

    • TO_CNSLDTN_FUNCNL_AREA_HIER_T

      public static final FunctionalAreaHierLink<FunctionalAreaHierText> TO_CNSLDTN_FUNCNL_AREA_HIER_T
      Use with available fluent helpers to apply the to_CnsldtnFuncnlAreaHierT navigation property to query operations.

    • TO_CNSLDTN_FUNCTIONAL_AREA

      public static final FunctionalAreaHierOneToOneLink<FunctionalArea> TO_CNSLDTN_FUNCTIONAL_AREA
      Use with available fluent helpers to apply the to_CnsldtnFunctionalArea navigation property to query operations.

  • Constructor Details

    • FunctionalAreaHier

      public FunctionalAreaHier()

    • FunctionalAreaHier

      public FunctionalAreaHier(@Nullable String additionalMasterDataHierarchy, @Nullable String hierarchyNode, @Nullable String hierarchyNode_Text, @Nullable LocalDateTime validityEndDate, @Nullable String parentNode, @Nullable LocalDateTime validityStartDate, @Nullable String functionalArea, @Nullable String functionalArea_Text, @Nullable String sequenceNumber, @Nullable String hierarchyNodeSequence, @Nullable String hierarchyNodeLevel, @Nullable String nodeType, List<FunctionalAreaHierText> toCnsldtnFuncnlAreaHierT, @Nullable FunctionalArea toCnsldtnFunctionalArea)

  • Method Details

    • getType

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

    • setAdditionalMasterDataHierarchy

      public void setAdditionalMasterDataHierarchy(@Nullable String additionalMasterDataHierarchy)
      (Key Field) Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: AdditionalMasterDataHierarchy

      Parameters:
      additionalMasterDataHierarchy - Consolidation 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 - Consolidation 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 - Consolidation 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 - Validity End Date

    • setParentNode

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

      Original property name from the Odata EDM: ParentNode

      Parameters:
      parentNode - Consolidation Hierarchy Parent Node

    • setValidityStartDate

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

      Original property name from the Odata EDM: ValidityStartDate

      Parameters:
      validityStartDate - Validity Start Date

    • setFunctionalArea

      public void setFunctionalArea(@Nullable String functionalArea)
      Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: FunctionalArea

      Parameters:
      functionalArea - Consolidation Functional Area

    • setFunctionalArea_Text

      public void setFunctionalArea_Text(@Nullable String functionalArea_Text)
      Constraints: Not nullable, Maximum length: 25

      Original property name from the Odata EDM: FunctionalArea_Text

      Parameters:
      functionalArea_Text - Functional Area Description

    • setSequenceNumber

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

      Original property name from the Odata EDM: SequenceNumber

      Parameters:
      sequenceNumber - The sequenceNumber to set.

    • setHierarchyNodeSequence

      public void setHierarchyNodeSequence(@Nullable String hierarchyNodeSequence)
      Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: HierarchyNodeSequence

      Parameters:
      hierarchyNodeSequence - Consolidation 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 - Consolidation 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 - Consolidation Hierarchy Node Type

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> FunctionalAreaHierField<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> FunctionalAreaHierField<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<FunctionalAreaHier>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchCnsldtnFuncnlAreaHierT

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

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

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

    • getCnsldtnFuncnlAreaHierTOrFetch

      @Nonnull public List<FunctionalAreaHierText> getCnsldtnFuncnlAreaHierTOrFetch()
      Retrieval of associated FunctionalAreaHierText entities (one to many). This corresponds to the OData navigation property to_CnsldtnFuncnlAreaHierT.

      If the navigation property to_CnsldtnFuncnlAreaHierT of a queried FunctionalAreaHier 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 FunctionalAreaHierText 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.

    • getCnsldtnFuncnlAreaHierTIfPresent

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

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

    • setCnsldtnFuncnlAreaHierT

      public void setCnsldtnFuncnlAreaHierT(@Nonnull List<FunctionalAreaHierText> value)
      Overwrites the list of associated FunctionalAreaHierText entities for the loaded navigation property to_CnsldtnFuncnlAreaHierT.

      If the navigation property to_CnsldtnFuncnlAreaHierT of a queried FunctionalAreaHier 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 FunctionalAreaHierText entities.

    • addCnsldtnFuncnlAreaHierT

      public void addCnsldtnFuncnlAreaHierT(FunctionalAreaHierText... entity)
      Adds elements to the list of associated FunctionalAreaHierText entities. This corresponds to the OData navigation property to_CnsldtnFuncnlAreaHierT.

      If the navigation property to_CnsldtnFuncnlAreaHierT of a queried FunctionalAreaHier 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 FunctionalAreaHierText entities.

    • fetchCnsldtnFunctionalArea

      @Nullable public FunctionalArea fetchCnsldtnFunctionalArea()
      Fetches the FunctionalArea entity (one to one) associated with this entity. This corresponds to the OData navigation property to_CnsldtnFunctionalArea.

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

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

    • getCnsldtnFunctionalAreaOrFetch

      @Nullable public FunctionalArea getCnsldtnFunctionalAreaOrFetch()
      Retrieval of associated FunctionalArea entity (one to one). This corresponds to the OData navigation property to_CnsldtnFunctionalArea.

      If the navigation property to_CnsldtnFunctionalArea of a queried FunctionalAreaHier 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 FunctionalArea 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.

    • getCnsldtnFunctionalAreaIfPresent

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

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

    • setCnsldtnFunctionalArea

      public void setCnsldtnFunctionalArea(FunctionalArea value)
      Overwrites the associated FunctionalArea entity for the loaded navigation property to_CnsldtnFunctionalArea.
      Parameters:
      value - New FunctionalArea entity.

    • builder

      @Nonnull public static FunctionalAreaHier.FunctionalAreaHierBuilder builder()

    • getAdditionalMasterDataHierarchy

      @Nullable public String getAdditionalMasterDataHierarchy()
      (Key Field) Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: AdditionalMasterDataHierarchy

      Returns:
      Consolidation Hierarchy ID

    • getHierarchyNode

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

      Original property name from the Odata EDM: HierarchyNode

      Returns:
      Consolidation 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:
      Consolidation Hierarchy Node Description

    • getValidityEndDate

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

      Original property name from the Odata EDM: ValidityEndDate

      Returns:
      Validity End Date

    • getParentNode

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

      Original property name from the Odata EDM: ParentNode

      Returns:
      Consolidation Hierarchy Parent Node

    • getValidityStartDate

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

      Original property name from the Odata EDM: ValidityStartDate

      Returns:
      Validity Start Date

    • getFunctionalArea

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

      Original property name from the Odata EDM: FunctionalArea

      Returns:
      Consolidation Functional Area

    • getFunctionalArea_Text

      @Nullable public String getFunctionalArea_Text()
      Constraints: Not nullable, Maximum length: 25

      Original property name from the Odata EDM: FunctionalArea_Text

      Returns:
      Functional Area Description

    • getSequenceNumber

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

      Original property name from the Odata EDM: SequenceNumber

      Returns:
      The sequenceNumber contained in this entity.

    • getHierarchyNodeSequence

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

      Original property name from the Odata EDM: HierarchyNodeSequence

      Returns:
      Consolidation Hierarchy Sequence Number

    • getHierarchyNodeLevel

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

      Original property name from the Odata EDM: HierarchyNodeLevel

      Returns:
      Consolidation Hierarchy Level

    • getNodeType

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

      Original property name from the Odata EDM: NodeType

      Returns:
      Consolidation Hierarchy Node Type

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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