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

Class SalesOrderItemText

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesorder.SalesOrderItemText

public class SalesOrderItemText
extends VdmEntity<SalesOrderItemText>

Sales Order Item Text (API)

Original entity name from the Odata EDM: A_SalesOrderItemTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static SalesOrderItemTextSelectable	ALL_FIELDS Selector for all available fields of SalesOrderItemText.
static SalesOrderItemTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static SalesOrderItemTextField<String>	LONG_TEXT Use with available fluent helpers to apply the LongText field to query operations.
static SalesOrderItemTextField<String>	LONG_TEXT_ID Use with available fluent helpers to apply the LongTextID field to query operations.
static SalesOrderItemTextField<String>	SALES_ORDER Use with available fluent helpers to apply the SalesOrder field to query operations.
static SalesOrderItemTextField<String>	SALES_ORDER_ITEM Use with available fluent helpers to apply the SalesOrderItem field to query operations.
static SalesOrderItemTextOneToOneLink<SalesOrder>	TO_SALES_ORDER Use with available fluent helpers to apply the to_SalesOrder navigation property to query operations.
static SalesOrderItemTextOneToOneLink<SalesOrderItem>	TO_SALES_ORDER_ITEM Use with available fluent helpers to apply the to_SalesOrderItem 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
SalesOrderItemText()
SalesOrderItemText(String salesOrder, String salesOrderItem, String language, String longTextID, String longText, SalesOrder toSalesOrder, SalesOrderItem toSalesOrderItem)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static SalesOrderItemText.SalesOrderItemTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
SalesOrder	fetchSalesOrder() Fetches the SalesOrder entity (one to one) associated with this entity.
SalesOrderItem	fetchSalesOrderItem() Fetches the SalesOrderItem entity (one to one) associated with this entity.
static <T> SalesOrderItemTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SalesOrderItemTextField<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()
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	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getLongText() Constraints: none
String	getLongTextID() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getSalesOrder() (Key Field) Constraints: Not nullable, Maximum length: 10
Optional<SalesOrder>	getSalesOrderIfPresent() Retrieval of associated SalesOrder entity (one to one).
String	getSalesOrderItem() (Key Field) Constraints: Not nullable, Maximum length: 6
Optional<SalesOrderItem>	getSalesOrderItemIfPresent() Retrieval of associated SalesOrderItem entity (one to one).
SalesOrderItem	getSalesOrderItemOrFetch() Retrieval of associated SalesOrderItem entity (one to one).
SalesOrder	getSalesOrderOrFetch() Retrieval of associated SalesOrder entity (one to one).
Class<SalesOrderItemText>	getType()
int	hashCode()
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
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
void	setSalesOrder(SalesOrder value) Overwrites the associated SalesOrder entity for the loaded navigation property to_SalesOrder.
void	setSalesOrder(String salesOrder) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setSalesOrderItem(SalesOrderItem value) Overwrites the associated SalesOrderItem entity for the loaded navigation property to_SalesOrderItem.
void	setSalesOrderItem(String salesOrderItem) (Key Field) Constraints: Not nullable, Maximum length: 6
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.s4hana.datamodel.odata.helper.VdmEntity

getEndpointUrl, getServicePathForFetch, getVersionIdentifier, 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 SalesOrderItemTextSelectable ALL_FIELDS

Selector for all available fields of SalesOrderItemText.

SALES_ORDER

public static final SalesOrderItemTextField<String> SALES_ORDER

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

SALES_ORDER_ITEM

public static final SalesOrderItemTextField<String> SALES_ORDER_ITEM

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

LANGUAGE

public static final SalesOrderItemTextField<String> LANGUAGE

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

LONG_TEXT_ID

public static final SalesOrderItemTextField<String> LONG_TEXT_ID

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

LONG_TEXT

public static final SalesOrderItemTextField<String> LONG_TEXT

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

TO_SALES_ORDER

public static final SalesOrderItemTextOneToOneLink<SalesOrder> TO_SALES_ORDER

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

TO_SALES_ORDER_ITEM

public static final SalesOrderItemTextOneToOneLink<SalesOrderItem> TO_SALES_ORDER_ITEM

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

Constructor Detail

SalesOrderItemText

public SalesOrderItemText()

SalesOrderItemText

public SalesOrderItemText(@Nullable
                          String salesOrder,
                          @Nullable
                          String salesOrderItem,
                          @Nullable
                          String language,
                          @Nullable
                          String longTextID,
                          @Nullable
                          String longText,
                          @Nullable
                          SalesOrder toSalesOrder,
                          @Nullable
                          SalesOrderItem toSalesOrderItem)

