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

Class ServiceQuotationText

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.servicequotation.ServiceQuotationText

public class ServiceQuotationText
extends VdmEntity<ServiceQuotationText>

Service Quotation Text API

Original entity name from the Odata EDM: A_ServiceQuotationTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ServiceQuotationTextSelectable	ALL_FIELDS Selector for all available fields of ServiceQuotationText.
static ServiceQuotationTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static ServiceQuotationTextField<String>	LONG_TEXT Use with available fluent helpers to apply the LongText field to query operations.
static ServiceQuotationTextField<String>	LONG_TEXT_ID Use with available fluent helpers to apply the LongTextID field to query operations.
static ServiceQuotationTextField<String>	SERVICE_QUOTATION Use with available fluent helpers to apply the ServiceQuotation field to query operations.
static ServiceQuotationTextOneToOneLink<ServiceQuotation>	TO_SERVICE_QUOTATION Use with available fluent helpers to apply the to_ServiceQuotation navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
ServiceQuotationText()
ServiceQuotationText(String serviceQuotation, String language, String longTextID, String longText, ServiceQuotation toServiceQuotation)

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 ServiceQuotationText.ServiceQuotationTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ServiceQuotation	fetchServiceQuotation() Fetches the ServiceQuotation entity (one to one) associated with this entity.
static <T> ServiceQuotationTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ServiceQuotationTextField<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	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	getLongText() Constraints: none
String	getLongTextID() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getServiceQuotation() (Key Field) Constraints: Not nullable, Maximum length: 10
io.vavr.control.Option<ServiceQuotation>	getServiceQuotationIfPresent() Retrieval of associated ServiceQuotation entity (one to one).
ServiceQuotation	getServiceQuotationOrFetch() Retrieval of associated ServiceQuotation entity (one to one).
Class<ServiceQuotationText>	getType()
int	hashCode()
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setLongText(String longText) Constraints: none
void	setLongTextID(String longTextID) (Key Field) Constraints: Not nullable, Maximum length: 4
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setServiceQuotation(ServiceQuotation value) Overwrites the associated ServiceQuotation entity for the loaded navigation property to_ServiceQuotation.
void	setServiceQuotation(String serviceQuotation) (Key Field) Constraints: Not nullable, Maximum length: 10
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 ServiceQuotationTextSelectable ALL_FIELDS

Selector for all available fields of ServiceQuotationText.

SERVICE_QUOTATION

public static final ServiceQuotationTextField<String> SERVICE_QUOTATION

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

LANGUAGE

public static final ServiceQuotationTextField<String> LANGUAGE

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

LONG_TEXT_ID

public static final ServiceQuotationTextField<String> LONG_TEXT_ID

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

LONG_TEXT

public static final ServiceQuotationTextField<String> LONG_TEXT

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

TO_SERVICE_QUOTATION

public static final ServiceQuotationTextOneToOneLink<ServiceQuotation> TO_SERVICE_QUOTATION

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

Constructor Detail

ServiceQuotationText

public ServiceQuotationText()

ServiceQuotationText

public ServiceQuotationText(@Nullable
                            String serviceQuotation,
                            @Nullable
                            String language,
                            @Nullable
                            String longTextID,
                            @Nullable
                            String longText,
                            @Nullable
                            ServiceQuotation toServiceQuotation)

Method Detail

getType

@Nonnull
public Class<ServiceQuotationText> getType()

Specified by:

getType in class VdmObject<ServiceQuotationText>

Returns:

The class of this object.

setServiceQuotation

public void setServiceQuotation(@Nullable
                                String serviceQuotation)

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

Original property name from the Odata EDM: ServiceQuotation

Parameters:

serviceQuotation - Number which identifies the transaction document. It is unique for the respective business transaction category.

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

setLongTextID

public void setLongTextID(@Nullable
                          String longTextID)

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

Original property name from the Odata EDM: LongTextID

ST for user-specific standard texts (individual texts)SYST for cross-application system textsvarious IDs for specific application departments. You must have the appropriate access authorization in order to access these texts.

Parameters:

longTextID - The text ID defines the various types of texts related to a text object. For example, the object "TEXT" (standard texts) can have the following text IDs:

setLongText

public void setLongText(@Nullable
                        String longText)

Constraints: none

Original property name from the Odata EDM: LongText

Parameters:

longText - String

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<ServiceQuotationText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ServiceQuotationText>

fromMap

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

Overrides:

fromMap in class VdmObject<ServiceQuotationText>

field

@Nonnull
public static <T> ServiceQuotationTextField<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> ServiceQuotationTextField<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<ServiceQuotationText>

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

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

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

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

fetchServiceQuotation

@Nullable
public ServiceQuotation fetchServiceQuotation()
                                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getServiceQuotationOrFetch

@Nullable
public ServiceQuotation getServiceQuotationOrFetch()
                                                      throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated ServiceQuotation entity (one to one). This corresponds to the OData navigation property to_ServiceQuotation.

If the navigation property to_ServiceQuotation of a queried ServiceQuotationText 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 ServiceQuotation 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.

getServiceQuotationIfPresent

@Nonnull
public io.vavr.control.Option<ServiceQuotation> getServiceQuotationIfPresent()

Retrieval of associated ServiceQuotation entity (one to one). This corresponds to the OData navigation property to_ServiceQuotation.

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

setServiceQuotation

public void setServiceQuotation(ServiceQuotation value)

Overwrites the associated ServiceQuotation entity for the loaded navigation property to_ServiceQuotation.

Parameters:

value - New ServiceQuotation entity.

builder

public static ServiceQuotationText.ServiceQuotationTextBuilder builder()

getServiceQuotation

@Nullable
public String getServiceQuotation()

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

Original property name from the Odata EDM: ServiceQuotation

Returns:

Number which identifies the transaction document. It is unique for the respective business transaction category.

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

getLongTextID

@Nullable
public String getLongTextID()

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

Original property name from the Odata EDM: LongTextID

ST for user-specific standard texts (individual texts)SYST for cross-application system textsvarious IDs for specific application departments. You must have the appropriate access authorization in order to access these texts.

Returns:

The text ID defines the various types of texts related to a text object. For example, the object "TEXT" (standard texts) can have the following text IDs:

getLongText

@Nullable
public String getLongText()

Constraints: none

Original property name from the Odata EDM: LongText

Returns:

String

toString

public String toString()

Overrides:

toString in class VdmObject<ServiceQuotationText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<ServiceQuotationText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<ServiceQuotationText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ServiceQuotationText>