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

Class BusinessArea

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

Original entity name from the Odata EDM: BusinessAreaType

  • Field Details

    • ALL_FIELDS

      public static final BusinessAreaSelectable ALL_FIELDS
      Selector for all available fields of BusinessArea.

    • BUSINESS_AREA

      public static final BusinessAreaField<String> BUSINESS_AREA
      Use with available fluent helpers to apply the BusinessArea field to query operations.

    • BUSINESS_AREA_TEXT

      public static final BusinessAreaField<String> BUSINESS_AREA_TEXT
      Use with available fluent helpers to apply the BusinessArea_Text field to query operations.

    • ADDITIONAL_MASTER_DATA_SOURCE

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

    • TO_CNSLDTN_BUSINESS_AREA_HIER

      public static final BusinessAreaLink<BusinessAreaHier> TO_CNSLDTN_BUSINESS_AREA_HIER
      Use with available fluent helpers to apply the to_CnsldtnBusinessAreaHier navigation property to query operations.

    • TO_CNSLDTN_BUSINESS_AREA_T

      public static final BusinessAreaLink<BusinessAreaText> TO_CNSLDTN_BUSINESS_AREA_T
      Use with available fluent helpers to apply the to_CnsldtnBusinessAreaT navigation property to query operations.

  • Constructor Details

  • Method Details

    • getType

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

    • setBusinessArea

      public void setBusinessArea(@Nullable String businessArea)
      (Key Field) Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: BusinessArea

      Parameters:
      businessArea - Consolidation Business Area

    • setBusinessArea_Text

      public void setBusinessArea_Text(@Nullable String businessArea_Text)
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: BusinessArea_Text

      Parameters:
      businessArea_Text - Business 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<BusinessArea>

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> BusinessAreaField<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> BusinessAreaField<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<BusinessArea>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchCnsldtnBusinessAreaHier

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

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

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

    • getCnsldtnBusinessAreaHierOrFetch

      @Nonnull public List<BusinessAreaHier> getCnsldtnBusinessAreaHierOrFetch()
      Retrieval of associated BusinessAreaHier entities (one to many). This corresponds to the OData navigation property to_CnsldtnBusinessAreaHier.

      If the navigation property to_CnsldtnBusinessAreaHier of a queried BusinessArea 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 BusinessAreaHier 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.

    • getCnsldtnBusinessAreaHierIfPresent

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

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

    • setCnsldtnBusinessAreaHier

      public void setCnsldtnBusinessAreaHier(@Nonnull List<BusinessAreaHier> value)
      Overwrites the list of associated BusinessAreaHier entities for the loaded navigation property to_CnsldtnBusinessAreaHier.

      If the navigation property to_CnsldtnBusinessAreaHier of a queried BusinessArea 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 BusinessAreaHier entities.

    • addCnsldtnBusinessAreaHier

      public void addCnsldtnBusinessAreaHier(BusinessAreaHier... entity)
      Adds elements to the list of associated BusinessAreaHier entities. This corresponds to the OData navigation property to_CnsldtnBusinessAreaHier.

      If the navigation property to_CnsldtnBusinessAreaHier of a queried BusinessArea 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 BusinessAreaHier entities.

    • fetchCnsldtnBusinessAreaT

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

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

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

    • getCnsldtnBusinessAreaTOrFetch

      @Nonnull public List<BusinessAreaText> getCnsldtnBusinessAreaTOrFetch()
      Retrieval of associated BusinessAreaText entities (one to many). This corresponds to the OData navigation property to_CnsldtnBusinessAreaT.

      If the navigation property to_CnsldtnBusinessAreaT of a queried BusinessArea 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 BusinessAreaText 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.

    • getCnsldtnBusinessAreaTIfPresent

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

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

    • setCnsldtnBusinessAreaT

      public void setCnsldtnBusinessAreaT(@Nonnull List<BusinessAreaText> value)
      Overwrites the list of associated BusinessAreaText entities for the loaded navigation property to_CnsldtnBusinessAreaT.

      If the navigation property to_CnsldtnBusinessAreaT of a queried BusinessArea 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 BusinessAreaText entities.

    • addCnsldtnBusinessAreaT

      public void addCnsldtnBusinessAreaT(BusinessAreaText... entity)
      Adds elements to the list of associated BusinessAreaText entities. This corresponds to the OData navigation property to_CnsldtnBusinessAreaT.

      If the navigation property to_CnsldtnBusinessAreaT of a queried BusinessArea 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 BusinessAreaText entities.

    • builder

      @Nonnull public static BusinessArea.BusinessAreaBuilder builder()

    • getBusinessArea

      @Nullable public String getBusinessArea()
      (Key Field) Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: BusinessArea

      Returns:
      Consolidation Business Area

    • getBusinessArea_Text

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

      Original property name from the Odata EDM: BusinessArea_Text

      Returns:
      Business 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<BusinessArea>

    • equals

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

    • canEqual

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

    • hashCode

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