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

Class PartnerSegmentText

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<PartnerSegmentText>

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

public class PartnerSegmentText
extends VdmEntity<PartnerSegmentText>

Consolidation - Combined Partner Segment Text

Original entity name from the Odata EDM: PartnerSegmentTextType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PartnerSegmentText.PartnerSegmentTextBuilder Helper class to allow for fluent creation of PartnerSegmentText instances.

Field Summary

Fields

Modifier and Type	Field and Description
static PartnerSegmentTextSelectable	ALL_FIELDS Selector for all available fields of PartnerSegmentText.
static PartnerSegmentTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static PartnerSegmentTextField<String>	PARTNER_SEGMENT_TEXT Use with available fluent helpers to apply the PartnerSegmentText field to query operations.
static PartnerSegmentTextField<String>	SEGMENT Use with available fluent helpers to apply the Segment field to query operations.
static PartnerSegmentTextOneToOneLink<PartnerSegment>	TO_CNSLDTN_PARTNER_SEGMENT Use with available fluent helpers to apply the to_CnsldtnPartnerSegment navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
PartnerSegmentText()
PartnerSegmentText(String language, String segment, String partnerSegmentText, PartnerSegment toCnsldtnPartnerSegment)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static PartnerSegmentText.PartnerSegmentTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
PartnerSegment	fetchCnsldtnPartnerSegment() Fetches the PartnerSegment entity (one to one) associated with this entity.
static <T> PartnerSegmentTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> PartnerSegmentTextField<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)
io.vavr.control.Option<PartnerSegment>	getCnsldtnPartnerSegmentIfPresent() Retrieval of associated PartnerSegment entity (one to one).
PartnerSegment	getCnsldtnPartnerSegmentOrFetch() Retrieval of associated PartnerSegment entity (one to one).
protected String	getDefaultServicePath()
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection()
protected Map<String,Object>	getKey()
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getPartnerSegmentText() Constraints: Not nullable, Maximum length: 50
String	getSegment() (Key Field) Constraints: Not nullable, Maximum length: 10
Class<PartnerSegmentText>	getType()
int	hashCode()
void	setCnsldtnPartnerSegment(PartnerSegment value) Overwrites the associated PartnerSegment entity for the loaded navigation property to_CnsldtnPartnerSegment.
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setPartnerSegmentText(String partnerSegmentText) Constraints: Not nullable, Maximum length: 50
void	setSegment(String segment) (Key Field) Constraints: Not nullable, Maximum length: 10
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

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

getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.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 PartnerSegmentTextSelectable ALL_FIELDS

Selector for all available fields of PartnerSegmentText.

LANGUAGE

public static final PartnerSegmentTextField<String> LANGUAGE

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

SEGMENT

public static final PartnerSegmentTextField<String> SEGMENT

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

PARTNER_SEGMENT_TEXT

public static final PartnerSegmentTextField<String> PARTNER_SEGMENT_TEXT

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

TO_CNSLDTN_PARTNER_SEGMENT

public static final PartnerSegmentTextOneToOneLink<PartnerSegment> TO_CNSLDTN_PARTNER_SEGMENT

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

Constructor Detail

PartnerSegmentText

public PartnerSegmentText()

PartnerSegmentText

public PartnerSegmentText(@Nullable
                          String language,
                          @Nullable
                          String segment,
                          @Nullable
                          String partnerSegmentText,
                          @Nullable
                          PartnerSegment toCnsldtnPartnerSegment)

Method Detail

getType

@Nonnull
public Class<PartnerSegmentText> getType()

Specified by:

getType in class VdmObject<PartnerSegmentText>

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

setPartnerSegmentText

public void setPartnerSegmentText(@Nullable
                                  String partnerSegmentText)

Constraints: Not nullable, Maximum length: 50

Original property name from the Odata EDM: PartnerSegmentText

Parameters:

partnerSegmentText - Partner Segment Description

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<PartnerSegmentText>

getKey

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

Overrides:

getKey in class VdmObject<PartnerSegmentText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<PartnerSegmentText>

fromMap

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

Overrides:

fromMap in class VdmObject<PartnerSegmentText>

field

@Nonnull
public static <T> PartnerSegmentTextField<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> PartnerSegmentTextField<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 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()

Description copied from class: VdmEntity

Convienence field for reusing the same destination with multiple queries (e.g. fetching associated entities). New destination to apply to this entity

Overrides:

getDestinationForFetch in class VdmEntity<PartnerSegmentText>

Returns:

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

setServicePathForFetch

protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)

Description copied from class: VdmEntity

The service path only used for the fetch commands of this entity.

Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.

Overrides:

setServicePathForFetch in class VdmEntity<PartnerSegmentText>

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)

Description copied from class: VdmEntity

Sets the service path and destination for the fetch commands of this entity. Also applies to any associated entities (navigation properties) that were previously fetched.

Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.

Overrides:

attachToService in class VdmEntity<PartnerSegmentText>

Parameters:

servicePath - Optional parameter. New service path to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the service path has never been set, then the service path will be set to the default defined in the corresponding service interface.

destination - New destination to apply to this entity and any associated entities that were previously fetched.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<PartnerSegmentText>

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<PartnerSegmentText>

fetchCnsldtnPartnerSegment

@Nullable
public PartnerSegment fetchCnsldtnPartnerSegment()
                                                    throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the PartnerSegment entity (one to one) associated with this entity. This corresponds to the OData navigation property to_CnsldtnPartnerSegment.

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

Returns:

The single associated PartnerSegment 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.

getCnsldtnPartnerSegmentOrFetch

@Nullable
public PartnerSegment getCnsldtnPartnerSegmentOrFetch()
                                                         throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated PartnerSegment entity (one to one). This corresponds to the OData navigation property to_CnsldtnPartnerSegment.

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

getCnsldtnPartnerSegmentIfPresent

@Nonnull
public io.vavr.control.Option<PartnerSegment> getCnsldtnPartnerSegmentIfPresent()

Retrieval of associated PartnerSegment entity (one to one). This corresponds to the OData navigation property to_CnsldtnPartnerSegment.

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

setCnsldtnPartnerSegment

public void setCnsldtnPartnerSegment(PartnerSegment value)

Overwrites the associated PartnerSegment entity for the loaded navigation property to_CnsldtnPartnerSegment.

Parameters:

value - New PartnerSegment entity.

builder

public static PartnerSegmentText.PartnerSegmentTextBuilder 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:

Partner Segment

getPartnerSegmentText

@Nullable
public String getPartnerSegmentText()

Constraints: Not nullable, Maximum length: 50

Original property name from the Odata EDM: PartnerSegmentText

Returns:

Partner Segment Description

toString

public String toString()

Overrides:

toString in class VdmObject<PartnerSegmentText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<PartnerSegmentText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<PartnerSegmentText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<PartnerSegmentText>