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

Class SubitemHierText

java.lang.Object

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

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

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

public class SubitemHierText
extends VdmEntity<SubitemHierText>

Consolidation - Subitem Hierarchy Text

Original entity name from the Odata EDM: SubitemHierTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static SubitemHierTextSelectable	ALL_FIELDS Selector for all available fields of SubitemHierText.
static SubitemHierTextField<String>	CONSOLIDATION_SUBITEM_HIERARCHY Use with available fluent helpers to apply the ConsolidationSubitemHierarchy field to query operations.
static SubitemHierTextField<String>	HIERARCHY_NODE Use with available fluent helpers to apply the HierarchyNode field to query operations.
static SubitemHierTextField<String>	HIERARCHY_NODE_TEXT Use with available fluent helpers to apply the HierarchyNodeText field to query operations.
static SubitemHierTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static SubitemHierTextField<String>	NODE_TYPE Use with available fluent helpers to apply the NodeType field to query operations.
static SubitemHierTextField<String>	SUB_ITEM_CATEGORY Use with available fluent helpers to apply the SubItemCategory field to query operations.
static SubitemHierTextField<String>	SUB_ITEM_CATEGORY_TEXT Use with available fluent helpers to apply the SubItemCategory_Text field to query operations.
static SubitemHierTextOneToOneLink<SubitemHier>	TO_CNSLDTN_SUBITEM_HIER Use with available fluent helpers to apply the to_CnsldtnSubitemHier navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
SubitemHierText()
SubitemHierText(String language, String consolidationSubitemHierarchy, String hierarchyNode, String subItemCategory, String subItemCategory_Text, String hierarchyNodeText, String nodeType, SubitemHier toCnsldtnSubitemHier)

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 SubitemHierText.SubitemHierTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
SubitemHier	fetchCnsldtnSubitemHier() Fetches the SubitemHier entity (one to one) associated with this entity.
static <T> SubitemHierTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SubitemHierTextField<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<SubitemHier>	getCnsldtnSubitemHierIfPresent() Retrieval of associated SubitemHier entity (one to one).
SubitemHier	getCnsldtnSubitemHierOrFetch() Retrieval of associated SubitemHier entity (one to one).
String	getConsolidationSubitemHierarchy() (Key Field) Constraints: Not nullable, Maximum length: 42
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	getHierarchyNode() (Key Field) Constraints: Not nullable, Maximum length: 50
String	getHierarchyNodeText() Constraints: Not nullable, Maximum length: 50
protected Map<String,Object>	getKey()
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getNodeType() Constraints: Not nullable, Maximum length: 1
String	getSubItemCategory_Text() Constraints: Not nullable, Maximum length: 30
String	getSubItemCategory() Constraints: Not nullable, Maximum length: 3
Class<SubitemHierText>	getType()
int	hashCode()
void	setCnsldtnSubitemHier(SubitemHier value) Overwrites the associated SubitemHier entity for the loaded navigation property to_CnsldtnSubitemHier.
void	setConsolidationSubitemHierarchy(String consolidationSubitemHierarchy) (Key Field) Constraints: Not nullable, Maximum length: 42
void	setHierarchyNode(String hierarchyNode) (Key Field) Constraints: Not nullable, Maximum length: 50
void	setHierarchyNodeText(String hierarchyNodeText) Constraints: Not nullable, Maximum length: 50
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setNodeType(String nodeType) Constraints: Not nullable, Maximum length: 1
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setSubItemCategory_Text(String subItemCategory_Text) Constraints: Not nullable, Maximum length: 30
void	setSubItemCategory(String subItemCategory) Constraints: Not nullable, Maximum length: 3
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 SubitemHierTextSelectable ALL_FIELDS

Selector for all available fields of SubitemHierText.

LANGUAGE

public static final SubitemHierTextField<String> LANGUAGE

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

CONSOLIDATION_SUBITEM_HIERARCHY

public static final SubitemHierTextField<String> CONSOLIDATION_SUBITEM_HIERARCHY

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

HIERARCHY_NODE

public static final SubitemHierTextField<String> HIERARCHY_NODE

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

SUB_ITEM_CATEGORY

public static final SubitemHierTextField<String> SUB_ITEM_CATEGORY

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

SUB_ITEM_CATEGORY_TEXT

public static final SubitemHierTextField<String> SUB_ITEM_CATEGORY_TEXT

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

HIERARCHY_NODE_TEXT

public static final SubitemHierTextField<String> HIERARCHY_NODE_TEXT

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

NODE_TYPE

public static final SubitemHierTextField<String> NODE_TYPE

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

TO_CNSLDTN_SUBITEM_HIER

public static final SubitemHierTextOneToOneLink<SubitemHier> TO_CNSLDTN_SUBITEM_HIER

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

