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

Class Segment

java.lang.Object

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

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

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

public class Segment
extends VdmEntity<Segment>

API Segment

Original entity name from the Odata EDM: A_SegmentType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Segment.SegmentBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static SegmentSelectable	ALL_FIELDS Selector for all available fields of Segment.
static SegmentField<String>	SEGMENT Use with available fluent helpers to apply the Segment field to query operations.
static SegmentLink<SegmentText>	TO_TEXT Use with available fluent helpers to apply the to_Text 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
Segment()
Segment(String segment, ErpConfigContext erpConfigContext, List<SegmentText> toText)

Method Summary

Modifier and Type	Method and Description
void	addText(SegmentText... entity) Adds elements to the list of associated SegmentText entities.
static Segment.SegmentBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<SegmentText>	fetchText() Fetches the SegmentText entities (one to many) associated with this entity.
static <T> SegmentField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SegmentField<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	getSegment() (Key Field) Constraints: Not nullable, Maximum length: 10
Optional<List<SegmentText>>	getTextIfPresent() Retrieval of associated SegmentText entities (one to many).
List<SegmentText>	getTextOrFetch() Retrieval of associated SegmentText entities (one to many).
Class<Segment>	getType()
int	hashCode()
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setSegment(String segment) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setText(List<SegmentText> value) Overwrites the list of associated SegmentText entities for the loaded navigation property to_Text.
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 SegmentSelectable ALL_FIELDS

Selector for all available fields of Segment.

SEGMENT

public static final SegmentField<String> SEGMENT

Use with available fluent helpers to apply the Segment field to query operations.

TO_TEXT

public static final SegmentLink<SegmentText> TO_TEXT

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

Constructor Detail

Segment

public Segment()

Segment

public Segment(@Nullable
               String segment,
               @Nullable
               ErpConfigContext erpConfigContext,
               List<SegmentText> toText)

Method Detail

getType

public Class<Segment> getType()

Specified by:

getType in class VdmObject<Segment>

Returns:

The class of this object.

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

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<Segment>

getKey

protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<Segment>

Returns:

The compound key of this object.

toMapOfFields

@Nonnull
protected Map<String,Object> toMapOfFields()

Overrides:

toMapOfFields in class VdmObject<Segment>

fromMap

protected void fromMap(Map<String,Object> inputValues)

Overrides:

fromMap in class VdmObject<Segment>

field

@Nonnull
public static <T> SegmentField<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> SegmentField<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<Segment>

fetchText

public List<SegmentText> fetchText()
                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the SegmentText entities (one to many) associated with this entity. This corresponds to the OData navigation property to_Text.

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

Returns:

List containing one or more associated SegmentText entities. If no entities are associated then an empty list is returned.

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.

getTextOrFetch

public List<SegmentText> getTextOrFetch()
                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated SegmentText entities (one to many). This corresponds to the OData navigation property to_Text.

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

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.

getTextIfPresent

public Optional<List<SegmentText>> getTextIfPresent()

Retrieval of associated SegmentText entities (one to many). This corresponds to the OData navigation property to_Text.

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

setText

public void setText(@Nonnull
                    List<SegmentText> value)

Overwrites the list of associated SegmentText entities for the loaded navigation property to_Text.

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

addText

public void addText(SegmentText... entity)

Adds elements to the list of associated SegmentText entities. This corresponds to the OData navigation property to_Text.

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

builder

public static Segment.SegmentBuilder builder()

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

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

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<Segment>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<Segment>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<Segment>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<Segment>