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

Class SubItemCategory

java.lang.Object

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

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

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

public class SubItemCategory
extends VdmEntity<SubItemCategory>

Consolidation Subitem Category

Original entity name from the Odata EDM: SubItemCategoryType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static SubItemCategorySelectable	ALL_FIELDS Selector for all available fields of SubItemCategory.
static SubItemCategoryField<Boolean>	IS_SUB_ITEMS_FOR_ACQUISITIONS_DIVES Use with available fluent helpers to apply the IsSubItemsForAcquisitionsDives field to query operations.
static SubItemCategoryField<String>	SUB_ITEM_CATEGORY Use with available fluent helpers to apply the SubItemCategory field to query operations.
static SubItemCategoryField<String>	SUB_ITEM_CATEGORY_TEXT Use with available fluent helpers to apply the SubItemCategory_Text field to query operations.
static SubItemCategoryLink<SubItemCategoryText>	TO_CNSLDTN_SUBITEM_CATEGORY_T Use with available fluent helpers to apply the to_CnsldtnSubitemCategoryT 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
SubItemCategory()
SubItemCategory(String subItemCategory, String subItemCategory_Text, Boolean isSubItemsForAcquisitionsDives, List<SubItemCategoryText> toCnsldtnSubitemCategoryT)

Method Summary

Modifier and Type	Method and Description
void	addCnsldtnSubitemCategoryT(SubItemCategoryText... entity) Adds elements to the list of associated SubItemCategoryText entities.
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static SubItemCategory.SubItemCategoryBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<SubItemCategoryText>	fetchCnsldtnSubitemCategoryT() Fetches the SubItemCategoryText entities (one to many) associated with this entity.
static <T> SubItemCategoryField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SubItemCategoryField<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)
Optional<List<SubItemCategoryText>>	getCnsldtnSubitemCategoryTIfPresent() Retrieval of associated SubItemCategoryText entities (one to many).
List<SubItemCategoryText>	getCnsldtnSubitemCategoryTOrFetch() Retrieval of associated SubItemCategoryText entities (one to many).
protected String	getDefaultServicePath()
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
Boolean	getIsSubItemsForAcquisitionsDives() Constraints: none
protected Map<String,Object>	getKey()
String	getSubItemCategory_Text() Constraints: Not nullable, Maximum length: 30
String	getSubItemCategory() (Key Field) Constraints: Not nullable, Maximum length: 3
Class<SubItemCategory>	getType()
int	hashCode()
void	setCnsldtnSubitemCategoryT(List<SubItemCategoryText> value) Overwrites the list of associated SubItemCategoryText entities for the loaded navigation property to_CnsldtnSubitemCategoryT.
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
void	setIsSubItemsForAcquisitionsDives(Boolean isSubItemsForAcquisitionsDives) Constraints: none
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) (Key Field) 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.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 SubItemCategorySelectable ALL_FIELDS

Selector for all available fields of SubItemCategory.

SUB_ITEM_CATEGORY

public static final SubItemCategoryField<String> SUB_ITEM_CATEGORY

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

SUB_ITEM_CATEGORY_TEXT

public static final SubItemCategoryField<String> SUB_ITEM_CATEGORY_TEXT

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

IS_SUB_ITEMS_FOR_ACQUISITIONS_DIVES

public static final SubItemCategoryField<Boolean> IS_SUB_ITEMS_FOR_ACQUISITIONS_DIVES

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

TO_CNSLDTN_SUBITEM_CATEGORY_T

public static final SubItemCategoryLink<SubItemCategoryText> TO_CNSLDTN_SUBITEM_CATEGORY_T

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

Constructor Detail

SubItemCategory

public SubItemCategory()

SubItemCategory

public SubItemCategory(@Nullable
                       String subItemCategory,
                       @Nullable
                       String subItemCategory_Text,
                       @Nullable
                       Boolean isSubItemsForAcquisitionsDives,
                       List<SubItemCategoryText> toCnsldtnSubitemCategoryT)

Method Detail

getType

@Nonnull
public Class<SubItemCategory> getType()

Specified by:

getType in class VdmObject<SubItemCategory>

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 - Enter a description of up to 30 characters in length.

setIsSubItemsForAcquisitionsDives

public void setIsSubItemsForAcquisitionsDives(@Nullable
                                              Boolean isSubItemsForAcquisitionsDives)

Constraints: none

Original property name from the Odata EDM: IsSubItemsForAcquisitionsDives

Parameters:

isSubItemsForAcquisitionsDives - This is an indicator for controlling the screen sequence for subitems. If you set this indicator, you can enter a retirement subitem (transaction type) for the subitems.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<SubItemCategory>

getKey

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

Overrides:

getKey in class VdmObject<SubItemCategory>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<SubItemCategory>

fromMap

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

Overrides:

fromMap in class VdmObject<SubItemCategory>

field

@Nonnull
public static <T> SubItemCategoryField<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> SubItemCategoryField<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<SubItemCategory>

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

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

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

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

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<SubItemCategory>

fetchCnsldtnSubitemCategoryT

@Nonnull
public List<SubItemCategoryText> fetchCnsldtnSubitemCategoryT()
                                                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the SubItemCategoryText entities (one to many) associated with this entity. This corresponds to the OData navigation property to_CnsldtnSubitemCategoryT.

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

Returns:

List containing one or more associated SubItemCategoryText entities. If no entities are associated then an empty list is returned.

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.

getCnsldtnSubitemCategoryTOrFetch

@Nonnull
public List<SubItemCategoryText> getCnsldtnSubitemCategoryTOrFetch()
                                                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated SubItemCategoryText entities (one to many). This corresponds to the OData navigation property to_CnsldtnSubitemCategoryT.

If the navigation property to_CnsldtnSubitemCategoryT of a queried SubItemCategory 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 SubItemCategoryText entities.

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.

getCnsldtnSubitemCategoryTIfPresent

@Nonnull
public Optional<List<SubItemCategoryText>> getCnsldtnSubitemCategoryTIfPresent()

Retrieval of associated SubItemCategoryText entities (one to many). This corresponds to the OData navigation property to_CnsldtnSubitemCategoryT.

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

setCnsldtnSubitemCategoryT

public void setCnsldtnSubitemCategoryT(@Nonnull
                                       List<SubItemCategoryText> value)

Overwrites the list of associated SubItemCategoryText entities for the loaded navigation property to_CnsldtnSubitemCategoryT.

If the navigation property to_CnsldtnSubitemCategoryT of a queried SubItemCategory 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.

Parameters:

value - List of SubItemCategoryText entities.

addCnsldtnSubitemCategoryT

public void addCnsldtnSubitemCategoryT(SubItemCategoryText... entity)

Adds elements to the list of associated SubItemCategoryText entities. This corresponds to the OData navigation property to_CnsldtnSubitemCategoryT.

If the navigation property to_CnsldtnSubitemCategoryT of a queried SubItemCategory 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.

Parameters:

entity - Array of SubItemCategoryText entities.

builder

public static SubItemCategory.SubItemCategoryBuilder 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:

Enter a description of up to 30 characters in length.

getIsSubItemsForAcquisitionsDives

@Nullable
public Boolean getIsSubItemsForAcquisitionsDives()

Constraints: none

Original property name from the Odata EDM: IsSubItemsForAcquisitionsDives

Returns:

This is an indicator for controlling the screen sequence for subitems. If you set this indicator, you can enter a retirement subitem (transaction type) for the subitems.

toString

public String toString()

Overrides:

toString in class VdmObject<SubItemCategory>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<SubItemCategory>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<SubItemCategory>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SubItemCategory>