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

Class SubItem

java.lang.Object

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

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

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

public class SubItem
extends VdmEntity<SubItem>

Consolidation Subitem

Original entity name from the Odata EDM: SubItemType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static SubItemSelectable	ALL_FIELDS Selector for all available fields of SubItem.
static SubItemField<String>	SUB_ITEM Use with available fluent helpers to apply the SubItem field to query operations.
static SubItemField<String>	SUB_ITEM_CATEGORY Use with available fluent helpers to apply the SubItemCategory field to query operations.
static SubItemField<String>	SUB_ITEM_TEXT Use with available fluent helpers to apply the SubItem_Text field to query operations.
static SubItemField<String>	SUBITEM_ACQUISITION_DESTINATION Use with available fluent helpers to apply the SubitemAcquisitionDestination field to query operations.
static SubItemField<String>	SUBITEM_ACQUISITION_DESTINATION_TEXT Use with available fluent helpers to apply the SubitemAcquisitionDestination_Text field to query operations.
static SubItemField<String>	SUBITEM_CARRY_FORWARD_DESTINATION Use with available fluent helpers to apply the SubitemCarryForwardDestination field to query operations.
static SubItemField<String>	SUBITEM_CARRY_FORWARD_DESTINATION_TEXT Use with available fluent helpers to apply the SubitemCarryForwardDestination_Text field to query operations.
static SubItemField<String>	SUBITEM_RTRMT_DIVESTITURE_DEST Use with available fluent helpers to apply the SubitemRtrmtDivestitureDest field to query operations.
static SubItemField<String>	SUBITEM_RTRMT_DIVESTITURE_DEST_TEXT Use with available fluent helpers to apply the SubitemRtrmtDivestitureDest_Text field to query operations.
static SubItemLink<SubItemText>	TO_CNSLDTN_SUB_ITEM_T Use with available fluent helpers to apply the to_CnsldtnSubItemT 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
SubItem()
SubItem(String subItemCategory, String subItem, String subItem_Text, String subitemCarryForwardDestination, String subitemCarryForwardDestination_Text, String subitemRtrmtDivestitureDest, String subitemRtrmtDivestitureDest_Text, String subitemAcquisitionDestination, String subitemAcquisitionDestination_Text, List<SubItemText> toCnsldtnSubItemT)

Method Summary

Modifier and Type	Method and Description
void	addCnsldtnSubItemT(SubItemText... entity) Adds elements to the list of associated SubItemText entities.
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static SubItem.SubItemBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<SubItemText>	fetchCnsldtnSubItemT() Fetches the SubItemText entities (one to many) associated with this entity.
static <T> SubItemField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SubItemField<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<SubItemText>>	getCnsldtnSubItemTIfPresent() Retrieval of associated SubItemText entities (one to many).
List<SubItemText>	getCnsldtnSubItemTOrFetch() Retrieval of associated SubItemText 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.
protected Map<String,Object>	getKey()
String	getSubItem_Text() Constraints: Not nullable, Maximum length: 30
String	getSubItem() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getSubitemAcquisitionDestination_Text() Constraints: Not nullable, Maximum length: 30
String	getSubitemAcquisitionDestination() Constraints: Not nullable, Maximum length: 10
String	getSubitemCarryForwardDestination_Text() Constraints: Not nullable, Maximum length: 30
String	getSubitemCarryForwardDestination() Constraints: Not nullable, Maximum length: 10
String	getSubItemCategory() (Key Field) Constraints: Not nullable, Maximum length: 3
String	getSubitemRtrmtDivestitureDest_Text() Constraints: Not nullable, Maximum length: 30
String	getSubitemRtrmtDivestitureDest() Constraints: Not nullable, Maximum length: 10
Class<SubItem>	getType()
int	hashCode()
void	setCnsldtnSubItemT(List<SubItemText> value) Overwrites the list of associated SubItemText entities for the loaded navigation property to_CnsldtnSubItemT.
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setSubItem_Text(String subItem_Text) Constraints: Not nullable, Maximum length: 30
void	setSubItem(String subItem) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setSubitemAcquisitionDestination_Text(String subitemAcquisitionDestination_Text) Constraints: Not nullable, Maximum length: 30
void	setSubitemAcquisitionDestination(String subitemAcquisitionDestination) Constraints: Not nullable, Maximum length: 10
void	setSubitemCarryForwardDestination_Text(String subitemCarryForwardDestination_Text) Constraints: Not nullable, Maximum length: 30
void	setSubitemCarryForwardDestination(String subitemCarryForwardDestination) Constraints: Not nullable, Maximum length: 10
void	setSubItemCategory(String subItemCategory) (Key Field) Constraints: Not nullable, Maximum length: 3
void	setSubitemRtrmtDivestitureDest_Text(String subitemRtrmtDivestitureDest_Text) Constraints: Not nullable, Maximum length: 30
void	setSubitemRtrmtDivestitureDest(String subitemRtrmtDivestitureDest) Constraints: Not nullable, Maximum length: 10
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 SubItemSelectable ALL_FIELDS

