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

Class CustomerText

java.lang.Object

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

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

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

public class CustomerText
extends VdmEntity<CustomerText>

Consolidation - Combined Customer Text

Original entity name from the Odata EDM: CustomerTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static CustomerTextSelectable	ALL_FIELDS Selector for all available fields of CustomerText.
static CustomerTextField<String>	CNSLDTN_CUSTOMER_TEXT Use with available fluent helpers to apply the CnsldtnCustomerText field to query operations.
static CustomerTextField<String>	CUSTOMER Use with available fluent helpers to apply the Customer field to query operations.
static CustomerTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static CustomerTextOneToOneLink<Customer>	TO_CNSLDTN_CUSTOMER Use with available fluent helpers to apply the to_CnsldtnCustomer navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
CustomerText()
CustomerText(String language, String customer, String cnsldtnCustomerText, Customer toCnsldtnCustomer)

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 CustomerText.CustomerTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Customer	fetchCnsldtnCustomer() Fetches the Customer entity (one to one) associated with this entity.
static <T> CustomerTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> CustomerTextField<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<Customer>	getCnsldtnCustomerIfPresent() Retrieval of associated Customer entity (one to one).
Customer	getCnsldtnCustomerOrFetch() Retrieval of associated Customer entity (one to one).
String	getCnsldtnCustomerText() Constraints: Not nullable, Maximum length: 80
String	getCustomer() (Key Field) Constraints: Not nullable, Maximum length: 10
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
Class<CustomerText>	getType()
int	hashCode()
void	setCnsldtnCustomer(Customer value) Overwrites the associated Customer entity for the loaded navigation property to_CnsldtnCustomer.
void	setCnsldtnCustomerText(String cnsldtnCustomerText) Constraints: Not nullable, Maximum length: 80
void	setCustomer(String customer) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
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 CustomerTextSelectable ALL_FIELDS

Selector for all available fields of CustomerText.

LANGUAGE

public static final CustomerTextField<String> LANGUAGE

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

CUSTOMER

public static final CustomerTextField<String> CUSTOMER

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

CNSLDTN_CUSTOMER_TEXT

public static final CustomerTextField<String> CNSLDTN_CUSTOMER_TEXT

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

TO_CNSLDTN_CUSTOMER

public static final CustomerTextOneToOneLink<Customer> TO_CNSLDTN_CUSTOMER

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

Constructor Detail

CustomerText

public CustomerText()

CustomerText

public CustomerText(@Nullable
                    String language,
                    @Nullable
                    String customer,
                    @Nullable
                    String cnsldtnCustomerText,
                    @Nullable
                    Customer toCnsldtnCustomer)

Method Detail

getType

@Nonnull
public Class<CustomerText> getType()

Specified by:

getType in class VdmObject<CustomerText>

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.

setCustomer

public void setCustomer(@Nullable
                        String customer)

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

Original property name from the Odata EDM: Customer

Parameters:

customer - Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system.

setCnsldtnCustomerText

public void setCnsldtnCustomerText(@Nullable
                                   String cnsldtnCustomerText)

Constraints: Not nullable, Maximum length: 80

Original property name from the Odata EDM: CnsldtnCustomerText

Parameters:

cnsldtnCustomerText - Customer Description

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<CustomerText>

getKey

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

Overrides:

getKey in class VdmObject<CustomerText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<CustomerText>

fromMap

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

Overrides:

fromMap in class VdmObject<CustomerText>

field

@Nonnull
public static <T> CustomerTextField<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> CustomerTextField<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<CustomerText>

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

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

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

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<CustomerText>

fetchCnsldtnCustomer

@Nullable
public Customer fetchCnsldtnCustomer()
                                        throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getCnsldtnCustomerOrFetch

@Nullable
public Customer getCnsldtnCustomerOrFetch()
                                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated Customer entity (one to one). This corresponds to the OData navigation property to_CnsldtnCustomer.

If the navigation property to_CnsldtnCustomer of a queried CustomerText 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 Customer 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.

getCnsldtnCustomerIfPresent

@Nonnull
public io.vavr.control.Option<Customer> getCnsldtnCustomerIfPresent()

Retrieval of associated Customer entity (one to one). This corresponds to the OData navigation property to_CnsldtnCustomer.

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

setCnsldtnCustomer

public void setCnsldtnCustomer(Customer value)

Overwrites the associated Customer entity for the loaded navigation property to_CnsldtnCustomer.

Parameters:

value - New Customer entity.

builder

public static CustomerText.CustomerTextBuilder 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.

getCustomer

@Nullable
public String getCustomer()

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

Original property name from the Odata EDM: Customer

Returns:

Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system.

getCnsldtnCustomerText

@Nullable
public String getCnsldtnCustomerText()

Constraints: Not nullable, Maximum length: 80

Original property name from the Odata EDM: CnsldtnCustomerText

Returns:

Customer Description

toString

public String toString()

Overrides:

toString in class VdmObject<CustomerText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<CustomerText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<CustomerText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<CustomerText>