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

Class FunctionalArea

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

Original entity name from the Odata EDM: FunctionalAreaType

  • Field Details

    • ALL_FIELDS

      public static final FunctionalAreaSelectable ALL_FIELDS
      Selector for all available fields of FunctionalArea.

    • FUNCTIONAL_AREA

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

    • FUNCTIONAL_AREA_TEXT

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

    • ADDITIONAL_MASTER_DATA_SOURCE

      public static final FunctionalAreaField<String> ADDITIONAL_MASTER_DATA_SOURCE
      Use with available fluent helpers to apply the AdditionalMasterDataSource field to query operations.

    • TO_CNSLDTN_FUNCTIONAL_AREA_HIER

      public static final FunctionalAreaLink<FunctionalAreaHier> TO_CNSLDTN_FUNCTIONAL_AREA_HIER
      Use with available fluent helpers to apply the to_CnsldtnFunctionalAreaHier navigation property to query operations.

    • TO_CNSLDTN_FUNCTIONAL_AREA_T

      public static final FunctionalAreaLink<FunctionalAreaText> TO_CNSLDTN_FUNCTIONAL_AREA_T
      Use with available fluent helpers to apply the to_CnsldtnFunctionalAreaT navigation property to query operations.

  • Constructor Details

  • Method Details

    • getType

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

    • setFunctionalArea

      public void setFunctionalArea(@Nullable String functionalArea)
      (Key Field) 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

    • setAdditionalMasterDataSource

      public void setAdditionalMasterDataSource(@Nullable String additionalMasterDataSource)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: AdditionalMasterDataSource

      Parameters:
      additionalMasterDataSource - Consolidation Additional Master Data Source

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> FunctionalAreaField<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> FunctionalAreaField<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<FunctionalArea>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchCnsldtnFunctionalAreaHier

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

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

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

    • getCnsldtnFunctionalAreaHierOrFetch

      @Nonnull public List<FunctionalAreaHier> getCnsldtnFunctionalAreaHierOrFetch()
      Retrieval of associated FunctionalAreaHier entities (one to many). This corresponds to the OData navigation property to_CnsldtnFunctionalAreaHier.

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

    • getCnsldtnFunctionalAreaHierIfPresent

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

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

    • setCnsldtnFunctionalAreaHier

      public void setCnsldtnFunctionalAreaHier(@Nonnull List<FunctionalAreaHier> value)
      Overwrites the list of associated FunctionalAreaHier entities for the loaded navigation property to_CnsldtnFunctionalAreaHier.

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

    • addCnsldtnFunctionalAreaHier

      public void addCnsldtnFunctionalAreaHier(FunctionalAreaHier... entity)
      Adds elements to the list of associated FunctionalAreaHier entities. This corresponds to the OData navigation property to_CnsldtnFunctionalAreaHier.

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

    • fetchCnsldtnFunctionalAreaT

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

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

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

    • getCnsldtnFunctionalAreaTOrFetch

      @Nonnull public List<FunctionalAreaText> getCnsldtnFunctionalAreaTOrFetch()
      Retrieval of associated FunctionalAreaText entities (one to many). This corresponds to the OData navigation property to_CnsldtnFunctionalAreaT.

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

    • getCnsldtnFunctionalAreaTIfPresent

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

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

    • setCnsldtnFunctionalAreaT

      public void setCnsldtnFunctionalAreaT(@Nonnull List<FunctionalAreaText> value)
      Overwrites the list of associated FunctionalAreaText entities for the loaded navigation property to_CnsldtnFunctionalAreaT.

      If the navigation property to_CnsldtnFunctionalAreaT of a queried FunctionalArea 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 FunctionalAreaText entities.

    • addCnsldtnFunctionalAreaT

      public void addCnsldtnFunctionalAreaT(FunctionalAreaText... entity)
      Adds elements to the list of associated FunctionalAreaText entities. This corresponds to the OData navigation property to_CnsldtnFunctionalAreaT.

      If the navigation property to_CnsldtnFunctionalAreaT of a queried FunctionalArea 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 FunctionalAreaText entities.

    • builder

      @Nonnull public static FunctionalArea.FunctionalAreaBuilder builder()

    • getFunctionalArea

      @Nullable public String getFunctionalArea()
      (Key Field) 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

    • getAdditionalMasterDataSource

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

      Original property name from the Odata EDM: AdditionalMasterDataSource

      Returns:
      Consolidation Additional Master Data Source

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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