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

Class PartnerSegment

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<PartnerSegment>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.masterdataforgroupreporting.PartnerSegment
public class PartnerSegment extends VdmEntity<PartnerSegment>
Combined Partner Segment

Original entity name from the Odata EDM: PartnerSegmentType

  • Field Details

    • ALL_FIELDS

      public static final PartnerSegmentSelectable ALL_FIELDS
      Selector for all available fields of PartnerSegment.

    • SEGMENT

      public static final PartnerSegmentField<String> SEGMENT
      Use with available fluent helpers to apply the Segment field to query operations.

    • SEGMENT_TEXT

      public static final PartnerSegmentField<String> SEGMENT_TEXT
      Use with available fluent helpers to apply the Segment_Text field to query operations.

    • ADDITIONAL_MASTER_DATA_SOURCE

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

    • TO_CNSLDTN_PARTNER_SEGMENT_HIER

      public static final PartnerSegmentLink<PartnerSegmentHier> TO_CNSLDTN_PARTNER_SEGMENT_HIER
      Use with available fluent helpers to apply the to_CnsldtnPartnerSegmentHier navigation property to query operations.

    • TO_CNSLDTN_PARTNER_SEGMENT_T

      public static final PartnerSegmentLink<PartnerSegmentText> TO_CNSLDTN_PARTNER_SEGMENT_T
      Use with available fluent helpers to apply the to_CnsldtnPartnerSegmentT navigation property to query operations.

  • Constructor Details

  • Method Details

    • getType

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

    • setSegment

      public void setSegment(@Nullable String segment)
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: Segment

      Parameters:
      segment - Partner Segment

    • setSegment_Text

      public void setSegment_Text(@Nullable String segment_Text)
      Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: Segment_Text

      Parameters:
      segment_Text - Partner Segment 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<PartnerSegment>

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> PartnerSegmentField<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> PartnerSegmentField<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<PartnerSegment>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchCnsldtnPartnerSegmentHier

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

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

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

    • getCnsldtnPartnerSegmentHierOrFetch

      @Nonnull public List<PartnerSegmentHier> getCnsldtnPartnerSegmentHierOrFetch()
      Retrieval of associated PartnerSegmentHier entities (one to many). This corresponds to the OData navigation property to_CnsldtnPartnerSegmentHier.

      If the navigation property to_CnsldtnPartnerSegmentHier of a queried PartnerSegment 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 PartnerSegmentHier 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.

    • getCnsldtnPartnerSegmentHierIfPresent

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

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

    • setCnsldtnPartnerSegmentHier

      public void setCnsldtnPartnerSegmentHier(@Nonnull List<PartnerSegmentHier> value)
      Overwrites the list of associated PartnerSegmentHier entities for the loaded navigation property to_CnsldtnPartnerSegmentHier.

      If the navigation property to_CnsldtnPartnerSegmentHier of a queried PartnerSegment 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 PartnerSegmentHier entities.

    • addCnsldtnPartnerSegmentHier

      public void addCnsldtnPartnerSegmentHier(PartnerSegmentHier... entity)
      Adds elements to the list of associated PartnerSegmentHier entities. This corresponds to the OData navigation property to_CnsldtnPartnerSegmentHier.

      If the navigation property to_CnsldtnPartnerSegmentHier of a queried PartnerSegment 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 PartnerSegmentHier entities.

    • fetchCnsldtnPartnerSegmentT

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

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

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

    • getCnsldtnPartnerSegmentTOrFetch

      @Nonnull public List<PartnerSegmentText> getCnsldtnPartnerSegmentTOrFetch()
      Retrieval of associated PartnerSegmentText entities (one to many). This corresponds to the OData navigation property to_CnsldtnPartnerSegmentT.

      If the navigation property to_CnsldtnPartnerSegmentT of a queried PartnerSegment 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 PartnerSegmentText 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.

    • getCnsldtnPartnerSegmentTIfPresent

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

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

    • setCnsldtnPartnerSegmentT

      public void setCnsldtnPartnerSegmentT(@Nonnull List<PartnerSegmentText> value)
      Overwrites the list of associated PartnerSegmentText entities for the loaded navigation property to_CnsldtnPartnerSegmentT.

      If the navigation property to_CnsldtnPartnerSegmentT of a queried PartnerSegment 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 PartnerSegmentText entities.

    • addCnsldtnPartnerSegmentT

      public void addCnsldtnPartnerSegmentT(PartnerSegmentText... entity)
      Adds elements to the list of associated PartnerSegmentText entities. This corresponds to the OData navigation property to_CnsldtnPartnerSegmentT.

      If the navigation property to_CnsldtnPartnerSegmentT of a queried PartnerSegment 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 PartnerSegmentText entities.

    • builder

      @Nonnull public static PartnerSegment.PartnerSegmentBuilder builder()

    • getSegment

      @Nullable public String getSegment()
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: Segment

      Returns:
      Partner Segment

    • getSegment_Text

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

      Original property name from the Odata EDM: Segment_Text

      Returns:
      Partner Segment 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<PartnerSegment>

    • equals

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

    • canEqual

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

    • hashCode

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