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

Class CustomerHier

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

Original entity name from the Odata EDM: CustomerHierType

  • Field Details

    • ALL_FIELDS

      public static final CustomerHierSelectable ALL_FIELDS
      Selector for all available fields of CustomerHier.

    • ADDITIONAL_MASTER_DATA_HIERARCHY

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

    • HIERARCHY_NODE

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

    • HIERARCHY_NODE_TEXT

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

    • VALIDITY_END_DATE

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

    • PARENT_NODE

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

    • VALIDITY_START_DATE

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

    • CUSTOMER

      public static final CustomerHierField<String> CUSTOMER
      Use with available fluent helpers to apply the Customer field to query operations.

    • CUSTOMER_TEXT

      public static final CustomerHierField<String> CUSTOMER_TEXT
      Use with available fluent helpers to apply the Customer_Text field to query operations.

    • SEQUENCE_NUMBER

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

    • HIERARCHY_NODE_SEQUENCE

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

    • HIERARCHY_NODE_LEVEL

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

    • NODE_TYPE

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

    • TO_CNSLDTN_CUSTOMER

      public static final CustomerHierOneToOneLink<Customer> TO_CNSLDTN_CUSTOMER
      Use with available fluent helpers to apply the to_CnsldtnCustomer navigation property to query operations.

    • TO_CNSLDTN_CUSTOMER_HIER_T

      public static final CustomerHierLink<CustomerHierText> TO_CNSLDTN_CUSTOMER_HIER_T
      Use with available fluent helpers to apply the to_CnsldtnCustomerHierT navigation property to query operations.

  • Constructor Details

    • CustomerHier

      public CustomerHier()

    • CustomerHier

      public CustomerHier(@Nullable String additionalMasterDataHierarchy, @Nullable String hierarchyNode, @Nullable String hierarchyNode_Text, @Nullable LocalDateTime validityEndDate, @Nullable String parentNode, @Nullable LocalDateTime validityStartDate, @Nullable String customer, @Nullable String customer_Text, @Nullable String sequenceNumber, @Nullable String hierarchyNodeSequence, @Nullable String hierarchyNodeLevel, @Nullable String nodeType, @Nullable Customer toCnsldtnCustomer, List<CustomerHierText> toCnsldtnCustomerHierT)

  • Method Details

    • getType

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

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

    • setCustomer

      public void setCustomer(@Nullable String customer)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: Customer

      Parameters:
      customer - Consolidation Customer

    • setCustomer_Text

      public void setCustomer_Text(@Nullable String customer_Text)
      Constraints: Not nullable, Maximum length: 80

      Original property name from the Odata EDM: Customer_Text

      Parameters:
      customer_Text - Customer 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<CustomerHier>

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> CustomerHierField<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> CustomerHierField<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<CustomerHier>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchCnsldtnCustomer

      @Nullable public Customer fetchCnsldtnCustomer()
      Fetches the Customer entity (one to one) associated with this entity. This corresponds to the OData navigation property to_CnsldtnCustomer.

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

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

    • getCnsldtnCustomerOrFetch

      @Nullable public Customer getCnsldtnCustomerOrFetch()
      Retrieval of associated Customer entity (one to one). This corresponds to the OData navigation property to_CnsldtnCustomer.

      If the navigation property to_CnsldtnCustomer of a queried CustomerHier 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 Customer 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.

    • getCnsldtnCustomerIfPresent

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

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

    • setCnsldtnCustomer

      public void setCnsldtnCustomer(Customer value)
      Overwrites the associated Customer entity for the loaded navigation property to_CnsldtnCustomer.
      Parameters:
      value - New Customer entity.

    • fetchCnsldtnCustomerHierT

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

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

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

    • getCnsldtnCustomerHierTOrFetch

      @Nonnull public List<CustomerHierText> getCnsldtnCustomerHierTOrFetch()
      Retrieval of associated CustomerHierText entities (one to many). This corresponds to the OData navigation property to_CnsldtnCustomerHierT.

      If the navigation property to_CnsldtnCustomerHierT of a queried CustomerHier 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 CustomerHierText 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.

    • getCnsldtnCustomerHierTIfPresent

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

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

    • setCnsldtnCustomerHierT

      public void setCnsldtnCustomerHierT(@Nonnull List<CustomerHierText> value)
      Overwrites the list of associated CustomerHierText entities for the loaded navigation property to_CnsldtnCustomerHierT.

      If the navigation property to_CnsldtnCustomerHierT of a queried CustomerHier 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 CustomerHierText entities.

    • addCnsldtnCustomerHierT

      public void addCnsldtnCustomerHierT(CustomerHierText... entity)
      Adds elements to the list of associated CustomerHierText entities. This corresponds to the OData navigation property to_CnsldtnCustomerHierT.

      If the navigation property to_CnsldtnCustomerHierT of a queried CustomerHier 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 CustomerHierText entities.

    • builder

      @Nonnull public static CustomerHier.CustomerHierBuilder builder()

    • getAdditionalMasterDataHierarchy

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

      Original property name from the Odata EDM: AdditionalMasterDataHierarchy

      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:
      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

    • getCustomer

      @Nullable public String getCustomer()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: Customer

      Returns:
      Consolidation Customer

    • getCustomer_Text

      @Nullable public String getCustomer_Text()
      Constraints: Not nullable, Maximum length: 80

      Original property name from the Odata EDM: Customer_Text

      Returns:
      Customer 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<CustomerHier>

    • equals

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

    • canEqual

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

    • hashCode

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