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

Class SubItemText

java.lang.Object

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

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

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

public class SubItemText
extends VdmEntity<SubItemText>

Consolidation Subitem Text

Original entity name from the Odata EDM: SubItemTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static SubItemTextSelectable	ALL_FIELDS Selector for all available fields of SubItemText.
static SubItemTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static SubItemTextField<String>	SUB_ITEM Use with available fluent helpers to apply the SubItem field to query operations.
static SubItemTextField<String>	SUB_ITEM_CATEGORY Use with available fluent helpers to apply the SubItemCategory field to query operations.
static SubItemTextField<String>	SUB_ITEM_CATEGORY_TEXT Use with available fluent helpers to apply the SubItemCategory_Text field to query operations.
static SubItemTextField<String>	SUB_ITEM_TEXT Use with available fluent helpers to apply the SubItemText field to query operations.
static SubItemTextOneToOneLink<SubItem>	TO_CNSLDTN_SUB_ITEM Use with available fluent helpers to apply the to_CnsldtnSubItem navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
SubItemText()
SubItemText(String subItemCategory, String subItemCategory_Text, String language, String subItem, String subItemText, SubItem toCnsldtnSubItem)

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 SubItemText.SubItemTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
SubItem	fetchCnsldtnSubItem() Fetches the SubItem entity (one to one) associated with this entity.
static <T> SubItemTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SubItemTextField<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<SubItem>	getCnsldtnSubItemIfPresent() Retrieval of associated SubItem entity (one to one).
SubItem	getCnsldtnSubItemOrFetch() Retrieval of associated SubItem entity (one to one).
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	getSubItem() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getSubItemCategory_Text() Constraints: Not nullable, Maximum length: 30
String	getSubItemCategory() (Key Field) Constraints: Not nullable, Maximum length: 3
String	getSubItemText() Constraints: Not nullable, Maximum length: 30
Class<SubItemText>	getType()
int	hashCode()
void	setCnsldtnSubItem(SubItem value) Overwrites the associated SubItem entity for the loaded navigation property to_CnsldtnSubItem.
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.
void	setSubItem(String subItem) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setSubItemCategory_Text(String subItemCategory_Text) Constraints: Not nullable, Maximum length: 30
void	setSubItemCategory(String subItemCategory) (Key Field) Constraints: Not nullable, Maximum length: 3
void	setSubItemText(String subItemText) Constraints: Not nullable, Maximum length: 30
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 SubItemTextSelectable ALL_FIELDS

Selector for all available fields of SubItemText.

SUB_ITEM_CATEGORY

public static final SubItemTextField<String> SUB_ITEM_CATEGORY

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

SUB_ITEM_CATEGORY_TEXT

public static final SubItemTextField<String> SUB_ITEM_CATEGORY_TEXT

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

LANGUAGE

public static final SubItemTextField<String> LANGUAGE

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

SUB_ITEM

public static final SubItemTextField<String> SUB_ITEM

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

SUB_ITEM_TEXT

public static final SubItemTextField<String> SUB_ITEM_TEXT

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

TO_CNSLDTN_SUB_ITEM

public static final SubItemTextOneToOneLink<SubItem> TO_CNSLDTN_SUB_ITEM

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

Constructor Detail

SubItemText

public SubItemText()

SubItemText

public SubItemText(@Nullable
                   String subItemCategory,
                   @Nullable
                   String subItemCategory_Text,
                   @Nullable
                   String language,
                   @Nullable
                   String subItem,
                   @Nullable
                   String subItemText,
                   @Nullable
                   SubItem toCnsldtnSubItem)

Method Detail

getType

@Nonnull
public Class<SubItemText> getType()

Specified by:

getType in class VdmObject<SubItemText>

Returns:

The class of this object.

setSubItemCategory

public void setSubItemCategory(@Nullable
                               String subItemCategory)

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

Original property name from the Odata EDM: SubItemCategory

Parameters:

subItemCategory - Enter or display the subitem category.

setSubItemCategory_Text

public void setSubItemCategory_Text(@Nullable
                                    String subItemCategory_Text)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SubItemCategory_Text

Parameters:

subItemCategory_Text - Subitem Category Description

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

setSubItem

public void setSubItem(@Nullable
                       String subItem)

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

Original property name from the Odata EDM: SubItem

Parameters:

subItem - Enter a Subitem

setSubItemText

public void setSubItemText(@Nullable
                           String subItemText)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SubItemText

Parameters:

subItemText - Subitem 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<SubItemText>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<SubItemText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<SubItemText>

fromMap

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

Overrides:

fromMap in class VdmObject<SubItemText>

field

@Nonnull
public static <T> SubItemTextField<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> SubItemTextField<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<SubItemText>

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

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

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

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

fetchCnsldtnSubItem

@Nullable
public SubItem fetchCnsldtnSubItem()
                                      throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getCnsldtnSubItemOrFetch

@Nullable
public SubItem getCnsldtnSubItemOrFetch()
                                           throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated SubItem entity (one to one). This corresponds to the OData navigation property to_CnsldtnSubItem.

If the navigation property to_CnsldtnSubItem of a queried SubItemText 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 SubItem 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.

getCnsldtnSubItemIfPresent

@Nonnull
public io.vavr.control.Option<SubItem> getCnsldtnSubItemIfPresent()

Retrieval of associated SubItem entity (one to one). This corresponds to the OData navigation property to_CnsldtnSubItem.

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

setCnsldtnSubItem

public void setCnsldtnSubItem(SubItem value)

Overwrites the associated SubItem entity for the loaded navigation property to_CnsldtnSubItem.

Parameters:

value - New SubItem entity.

builder

public static SubItemText.SubItemTextBuilder builder()

getSubItemCategory

@Nullable
public String getSubItemCategory()

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

Original property name from the Odata EDM: SubItemCategory

Returns:

Enter or display the subitem category.

getSubItemCategory_Text

@Nullable
public String getSubItemCategory_Text()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SubItemCategory_Text

Returns:

Subitem Category Description

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

getSubItem

@Nullable
public String getSubItem()

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

Original property name from the Odata EDM: SubItem

Returns:

Enter a Subitem

getSubItemText

@Nullable
public String getSubItemText()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SubItemText

Returns:

Subitem Description

toString

public String toString()

Overrides:

toString in class VdmObject<SubItemText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<SubItemText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<SubItemText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SubItemText>