Selector for all available fields of SubItem.

SUB_ITEM_CATEGORY

public static final SubItemField<String> SUB_ITEM_CATEGORY

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

SUB_ITEM

public static final SubItemField<String> SUB_ITEM

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

SUB_ITEM_TEXT

public static final SubItemField<String> SUB_ITEM_TEXT

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

SUBITEM_CARRY_FORWARD_DESTINATION

public static final SubItemField<String> SUBITEM_CARRY_FORWARD_DESTINATION

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

SUBITEM_CARRY_FORWARD_DESTINATION_TEXT

public static final SubItemField<String> SUBITEM_CARRY_FORWARD_DESTINATION_TEXT

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

SUBITEM_RTRMT_DIVESTITURE_DEST

public static final SubItemField<String> SUBITEM_RTRMT_DIVESTITURE_DEST

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

SUBITEM_RTRMT_DIVESTITURE_DEST_TEXT

public static final SubItemField<String> SUBITEM_RTRMT_DIVESTITURE_DEST_TEXT

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

SUBITEM_ACQUISITION_DESTINATION

public static final SubItemField<String> SUBITEM_ACQUISITION_DESTINATION

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

SUBITEM_ACQUISITION_DESTINATION_TEXT

public static final SubItemField<String> SUBITEM_ACQUISITION_DESTINATION_TEXT

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

TO_CNSLDTN_SUB_ITEM_T

public static final SubItemLink<SubItemText> TO_CNSLDTN_SUB_ITEM_T

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

Constructor Detail

SubItem

public SubItem()

SubItem

public SubItem(@Nullable
               String subItemCategory,
               @Nullable
               String subItem,
               @Nullable
               String subItem_Text,
               @Nullable
               String subitemCarryForwardDestination,
               @Nullable
               String subitemCarryForwardDestination_Text,
               @Nullable
               String subitemRtrmtDivestitureDest,
               @Nullable
               String subitemRtrmtDivestitureDest_Text,
               @Nullable
               String subitemAcquisitionDestination,
               @Nullable
               String subitemAcquisitionDestination_Text,
               List<SubItemText> toCnsldtnSubItemT)

Method Detail

getType

@Nonnull
public Class<SubItem> getType()

Specified by:

getType in class VdmObject<SubItem>

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.

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

setSubItem_Text

public void setSubItem_Text(@Nullable
                            String subItem_Text)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SubItem_Text

Parameters:

subItem_Text - A medium text of up to 30 characters for the name.

setSubitemCarryForwardDestination

public void setSubitemCarryForwardDestination(@Nullable
                                              String subitemCarryForwardDestination)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: SubitemCarryForwardDestination

Parameters:

subitemCarryForwardDestination - Enter the subitem to which the value of the current subitem is to be carried forward to during the balance carryforward procedure.

setSubitemCarryForwardDestination_Text

public void setSubitemCarryForwardDestination_Text(@Nullable
                                                   String subitemCarryForwardDestination_Text)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SubitemCarryForwardDestination_Text

Parameters:

subitemCarryForwardDestination_Text - A medium text of up to 30 characters for the name.

