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

Class SegmentText

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<SegmentText>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.segment.SegmentText
public class SegmentText extends VdmEntity<SegmentText>
Segment Text

Original entity name from the Odata EDM: A_SegmentTextType

  • Field Details

    • ALL_FIELDS

      public static final SegmentTextSelectable ALL_FIELDS
      Selector for all available fields of SegmentText.

    • LANGUAGE

      public static final SegmentTextField<String> LANGUAGE
      Use with available fluent helpers to apply the Language field to query operations.

    • SEGMENT

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

    • SEGMENT_NAME

      public static final SegmentTextField<String> SEGMENT_NAME
      Use with available fluent helpers to apply the SegmentName field to query operations.

    • TO_SEGMENT

      public static final SegmentTextOneToOneLink<Segment> TO_SEGMENT
      Use with available fluent helpers to apply the to_Segment navigation property to query operations.

  • Constructor Details

    • SegmentText

      public SegmentText()

    • SegmentText

      public SegmentText(@Nullable String language, @Nullable String segment, @Nullable String segmentName, @Nullable Segment toSegment)

  • Method Details

    • getType

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

    • setLanguage

      public void setLanguage(@Nullable String language)
      (Key Field) Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: Language

      Parameters:
      language - Language Key

    • 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 - Segment for Segmental Reporting

    • setSegmentName

      public void setSegmentName(@Nullable String segmentName)
      Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: SegmentName

      Parameters:
      segmentName - Segment Name

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> SegmentTextField<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> SegmentTextField<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<SegmentText>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchSegment

      @Nullable public Segment fetchSegment()
      Fetches the Segment entity (one to one) associated with this entity. This corresponds to the OData navigation property to_Segment.

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

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

    • getSegmentOrFetch

      @Nullable public Segment getSegmentOrFetch()
      Retrieval of associated Segment entity (one to one). This corresponds to the OData navigation property to_Segment.

      If the navigation property to_Segment of a queried SegmentText 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 Segment 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.

    • getSegmentIfPresent

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

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

    • setSegment

      public void setSegment(Segment value)
      Overwrites the associated Segment entity for the loaded navigation property to_Segment.
      Parameters:
      value - New Segment entity.

    • builder

      @Nonnull public static SegmentText.SegmentTextBuilder builder()

    • getLanguage

      @Nullable public String getLanguage()
      (Key Field) Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: Language

      Returns:
      Language Key

    • getSegment

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

      Original property name from the Odata EDM: Segment

      Returns:
      Segment for Segmental Reporting

    • getSegmentName

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

      Original property name from the Odata EDM: SegmentName

      Returns:
      Segment Name

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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