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

Class PartnerCompanyText

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.namespaces.masterdataforgroupreporting.PartnerCompanyText

public class PartnerCompanyText
extends VdmEntity<PartnerCompanyText>

Global Company Text

Original entity name from the Odata EDM: PartnerCompanyTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static PartnerCompanyTextField<String>	ADDITIONAL_MASTER_DATA_SOURCE Use with available fluent helpers to apply the AdditionalMasterDataSource field to query operations.
static PartnerCompanyTextSelectable	ALL_FIELDS Selector for all available fields of PartnerCompanyText.
static PartnerCompanyTextField<String>	COMPANY Use with available fluent helpers to apply the Company field to query operations.
static PartnerCompanyTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static PartnerCompanyTextField<String>	PARTNER_COMPANY_TEXT Use with available fluent helpers to apply the PartnerCompanyText field to query operations.
static PartnerCompanyTextOneToOneLink<PartnerCompany>	TO_CNSLDTN_GLOBAL_COMPANY Use with available fluent helpers to apply the to_CnsldtnGlobalCompany navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
PartnerCompanyText()
PartnerCompanyText(String language, String company, String additionalMasterDataSource, String partnerCompanyText, PartnerCompany toCnsldtnGlobalCompany)

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 PartnerCompanyText.PartnerCompanyTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
PartnerCompany	fetchCnsldtnGlobalCompany() Fetches the PartnerCompany entity (one to one) associated with this entity.
static <T> PartnerCompanyTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> PartnerCompanyTextField<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)
String	getAdditionalMasterDataSource() Constraints: Not nullable, Maximum length: 10
io.vavr.control.Option<PartnerCompany>	getCnsldtnGlobalCompanyIfPresent() Retrieval of associated PartnerCompany entity (one to one).
PartnerCompany	getCnsldtnGlobalCompanyOrFetch() Retrieval of associated PartnerCompany entity (one to one).
String	getCompany() (Key Field) Constraints: Not nullable, Maximum length: 6
protected String	getDefaultServicePath() Used by fluent helpers and navigation property methods to construct OData queries.
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
protected Map<String,Object>	getKey()
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getPartnerCompanyText() Constraints: Not nullable, Maximum length: 30
Class<PartnerCompanyText>	getType()
int	hashCode()
void	setAdditionalMasterDataSource(String additionalMasterDataSource) Constraints: Not nullable, Maximum length: 10
void	setCnsldtnGlobalCompany(PartnerCompany value) Overwrites the associated PartnerCompany entity for the loaded navigation property to_CnsldtnGlobalCompany.
void	setCompany(String company) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setPartnerCompanyText(String partnerCompanyText) Constraints: Not nullable, Maximum length: 30
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 PartnerCompanyTextSelectable ALL_FIELDS

Selector for all available fields of PartnerCompanyText.

LANGUAGE

public static final PartnerCompanyTextField<String> LANGUAGE

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

COMPANY

public static final PartnerCompanyTextField<String> COMPANY

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

ADDITIONAL_MASTER_DATA_SOURCE

public static final PartnerCompanyTextField<String> ADDITIONAL_MASTER_DATA_SOURCE

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

PARTNER_COMPANY_TEXT

public static final PartnerCompanyTextField<String> PARTNER_COMPANY_TEXT

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

TO_CNSLDTN_GLOBAL_COMPANY

public static final PartnerCompanyTextOneToOneLink<PartnerCompany> TO_CNSLDTN_GLOBAL_COMPANY

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

Constructor Detail

PartnerCompanyText

public PartnerCompanyText()

PartnerCompanyText

public PartnerCompanyText(@Nullable
                          String language,
                          @Nullable
                          String company,
                          @Nullable
                          String additionalMasterDataSource,
                          @Nullable
                          String partnerCompanyText,
                          @Nullable
                          PartnerCompany toCnsldtnGlobalCompany)

Method Detail

getType

@Nonnull
public Class<PartnerCompanyText> getType()

Specified by:

getType in class VdmObject<PartnerCompanyText>

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

Parameters:

language - The language to set.

setCompany

public void setCompany(@Nullable
                       String company)

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

Original property name from the Odata EDM: Company

Parameters:

company - Company

setAdditionalMasterDataSource

public void setAdditionalMasterDataSource(@Nullable
                                          String additionalMasterDataSource)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: AdditionalMasterDataSource

Parameters:

additionalMasterDataSource - Master Data Source

setPartnerCompanyText

public void setPartnerCompanyText(@Nullable
                                  String partnerCompanyText)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: PartnerCompanyText

Parameters:

partnerCompanyText - Partner Company Description

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<PartnerCompanyText>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<PartnerCompanyText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<PartnerCompanyText>

fromMap

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

Overrides:

fromMap in class VdmObject<PartnerCompanyText>

field

@Nonnull
public static <T> PartnerCompanyTextField<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> PartnerCompanyTextField<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<PartnerCompanyText>

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

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

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()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<PartnerCompanyText>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<PartnerCompanyText>

fetchCnsldtnGlobalCompany

@Nullable
public PartnerCompany fetchCnsldtnGlobalCompany()
                                                   throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getCnsldtnGlobalCompanyOrFetch

@Nullable
public PartnerCompany getCnsldtnGlobalCompanyOrFetch()
                                                        throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated PartnerCompany entity (one to one). This corresponds to the OData navigation property to_CnsldtnGlobalCompany.

If the navigation property to_CnsldtnGlobalCompany of a queried PartnerCompanyText 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 PartnerCompany 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.

getCnsldtnGlobalCompanyIfPresent

@Nonnull
public io.vavr.control.Option<PartnerCompany> getCnsldtnGlobalCompanyIfPresent()

Retrieval of associated PartnerCompany entity (one to one). This corresponds to the OData navigation property to_CnsldtnGlobalCompany.

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

setCnsldtnGlobalCompany

public void setCnsldtnGlobalCompany(PartnerCompany value)

Overwrites the associated PartnerCompany entity for the loaded navigation property to_CnsldtnGlobalCompany.

Parameters:

value - New PartnerCompany entity.

builder

@Nonnull
public static PartnerCompanyText.PartnerCompanyTextBuilder builder()

getLanguage

@Nullable
public String getLanguage()

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

Original property name from the Odata EDM: Language

Returns:

The language contained in this entity.

getCompany

@Nullable
public String getCompany()

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

Original property name from the Odata EDM: Company

Returns:

Company

getAdditionalMasterDataSource

@Nullable
public String getAdditionalMasterDataSource()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: AdditionalMasterDataSource

Returns:

Master Data Source

getPartnerCompanyText

@Nullable
public String getPartnerCompanyText()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: PartnerCompanyText

Returns:

Partner Company Description

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<PartnerCompanyText>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<PartnerCompanyText>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<PartnerCompanyText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<PartnerCompanyText>