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

Class PlanningCategory

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.planningcategory.PlanningCategory

public class PlanningCategory
extends VdmEntity<PlanningCategory>

API Planning Category

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlanningCategory.PlanningCategoryBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static PlanningCategorySelectable	ALL_FIELDS Selector for all available fields of PlanningCategory.
static PlanningCategoryField<String>	PLANNING_CATEGORY Use with available fluent helpers to apply the PlanningCategory field to query operations.
static PlanningCategoryLink<PlanningCategoryText>	TO_TEXT Use with available fluent helpers to apply the to_Text navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
PlanningCategory()
PlanningCategory(String planningCategory, ErpConfigContext erpConfigContext, List<PlanningCategoryText> toText)

Method Summary

Modifier and Type	Method and Description
void	addText(PlanningCategoryText... entity) Adds elements to the list of associated PlanningCategoryText entities.
static PlanningCategory.PlanningCategoryBuilder	builder()
boolean	equals(Object o)
List<PlanningCategoryText>	fetchText() Fetches the PlanningCategoryText entities (one to many) associated with this entity.
static <T> PlanningCategoryField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
String	getPlanningCategory() (Key Field) Constraints: Not nullable, Maximum length: 10 Categories from SAP Business Planning & Consolidation are mapped in Real-Time Consolidation to consolidation versions.
List<PlanningCategoryText>	getTextOrFetch() Retrieval of associated PlanningCategoryText entities (one to many).
com.google.common.base.Optional<List<PlanningCategoryText>>	getTextOrNull() Retrieval of associated PlanningCategoryText entities (one to many).
Class<PlanningCategory>	getType()
int	hashCode()
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
void	setPlanningCategory(String planningCategory) (Key Field) Constraints: Not nullable, Maximum length: 10 Categories from SAP Business Planning & Consolidation are mapped in Real-Time Consolidation to consolidation versions.
void	setText(List<PlanningCategoryText> value) Overwrites the list of associated PlanningCategoryText entities for the loaded navigation property to_Text.
String	toString()

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

getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final PlanningCategorySelectable ALL_FIELDS

Selector for all available fields of PlanningCategory.

PLANNING_CATEGORY

public static final PlanningCategoryField<String> PLANNING_CATEGORY

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

TO_TEXT

public static final PlanningCategoryLink<PlanningCategoryText> TO_TEXT

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

Constructor Detail

PlanningCategory

public PlanningCategory()

PlanningCategory

public PlanningCategory(@Nullable
                        String planningCategory,
                        @Nullable
                        ErpConfigContext erpConfigContext,
                        List<PlanningCategoryText> toText)

Method Detail

getType

public Class<PlanningCategory> getType()

Specified by:

getType in class VdmObject<PlanningCategory>

Returns:

The class of this object.

field

public static <T> PlanningCategoryField<T> field(String fieldName,
                                                 Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

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.

fetchText

public List<PlanningCategoryText> fetchText()
                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getTextOrFetch

public List<PlanningCategoryText> getTextOrFetch()
                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated PlanningCategoryText entities (one to many).

If the navigation property to_Text of a queried PlanningCategory 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 PlanningCategoryText 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.

getTextOrNull

public com.google.common.base.Optional<List<PlanningCategoryText>> getTextOrNull()

Retrieval of associated PlanningCategoryText entities (one to many).

If the navigation property to_Text for an entity PlanningCategory has not been resolved yet, this method will not query further information. Instead its Optional result state will be null.

Returns:

If the information for navigation property to_Text is already loaded, the result will contain the PlanningCategoryText entities. If not, a null value state is returned.

setText

public void setText(@NonNull
                    List<PlanningCategoryText> value)

Overwrites the list of associated PlanningCategoryText entities for the loaded navigation property to_Text.

If the navigation property to_Text of a queried PlanningCategory 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 PlanningCategoryText entities.

addText

public void addText(PlanningCategoryText... entity)

Adds elements to the list of associated PlanningCategoryText entities.

If the navigation property to_Text of a queried PlanningCategory 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 PlanningCategoryText entities.

builder

public static PlanningCategory.PlanningCategoryBuilder builder()

getPlanningCategory

@Nullable
public String getPlanningCategory()

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

Categories from SAP Business Planning & Consolidation are mapped in Real-Time Consolidation to consolidation versions. This mapping is defined in the Model transaction (RTCMD) under the Version tab.

Returns:

Specifies the BPC category.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setPlanningCategory

public void setPlanningCategory(@Nullable
                                String planningCategory)

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

Categories from SAP Business Planning & Consolidation are mapped in Real-Time Consolidation to consolidation versions. This mapping is defined in the Model transaction (RTCMD) under the Version tab.

Parameters:

planningCategory -

setErpConfigContext

public void setErpConfigContext(@Nullable
                                ErpConfigContext erpConfigContext)

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<PlanningCategory>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<PlanningCategory>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<PlanningCategory>