setSubitemRtrmtDivestitureDest

public void setSubitemRtrmtDivestitureDest(@Nullable
                                           String subitemRtrmtDivestitureDest)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: SubitemRtrmtDivestitureDest

Parameters:

subitemRtrmtDivestitureDest - The retirement subitem (transaction type) determines which transaction type is posted during an asset retirement.

setSubitemRtrmtDivestitureDest_Text

public void setSubitemRtrmtDivestitureDest_Text(@Nullable
                                                String subitemRtrmtDivestitureDest_Text)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SubitemRtrmtDivestitureDest_Text

Parameters:

subitemRtrmtDivestitureDest_Text - A medium text of up to 30 characters for the name.

setSubitemAcquisitionDestination

public void setSubitemAcquisitionDestination(@Nullable
                                             String subitemAcquisitionDestination)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: SubitemAcquisitionDestination

Parameters:

subitemAcquisitionDestination - Subitem that is assigned for acquisitions.

setSubitemAcquisitionDestination_Text

public void setSubitemAcquisitionDestination_Text(@Nullable
                                                  String subitemAcquisitionDestination_Text)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SubitemAcquisitionDestination_Text

Parameters:

subitemAcquisitionDestination_Text - A medium text of up to 30 characters for the name.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<SubItem>

getKey

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

Overrides:

getKey in class VdmObject<SubItem>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<SubItem>

fromMap

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

Overrides:

fromMap in class VdmObject<SubItem>

field

@Nonnull
public static <T> SubItemField<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> SubItemField<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<SubItem>

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

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

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

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

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<SubItem>

fetchCnsldtnSubItemT

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

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

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

Returns:

List containing one or more associated SubItemText 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.

getCnsldtnSubItemTOrFetch

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

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

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

getCnsldtnSubItemTIfPresent

@Nonnull
public Optional<List<SubItemText>> getCnsldtnSubItemTIfPresent()

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

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

setCnsldtnSubItemT

public void setCnsldtnSubItemT(@Nonnull
                               List<SubItemText> value)

Overwrites the list of associated SubItemText entities for the loaded navigation property to_CnsldtnSubItemT.

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

addCnsldtnSubItemT

public void addCnsldtnSubItemT(SubItemText... entity)

Adds elements to the list of associated SubItemText entities. This corresponds to the OData navigation property to_CnsldtnSubItemT.

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

builder

public static SubItem.SubItemBuilder 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.

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

getSubItem_Text

@Nullable
public String getSubItem_Text()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SubItem_Text

Returns:

A medium text of up to 30 characters for the name.

getSubitemCarryForwardDestination

@Nullable
public String getSubitemCarryForwardDestination()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: SubitemCarryForwardDestination

Returns:

Enter the subitem to which the value of the current subitem is to be carried forward to during the balance carryforward procedure.

getSubitemCarryForwardDestination_Text

@Nullable
public String getSubitemCarryForwardDestination_Text()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SubitemCarryForwardDestination_Text

Returns:

A medium text of up to 30 characters for the name.

getSubitemRtrmtDivestitureDest

@Nullable
public String getSubitemRtrmtDivestitureDest()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: SubitemRtrmtDivestitureDest

Returns:

The retirement subitem (transaction type) determines which transaction type is posted during an asset retirement.

getSubitemRtrmtDivestitureDest_Text

@Nullable
public String getSubitemRtrmtDivestitureDest_Text()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SubitemRtrmtDivestitureDest_Text

Returns:

A medium text of up to 30 characters for the name.

getSubitemAcquisitionDestination

@Nullable
public String getSubitemAcquisitionDestination()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: SubitemAcquisitionDestination

Returns:

Subitem that is assigned for acquisitions.

getSubitemAcquisitionDestination_Text

@Nullable
public String getSubitemAcquisitionDestination_Text()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SubitemAcquisitionDestination_Text

Returns:

A medium text of up to 30 characters for the name.

toString

public String toString()

Overrides:

toString in class VdmObject<SubItem>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<SubItem>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<SubItem>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SubItem>