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

Class ProductGroup

java.lang.Object

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

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

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

public class ProductGroup
extends VdmEntity<ProductGroup>

API Product Group Value Help

Original entity name from the Odata EDM: A_ProductGroupType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProductGroup.ProductGroupBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static ProductGroupSelectable	ALL_FIELDS Selector for all available fields of ProductGroup.
static ProductGroupField<String>	AUTHORIZATION_GROUP Use with available fluent helpers to apply the AuthorizationGroup field to query operations.
static ProductGroupField<String>	MATERIAL_GROUP Use with available fluent helpers to apply the MaterialGroup field to query operations.
static ProductGroupLink<ProductGroupText>	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.s4hana.datamodel.odata.helper.VdmObject

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
ProductGroup()
ProductGroup(String materialGroup, String authorizationGroup, ErpConfigContext erpConfigContext, List<ProductGroupText> toText)

Method Summary

Modifier and Type	Method and Description
void	addText(ProductGroupText... entity) Adds elements to the list of associated ProductGroupText entities.
static ProductGroup.ProductGroupBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<ProductGroupText>	fetchText() Fetches the ProductGroupText entities (one to many) associated with this entity.
static <T> ProductGroupField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ProductGroupField<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)
String	getAuthorizationGroup() Constraints: Not nullable, Maximum length: 4
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	getMaterialGroup() (Key Field) Constraints: Not nullable, Maximum length: 9
Optional<List<ProductGroupText>>	getTextIfPresent() Retrieval of associated ProductGroupText entities (one to many).
List<ProductGroupText>	getTextOrFetch() Retrieval of associated ProductGroupText entities (one to many).
Class<ProductGroup>	getType()
int	hashCode()
void	setAuthorizationGroup(String authorizationGroup) Constraints: Not nullable, Maximum length: 4
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setMaterialGroup(String materialGroup) (Key Field) Constraints: Not nullable, Maximum length: 9
void	setText(List<ProductGroupText> value) Overwrites the list of associated ProductGroupText 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.s4hana.datamodel.odata.helper.VdmEntity

getEndpointUrl, getServicePathForFetch, getVersionIdentifier, setServicePathForFetch, 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 ProductGroupSelectable ALL_FIELDS

Selector for all available fields of ProductGroup.

MATERIAL_GROUP

public static final ProductGroupField<String> MATERIAL_GROUP

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

AUTHORIZATION_GROUP

public static final ProductGroupField<String> AUTHORIZATION_GROUP

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

TO_TEXT

public static final ProductGroupLink<ProductGroupText> TO_TEXT

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

Constructor Detail

ProductGroup

public ProductGroup()

ProductGroup

public ProductGroup(@Nullable
                    String materialGroup,
                    @Nullable
                    String authorizationGroup,
                    @Nullable
                    ErpConfigContext erpConfigContext,
                    List<ProductGroupText> toText)

Method Detail

getType

public Class<ProductGroup> getType()

Specified by:

getType in class VdmObject<ProductGroup>

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 material groups to: Restrict the scope of analyses Search specifically for product master records via search helps If you have not defined a material 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.

setAuthorizationGroup

public void setAuthorizationGroup(@Nullable
                                  String authorizationGroup)

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: AuthorizationGroup

In order to carry out a specific activity, the user must have authorization for the combination of the activity and the authorization group.

Parameters:

authorizationGroup - The authorization group enables you protect access to certain objects.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<ProductGroup>

getKey

protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<ProductGroup>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ProductGroup>

fromMap

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

Overrides:

fromMap in class VdmObject<ProductGroup>

field

@Nonnull
public static <T> ProductGroupField<T> field(@Nonnull
                                                       String fieldName,
                                                       @Nonnull
                                                       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.

field

@Nonnull
public static <T,DomainT> ProductGroupField<T> field(@Nonnull
                                                               String fieldName,
                                                               @Nonnull
                                                               TypeConverter<T,DomainT> typeConverter)

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

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.

toMapOfNavigationProperties

protected Map<String,Object> toMapOfNavigationProperties()

Overrides:

toMapOfNavigationProperties in class VdmObject<ProductGroup>

fetchText

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

Fetches the ProductGroupText 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 ProductGroupText 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<ProductGroupText> getTextOrFetch()
                                      throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

public Optional<List<ProductGroupText>> getTextIfPresent()

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

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

setText

public void setText(@Nonnull
                    List<ProductGroupText> value)

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

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

addText

public void addText(ProductGroupText... entity)

Adds elements to the list of associated ProductGroupText entities. This corresponds to the OData navigation property to_Text.

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

builder

public static ProductGroup.ProductGroupBuilder 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 material groups to: Restrict the scope of analyses Search specifically for product master records via search helps If you have not defined a material 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.

getAuthorizationGroup

@Nullable
public String getAuthorizationGroup()

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: AuthorizationGroup

In order to carry out a specific activity, the user must have authorization for the combination of the activity and the authorization group.

Returns:

The authorization group enables you protect access to certain objects.

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.

setErpConfigContext

public void setErpConfigContext(@Nullable
                                ErpConfigContext erpConfigContext)

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

Overrides:

setErpConfigContext in class VdmEntity<ProductGroup>

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<ProductGroup>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<ProductGroup>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<ProductGroup>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ProductGroup>