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

Class OrderIDText

java.lang.Object

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

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

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

public class OrderIDText
extends VdmEntity<OrderIDText>

Consolidation - Combined Internal Order Text

Original entity name from the Odata EDM: OrderIDTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static OrderIDTextSelectable	ALL_FIELDS Selector for all available fields of OrderIDText.
static OrderIDTextField<String>	CNSLDTN_ORDER_ID_TEXT Use with available fluent helpers to apply the CnsldtnOrderIDText field to query operations.
static OrderIDTextField<String>	INTERNAL_ORDER Use with available fluent helpers to apply the InternalOrder field to query operations.
static OrderIDTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static OrderIDTextOneToOneLink<OrderID>	TO_CNSLDTN_INTERNAL_ORDER Use with available fluent helpers to apply the to_CnsldtnInternalOrder navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
OrderIDText()
OrderIDText(String language, String internalOrder, String cnsldtnOrderIDText, OrderID toCnsldtnInternalOrder)

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 OrderIDText.OrderIDTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
OrderID	fetchCnsldtnInternalOrder() Fetches the OrderID entity (one to one) associated with this entity.
static <T> OrderIDTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> OrderIDTextField<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<OrderID>	getCnsldtnInternalOrderIfPresent() Retrieval of associated OrderID entity (one to one).
OrderID	getCnsldtnInternalOrderOrFetch() Retrieval of associated OrderID entity (one to one).
String	getCnsldtnOrderIDText() Constraints: Not nullable, Maximum length: 40
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.
String	getInternalOrder() (Key Field) Constraints: Not nullable, Maximum length: 12
protected Map<String,Object>	getKey()
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
Class<OrderIDText>	getType()
int	hashCode()
void	setCnsldtnInternalOrder(OrderID value) Overwrites the associated OrderID entity for the loaded navigation property to_CnsldtnInternalOrder.
void	setCnsldtnOrderIDText(String cnsldtnOrderIDText) Constraints: Not nullable, Maximum length: 40
void	setInternalOrder(String internalOrder) (Key Field) Constraints: Not nullable, Maximum length: 12
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 OrderIDTextSelectable ALL_FIELDS

Selector for all available fields of OrderIDText.

LANGUAGE

public static final OrderIDTextField<String> LANGUAGE

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

INTERNAL_ORDER

public static final OrderIDTextField<String> INTERNAL_ORDER

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

CNSLDTN_ORDER_ID_TEXT

public static final OrderIDTextField<String> CNSLDTN_ORDER_ID_TEXT

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

TO_CNSLDTN_INTERNAL_ORDER

public static final OrderIDTextOneToOneLink<OrderID> TO_CNSLDTN_INTERNAL_ORDER

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

Constructor Detail

OrderIDText

public OrderIDText()

OrderIDText

public OrderIDText(@Nullable
                   String language,
                   @Nullable
                   String internalOrder,
                   @Nullable
                   String cnsldtnOrderIDText,
                   @Nullable
                   OrderID toCnsldtnInternalOrder)

Method Detail

getType

@Nonnull
public Class<OrderIDText> getType()

Specified by:

getType in class VdmObject<OrderIDText>

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.

setInternalOrder

public void setInternalOrder(@Nullable
                             String internalOrder)

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

Original property name from the Odata EDM: InternalOrder

Parameters:

internalOrder - Key that uniquely identifies an order within a client.

setCnsldtnOrderIDText

public void setCnsldtnOrderIDText(@Nullable
                                  String cnsldtnOrderIDText)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: CnsldtnOrderIDText

Parameters:

cnsldtnOrderIDText - Order ID 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<OrderIDText>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<OrderIDText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<OrderIDText>

fromMap

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

Overrides:

fromMap in class VdmObject<OrderIDText>

field

@Nonnull
public static <T> OrderIDTextField<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> OrderIDTextField<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<OrderIDText>

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

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

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

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

fetchCnsldtnInternalOrder

@Nullable
public OrderID fetchCnsldtnInternalOrder()
                                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getCnsldtnInternalOrderOrFetch

@Nullable
public OrderID getCnsldtnInternalOrderOrFetch()
                                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated OrderID entity (one to one). This corresponds to the OData navigation property to_CnsldtnInternalOrder.

If the navigation property to_CnsldtnInternalOrder of a queried OrderIDText 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 OrderID 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.

getCnsldtnInternalOrderIfPresent

@Nonnull
public io.vavr.control.Option<OrderID> getCnsldtnInternalOrderIfPresent()

Retrieval of associated OrderID entity (one to one). This corresponds to the OData navigation property to_CnsldtnInternalOrder.

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

setCnsldtnInternalOrder

public void setCnsldtnInternalOrder(OrderID value)

Overwrites the associated OrderID entity for the loaded navigation property to_CnsldtnInternalOrder.

Parameters:

value - New OrderID entity.

builder

public static OrderIDText.OrderIDTextBuilder 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.

getInternalOrder

@Nullable
public String getInternalOrder()

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

Original property name from the Odata EDM: InternalOrder

Returns:

Key that uniquely identifies an order within a client.

getCnsldtnOrderIDText

@Nullable
public String getCnsldtnOrderIDText()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: CnsldtnOrderIDText

Returns:

Order ID Description

toString

public String toString()

Overrides:

toString in class VdmObject<OrderIDText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<OrderIDText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<OrderIDText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<OrderIDText>