Constructor Detail

SubitemHierText

public SubitemHierText()

SubitemHierText

public SubitemHierText(@Nullable
                       String language,
                       @Nullable
                       String consolidationSubitemHierarchy,
                       @Nullable
                       String hierarchyNode,
                       @Nullable
                       String subItemCategory,
                       @Nullable
                       String subItemCategory_Text,
                       @Nullable
                       String hierarchyNodeText,
                       @Nullable
                       String nodeType,
                       @Nullable
                       SubitemHier toCnsldtnSubitemHier)

Method Detail

getType

@Nonnull
public Class<SubitemHierText> getType()

Specified by:

getType in class VdmObject<SubitemHierText>

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

- 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

setConsolidationSubitemHierarchy

public void setConsolidationSubitemHierarchy(@Nullable
                                             String consolidationSubitemHierarchy)

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

Original property name from the Odata EDM: ConsolidationSubitemHierarchy

There are two types of hierarchy:Set-based hierarchies have the format // and generally have a numerical type.Financial statement hierarchies are based on the financial statement version and have the type FSVN.For information about how to define set-based hierarchies as relevant for replication, see Set Report Relevancy for Set-Based Hierarchies.

Parameters:

consolidationSubitemHierarchy - Specifies the structure that organizes entities, concepts, objects, activities, and units into an order of precedence.

setHierarchyNode

public void setHierarchyNode(@Nullable
                             String hierarchyNode)

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

Original property name from the Odata EDM: HierarchyNode

Parameters:

hierarchyNode - Hierarchy node

setSubItemCategory

public void setSubItemCategory(@Nullable
                               String subItemCategory)

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

setHierarchyNodeText

public void setHierarchyNodeText(@Nullable
                                 String hierarchyNodeText)

Constraints: Not nullable, Maximum length: 50

Original property name from the Odata EDM: HierarchyNodeText

Parameters:

hierarchyNodeText - Hierarchy node description

setNodeType

public void setNodeType(@Nullable
                        String nodeType)

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: NodeType

Parameters:

nodeType - Hierarchy node type

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<SubitemHierText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<SubitemHierText>

fromMap

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

Overrides:

fromMap in class VdmObject<SubitemHierText>

field

@Nonnull
public static <T> SubitemHierTextField<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> SubitemHierTextField<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<SubitemHierText>

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

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

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

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

fetchCnsldtnSubitemHier

@Nullable
public SubitemHier fetchCnsldtnSubitemHier()
                                              throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getCnsldtnSubitemHierOrFetch

@Nullable
public SubitemHier getCnsldtnSubitemHierOrFetch()
                                                   throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated SubitemHier entity (one to one). This corresponds to the OData navigation property to_CnsldtnSubitemHier.

If the navigation property to_CnsldtnSubitemHier of a queried SubitemHierText 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 SubitemHier 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.

getCnsldtnSubitemHierIfPresent

@Nonnull
public io.vavr.control.Option<SubitemHier> getCnsldtnSubitemHierIfPresent()

Retrieval of associated SubitemHier entity (one to one). This corresponds to the OData navigation property to_CnsldtnSubitemHier.

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

setCnsldtnSubitemHier

public void setCnsldtnSubitemHier(SubitemHier value)

Overwrites the associated SubitemHier entity for the loaded navigation property to_CnsldtnSubitemHier.

Parameters:

value - New SubitemHier entity.

builder

public static SubitemHierText.SubitemHierTextBuilder builder()

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

getConsolidationSubitemHierarchy

@Nullable
public String getConsolidationSubitemHierarchy()

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

Original property name from the Odata EDM: ConsolidationSubitemHierarchy

There are two types of hierarchy:Set-based hierarchies have the format // and generally have a numerical type.Financial statement hierarchies are based on the financial statement version and have the type FSVN.For information about how to define set-based hierarchies as relevant for replication, see Set Report Relevancy for Set-Based Hierarchies.

Returns:

Specifies the structure that organizes entities, concepts, objects, activities, and units into an order of precedence.

getHierarchyNode

@Nullable
public String getHierarchyNode()

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

Original property name from the Odata EDM: HierarchyNode

Returns:

Hierarchy node

getSubItemCategory

@Nullable
public String getSubItemCategory()

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

getHierarchyNodeText

@Nullable
public String getHierarchyNodeText()

Constraints: Not nullable, Maximum length: 50

Original property name from the Odata EDM: HierarchyNodeText

Returns:

Hierarchy node description

getNodeType

@Nullable
public String getNodeType()

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: NodeType

Returns:

Hierarchy node type

toString

public String toString()

Overrides:

toString in class VdmObject<SubitemHierText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<SubitemHierText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<SubitemHierText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SubitemHierText>