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

Class ProductGroupText

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.productgroup.ProductGroupText

public class ProductGroupText
extends VdmEntity<ProductGroupText>

API Product Group Value Help Text

Original entity name from the Odata EDM: A_ProductGroupTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ProductGroupTextSelectable	ALL_FIELDS Selector for all available fields of ProductGroupText.
static ProductGroupTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static ProductGroupTextField<String>	MATERIAL_GROUP Use with available fluent helpers to apply the MaterialGroup field to query operations.
static ProductGroupTextField<String>	MATERIAL_GROUP_NAME Use with available fluent helpers to apply the MaterialGroupName field to query operations.
static ProductGroupTextField<String>	MATERIAL_GROUP_TEXT Use with available fluent helpers to apply the MaterialGroupText field to query operations.
static ProductGroupTextOneToOneLink<ProductGroup>	TO_MATERIAL_GROUP Use with available fluent helpers to apply the to_MaterialGroup navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
ProductGroupText()
ProductGroupText(String materialGroup, String language, String materialGroupName, String materialGroupText, ProductGroup toMaterialGroup)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static ProductGroupText.ProductGroupTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ProductGroup	fetchMaterialGroup() Fetches the ProductGroup entity (one to one) associated with this entity.
static <T> ProductGroupTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ProductGroupTextField<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()
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection()
protected Map<String,Object>	getKey()
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getMaterialGroup() (Key Field) Constraints: Not nullable, Maximum length: 9
io.vavr.control.Option<ProductGroup>	getMaterialGroupIfPresent() Retrieval of associated ProductGroup entity (one to one).
String	getMaterialGroupName() Constraints: Not nullable, Maximum length: 20
ProductGroup	getMaterialGroupOrFetch() Retrieval of associated ProductGroup entity (one to one).
String	getMaterialGroupText() Constraints: Not nullable, Maximum length: 60
Class<ProductGroupText>	getType()
int	hashCode()
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setMaterialGroup(ProductGroup value) Overwrites the associated ProductGroup entity for the loaded navigation property to_MaterialGroup.
void	setMaterialGroup(String materialGroup) (Key Field) Constraints: Not nullable, Maximum length: 9
void	setMaterialGroupName(String materialGroupName) Constraints: Not nullable, Maximum length: 20
void	setMaterialGroupText(String materialGroupText) Constraints: Not nullable, Maximum length: 60
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
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 ProductGroupTextSelectable ALL_FIELDS

Selector for all available fields of ProductGroupText.

MATERIAL_GROUP

public static final ProductGroupTextField<String> MATERIAL_GROUP

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

LANGUAGE

public static final ProductGroupTextField<String> LANGUAGE

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

MATERIAL_GROUP_NAME

public static final ProductGroupTextField<String> MATERIAL_GROUP_NAME

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

MATERIAL_GROUP_TEXT

public static final ProductGroupTextField<String> MATERIAL_GROUP_TEXT

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

TO_MATERIAL_GROUP

public static final ProductGroupTextOneToOneLink<ProductGroup> TO_MATERIAL_GROUP

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

Constructor Detail

ProductGroupText

public ProductGroupText()

ProductGroupText

public ProductGroupText(@Nullable
                        String materialGroup,
                        @Nullable
                        String language,
                        @Nullable
                        String materialGroupName,
                        @Nullable
                        String materialGroupText,
                        @Nullable
                        ProductGroup toMaterialGroup)

Method Detail

getType

@Nonnull
public Class<ProductGroupText> getType()

Specified by:

getType in class VdmObject<ProductGroupText>

Returns:

The class of this object.

setMaterialGroup

public void setMaterialGroup(@Nullable
                             String materialGroup)

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

Original property name from the Odata EDM: MaterialGroup

You can use product groups to:Restrict the scope of analysesSearch specifically for product master records via search helpsIf you have not defined a product group hierarchy using the classification system, you maintain product groups in Customizing for the Material Master in Define material groups.If you have defined a product group hierarchy, which is normally the case in retail, you maintain product groups in Customizing for Material Groups or from the initial Retailing screen by choosing Master data -> Material group.

Parameters:

materialGroup - Key that you use to group together several products or services with the same attributes, and to assign them to a particular product group.

setLanguage

public void setLanguage(@Nullable
                        String language)

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

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Parameters:

language - The language key indicates

setMaterialGroupName

public void setMaterialGroupName(@Nullable
                                 String materialGroupName)

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: MaterialGroupName

Parameters:

materialGroupName - Product Group Description

setMaterialGroupText

public void setMaterialGroupText(@Nullable
                                 String materialGroupText)

Constraints: Not nullable, Maximum length: 60

Original property name from the Odata EDM: MaterialGroupText

Parameters:

materialGroupText - Additional full name for the material group.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<ProductGroupText>

getKey

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

Overrides:

getKey in class VdmObject<ProductGroupText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ProductGroupText>

fromMap

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

Overrides:

fromMap in class VdmObject<ProductGroupText>

field

@Nonnull
public static <T> ProductGroupTextField<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> ProductGroupTextField<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<ProductGroupText>

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

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

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()

Overrides:

getDefaultServicePath in class VdmEntity<ProductGroupText>

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<ProductGroupText>

fetchMaterialGroup

@Nullable
public ProductGroup fetchMaterialGroup()
                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the ProductGroup entity (one to one) associated with this entity. This corresponds to the OData navigation property to_MaterialGroup.

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

Returns:

The single associated ProductGroup entity, or null if an entity is not associated.

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.

getMaterialGroupOrFetch

@Nullable
public ProductGroup getMaterialGroupOrFetch()
                                               throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated ProductGroup entity (one to one). This corresponds to the OData navigation property to_MaterialGroup.

If the navigation property to_MaterialGroup of a queried ProductGroupText 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 ProductGroup entity.

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.

getMaterialGroupIfPresent

@Nonnull
public io.vavr.control.Option<ProductGroup> getMaterialGroupIfPresent()

Retrieval of associated ProductGroup entity (one to one). This corresponds to the OData navigation property to_MaterialGroup.

If the navigation property for an entity ProductGroupText 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_MaterialGroup is already loaded, the result will contain the ProductGroup entity. If not, an Option with result state empty is returned.

setMaterialGroup

public void setMaterialGroup(ProductGroup value)

Overwrites the associated ProductGroup entity for the loaded navigation property to_MaterialGroup.

Parameters:

value - New ProductGroup entity.

builder

public static ProductGroupText.ProductGroupTextBuilder builder()

getMaterialGroup

@Nullable
public String getMaterialGroup()

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

Original property name from the Odata EDM: MaterialGroup

You can use product groups to:Restrict the scope of analysesSearch specifically for product master records via search helpsIf you have not defined a product group hierarchy using the classification system, you maintain product groups in Customizing for the Material Master in Define material groups.If you have defined a product group hierarchy, which is normally the case in retail, you maintain product groups in Customizing for Material Groups or from the initial Retailing screen by choosing Master data -> Material group.

Returns:

Key that you use to group together several products or services with the same attributes, and to assign them to a particular product group.

getLanguage

@Nullable
public String getLanguage()

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

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Returns:

The language key indicates

getMaterialGroupName

@Nullable
public String getMaterialGroupName()

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: MaterialGroupName

Returns:

Product Group Description

getMaterialGroupText

@Nullable
public String getMaterialGroupText()

Constraints: Not nullable, Maximum length: 60

Original property name from the Odata EDM: MaterialGroupText

Returns:

Additional full name for the material group.

toString

public String toString()

Overrides:

toString in class VdmObject<ProductGroupText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<ProductGroupText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<ProductGroupText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ProductGroupText>