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

Class PlanningCategory

java.lang.Object

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

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

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

public class PlanningCategory
extends VdmEntity<PlanningCategory>

API Planning Category

Original entity name from the Odata EDM: A_PlanningCategoryType

Nested Class Summary

Nested Classes

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

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.

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

changedOriginalFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addText(PlanningCategoryText... entity) Adds elements to the list of associated PlanningCategoryText entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination 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> PlanningCategoryField<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)
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.
protected Map<String,Object>	getKey()
String	getPlanningCategory() (Key Field) Constraints: Not nullable, Maximum length: 10
io.vavr.control.Option<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	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()

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 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,
                        List<PlanningCategoryText> toText)

Method Detail

getType

@Nonnull
public Class<PlanningCategory> getType()

Specified by:

getType in class VdmObject<PlanningCategory>

Returns:

The class of this object.

setPlanningCategory

public void setPlanningCategory(@Nullable
                                String planningCategory)

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

Original property name from the Odata EDM: PlanningCategory

You can create categories for different purposes, for example, for optimistic or pessimistic plan scenarios, for top-down or bottom-up planning, or any other purpose. You can also use plan categories to store budgets instead of plan data.

Parameters:

planningCategory - Used to distinguish different sets of plan data.

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<PlanningCategory>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<PlanningCategory>

fromMap

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

Overrides:

fromMap in class VdmObject<PlanningCategory>

field

@Nonnull
public static <T> PlanningCategoryField<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> PlanningCategoryField<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<PlanningCategory>

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

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

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

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

fetchText

@Nonnull
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

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

Retrieval of associated PlanningCategoryText entities (one to many). This corresponds to the OData 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.

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.

getTextIfPresent

@Nonnull
public io.vavr.control.Option<List<PlanningCategoryText>> getTextIfPresent()

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

If the navigation property for an entity PlanningCategory 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_Text is already loaded, the result will contain the PlanningCategoryText entities. If not, an Option with result state empty 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. This corresponds to the OData 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:

entity - Array of PlanningCategoryText entities.

builder

public static PlanningCategory.PlanningCategoryBuilder builder()

getPlanningCategory

@Nullable
public String getPlanningCategory()

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

Original property name from the Odata EDM: PlanningCategory

You can create categories for different purposes, for example, for optimistic or pessimistic plan scenarios, for top-down or bottom-up planning, or any other purpose. You can also use plan categories to store budgets instead of plan data.

Returns:

Used to distinguish different sets of plan data.

toString

public String toString()

Overrides:

toString in class VdmObject<PlanningCategory>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<PlanningCategory>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<PlanningCategory>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<PlanningCategory>