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

Class SegmentText

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject<EntityT>

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity<SegmentText>

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

public class SegmentText
extends VdmEntity<SegmentText>

API Segment Text

Original entity name from the Odata EDM: A_SegmentTextType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SegmentText.SegmentTextBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static SegmentTextSelectable	ALL_FIELDS Selector for all available fields of SegmentText.
static SegmentTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static SegmentTextField<String>	SEGMENT Use with available fluent helpers to apply the Segment field to query operations.
static SegmentTextField<String>	SEGMENT_NAME Use with available fluent helpers to apply the SegmentName field to query operations.
static SegmentTextLink<Segment>	TO_SEGMENT Use with available fluent helpers to apply the to_Segment navigation property to query operations.

Fields inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
SegmentText()
SegmentText(String language, String segment, String segmentName, ErpConfigContext erpConfigContext, Segment toSegment)

Method Summary

Modifier and Type	Method and Description
static SegmentText.SegmentTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Segment	fetchSegment() Fetches the Segment entity (one to one) associated with this entity.
static <T> SegmentTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SegmentTextField<T>	field(String fieldName, TypeConverter<T,DomainT> typeConverter) Use with available fluent helpers to apply an extension field to query operations.
protected void	fromMap(Map<String,Object> inputValues)
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
protected Map<String,Object>	getKey()
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getSegment() (Key Field) Constraints: Not nullable, Maximum length: 10
Optional<Segment>	getSegmentIfPresent() Retrieval of associated Segment entity (one to one).
String	getSegmentName() Constraints: Not nullable, Maximum length: 50
Segment	getSegmentOrFetch() Retrieval of associated Segment entity (one to one).
Class<SegmentText>	getType()
int	hashCode()
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setSegment(Segment value) Overwrites the associated Segment entity for the loaded navigation property to_Segment.
void	setSegment(String segment) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setSegmentName(String segmentName) Constraints: Not nullable, Maximum length: 50
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity

getEndpointUrl, getServicePathForFetch, getVersionIdentifier, setServicePathForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject

getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

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 SegmentTextLink<Segment> TO_SEGMENT

Use with available fluent helpers to apply the to_Segment navigation property to query operations.

Constructor Detail

SegmentText

public SegmentText()

SegmentText

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

Method Detail

getType

public Class<SegmentText> getType()

Specified by:

getType in class VdmObject<SegmentText>

Returns:

The class of this object.

setLanguage

public void setLanguage(@Nullable
                        String language)

(Key Field) Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Parameters:

language - The language key indicates

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

protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<SegmentText>

Returns:

The compound key of this object.

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.

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.

Parameters:

typeConverter - A TypeConverter 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.

toMapOfNavigationProperties

protected Map<String,Object> toMapOfNavigationProperties()

Overrides:

toMapOfNavigationProperties in class VdmObject<SegmentText>

fetchSegment

public Segment fetchSegment()
                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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.odatav2.connectivity.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

public Segment getSegmentOrFetch()
                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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.odatav2.connectivity.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

public Optional<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 Optional 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 Optional 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

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

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Returns:

The language key indicates

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

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setErpConfigContext

public void setErpConfigContext(@Nullable
                                ErpConfigContext erpConfigContext)

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Overrides:

setErpConfigContext in class VdmEntity<SegmentText>

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<SegmentText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<SegmentText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<SegmentText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SegmentText>