public class PlanningCategory extends VdmEntity<PlanningCategory>
Original entity name from the Odata EDM: A_PlanningCategoryType
Modifier and Type | Class and Description |
---|---|
static class |
PlanningCategory.PlanningCategoryBuilder
Helper class to allow for fluent creation of PlanningCategory instances.
|
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.
|
changedOriginalFields
Constructor and Description |
---|
PlanningCategory() |
PlanningCategory(String planningCategory,
List<PlanningCategoryText> toText) |
Modifier and Type | Method and Description |
---|---|
void |
addText(PlanningCategoryText... entity)
Adds elements to the list of associated PlanningCategoryText entities.
|
void |
attachToService(String servicePath,
ErpConfigContext configContext)
Sets the service path and ERP configuration context for the fetch commands of this entity.
|
static PlanningCategory.PlanningCategoryBuilder |
builder() |
protected boolean |
canEqual(Object other) |
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.
|
static <T,DomainT> |
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) |
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 |
getPlanningCategory()
(Key Field) Constraints: Not nullable, Maximum length: 10
|
Optional<List<PlanningCategoryText>> |
getTextIfPresent()
Retrieval of associated PlanningCategoryText entities (one to many).
|
List<PlanningCategoryText> |
getTextOrFetch()
Retrieval of associated PlanningCategoryText entities (one to many).
|
Class<PlanningCategory> |
getType() |
int |
hashCode() |
void |
setErpConfigContext(ErpConfigContext erpConfigContext)
Deprecated.
Use
attachToService(String, ErpConfigContext) instead. |
void |
setPlanningCategory(String planningCategory)
(Key Field) Constraints: Not nullable, Maximum length: 10
|
protected void |
setServicePathForFetch(String servicePathForFetch)
The service path only used for the fetch commands of this entity.
|
void |
setText(List<PlanningCategoryText> value)
Overwrites the list of associated PlanningCategoryText entities for the loaded navigation property
to_Text.
|
protected Map<String,Object> |
toMapOfFields() |
protected Map<String,Object> |
toMapOfNavigationProperties() |
String |
toString() |
getEndpointUrl, getServicePathForFetch, getVersionIdentifier, setVersionIdentifier
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields
public static final PlanningCategorySelectable ALL_FIELDS
public static final PlanningCategoryField<String> PLANNING_CATEGORY
public static final PlanningCategoryLink<PlanningCategoryText> TO_TEXT
public PlanningCategory()
public PlanningCategory(@Nullable String planningCategory, List<PlanningCategoryText> toText)
@Nonnull public Class<PlanningCategory> getType()
getType
in class VdmObject<PlanningCategory>
public void setPlanningCategory(@Nullable String planningCategory)
Original property name from the Odata EDM: PlanningCategory
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.
planningCategory
- Specifies the BPC category.protected String getEntityCollection()
getEntityCollection
in class VdmEntity<PlanningCategory>
@Nonnull protected Map<String,Object> getKey()
getKey
in class VdmObject<PlanningCategory>
@Nonnull protected Map<String,Object> toMapOfFields()
toMapOfFields
in class VdmObject<PlanningCategory>
protected void fromMap(Map<String,Object> inputValues)
fromMap
in class VdmObject<PlanningCategory>
@Nonnull public static <T> PlanningCategoryField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
T
- The type of the extension field when performing value comparisons.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.@Nonnull public static <T,DomainT> PlanningCategoryField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
T
- The type of the extension field when performing value comparisons.DomainT
- The type of the extension field as returned by the OData service.typeConverter
- A TypeConverterfieldName
- The name of the extension field as returned by the OData service.@Nullable public ErpConfigContext getErpConfigContext()
VdmEntity
getErpConfigContext
in class VdmEntity<PlanningCategory>
@Deprecated public void setErpConfigContext(@Nullable ErpConfigContext erpConfigContext)
attachToService(String, ErpConfigContext)
instead.VdmEntity
setErpConfigContext
in class VdmEntity<PlanningCategory>
erpConfigContext
- New ERP configuration context to apply to this entityprotected void setServicePathForFetch(@Nullable String servicePathForFetch)
VdmEntity
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.
setServicePathForFetch
in class VdmEntity<PlanningCategory>
public void attachToService(@Nullable String servicePath, @Nullable ErpConfigContext configContext)
VdmEntity
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.
attachToService
in class VdmEntity<PlanningCategory>
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
.protected String getDefaultServicePath()
getDefaultServicePath
in class VdmEntity<PlanningCategory>
@Nonnull protected Map<String,Object> toMapOfNavigationProperties()
toMapOfNavigationProperties
in class VdmObject<PlanningCategory>
@Nonnull public List<PlanningCategoryText> fetchText() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
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.@Nonnull public List<PlanningCategoryText> getTextOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
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.
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.@Nonnull public Optional<List<PlanningCategoryText>> getTextIfPresent()
If the navigation property for an entity PlanningCategory has not been resolved yet, this method will
not query further information. Instead its Optional
result state will be empty
.
Optional
with result state
empty
is returned.public void setText(@Nonnull List<PlanningCategoryText> value)
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.
value
- List of PlanningCategoryText entities.public void addText(PlanningCategoryText... entity)
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.
entity
- Array of PlanningCategoryText entities.public static PlanningCategory.PlanningCategoryBuilder builder()
@Nullable public String getPlanningCategory()
Original property name from the Odata EDM: PlanningCategory
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.
public String toString()
toString
in class VdmObject<PlanningCategory>
public boolean equals(Object o)
equals
in class VdmObject<PlanningCategory>
protected boolean canEqual(Object other)
canEqual
in class VdmObject<PlanningCategory>
public int hashCode()
hashCode
in class VdmObject<PlanningCategory>
Copyright © 2019 SAP SE. All rights reserved.