Method Detail

getType

@Nonnull
public Class<SalesOrderItemText> getType()

Specified by:

getType in class VdmObject<SalesOrderItemText>

Returns:

The class of this object.

setSalesOrder

public void setSalesOrder(@Nullable
                          String salesOrder)

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

Original property name from the Odata EDM: SalesOrder

Parameters:

salesOrder - Sales Order

setSalesOrderItem

public void setSalesOrderItem(@Nullable
                              String salesOrderItem)

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

Original property name from the Odata EDM: SalesOrderItem

Parameters:

salesOrderItem - Sales Order Item

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

Specified by:

getEntityCollection in class VdmEntity<SalesOrderItemText>

getKey

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

Overrides:

getKey in class VdmObject<SalesOrderItemText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<SalesOrderItemText>

fromMap

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

Overrides:

fromMap in class VdmObject<SalesOrderItemText>

field

@Nonnull
public static <T> SalesOrderItemTextField<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> SalesOrderItemTextField<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.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Description copied from class: VdmEntity

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

Overrides:

getErpConfigContext in class VdmEntity<SalesOrderItemText>

Returns:

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

setErpConfigContext

@Deprecated
public void setErpConfigContext(@Nullable
                                            ErpConfigContext erpConfigContext)

Deprecated. Use attachToService(String, ErpConfigContext) instead.

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Overrides:

setErpConfigContext in class VdmEntity<SalesOrderItemText>

Parameters:

erpConfigContext - New ERP configuration context to apply to this entity

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

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nullable
                            ErpConfigContext configContext)

Description copied from class: VdmEntity

Sets the service path and ERP configuration context for the fetch commands of this entity. Ensures that both are set to some value by using defaults if null values are provided in the arguments. Existing values are preserved if null values are provided in the arguments. 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<SalesOrderItemText>

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.

configContext - Optional parameter. New ERP configuration context to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the ERP configuration context has never been set, then the ERP configuration context will be set to a new instance of ErpConfigContext.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<SalesOrderItemText>

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<SalesOrderItemText>

fetchSalesOrder

@Nullable
public SalesOrder fetchSalesOrder()
                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getSalesOrderOrFetch

@Nullable
public SalesOrder getSalesOrderOrFetch()
                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated SalesOrder entity (one to one). This corresponds to the OData navigation property to_SalesOrder.

If the navigation property to_SalesOrder of a queried SalesOrderItemText 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 SalesOrder 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.

getSalesOrderIfPresent

@Nonnull
public Optional<SalesOrder> getSalesOrderIfPresent()

Retrieval of associated SalesOrder entity (one to one). This corresponds to the OData navigation property to_SalesOrder.

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

setSalesOrder

public void setSalesOrder(SalesOrder value)

Overwrites the associated SalesOrder entity for the loaded navigation property to_SalesOrder.

Parameters:

value - New SalesOrder entity.

fetchSalesOrderItem

@Nullable
public SalesOrderItem fetchSalesOrderItem()
                                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getSalesOrderItemOrFetch

@Nullable
public SalesOrderItem getSalesOrderItemOrFetch()
                                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated SalesOrderItem entity (one to one). This corresponds to the OData navigation property to_SalesOrderItem.

If the navigation property to_SalesOrderItem of a queried SalesOrderItemText 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 SalesOrderItem 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.

getSalesOrderItemIfPresent

@Nonnull
public Optional<SalesOrderItem> getSalesOrderItemIfPresent()

Retrieval of associated SalesOrderItem entity (one to one). This corresponds to the OData navigation property to_SalesOrderItem.

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

setSalesOrderItem

public void setSalesOrderItem(SalesOrderItem value)

Overwrites the associated SalesOrderItem entity for the loaded navigation property to_SalesOrderItem.

Parameters:

value - New SalesOrderItem entity.

builder

public static SalesOrderItemText.SalesOrderItemTextBuilder builder()

getSalesOrder

@Nullable
public String getSalesOrder()

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

Original property name from the Odata EDM: SalesOrder

Returns:

Sales Order

getSalesOrderItem

@Nullable
public String getSalesOrderItem()

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

Original property name from the Odata EDM: SalesOrderItem

Returns:

Sales Order Item

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

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<SalesOrderItemText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<SalesOrderItemText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SalesOrderItemText>