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

Class CustomerGroup

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customergroup.CustomerGroup

public class CustomerGroup
extends VdmEntity<CustomerGroup>

API Customer Group

Original entity name from the Odata EDM: A_CustomerGroupType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static CustomerGroupSelectable	ALL_FIELDS Selector for all available fields of CustomerGroup.
static CustomerGroupField<String>	CUSTOMER_GROUP Use with available fluent helpers to apply the CustomerGroup field to query operations.
static CustomerGroupLink<CustomerGroupText>	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
CustomerGroup()
CustomerGroup(String customerGroup, List<CustomerGroupText> toText)

Method Summary

Modifier and Type	Method and Description
void	addText(CustomerGroupText... entity) Adds elements to the list of associated CustomerGroupText entities.
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static CustomerGroup.CustomerGroupBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<CustomerGroupText>	fetchText() Fetches the CustomerGroupText entities (one to many) associated with this entity.
static <T> CustomerGroupField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> CustomerGroupField<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	getCustomerGroup() (Key Field) Constraints: Not nullable, Maximum length: 2
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()
Optional<List<CustomerGroupText>>	getTextIfPresent() Retrieval of associated CustomerGroupText entities (one to many).
List<CustomerGroupText>	getTextOrFetch() Retrieval of associated CustomerGroupText entities (one to many).
Class<CustomerGroup>	getType()
int	hashCode()
void	setCustomerGroup(String customerGroup) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setText(List<CustomerGroupText> value) Overwrites the list of associated CustomerGroupText 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, 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 CustomerGroupSelectable ALL_FIELDS

Selector for all available fields of CustomerGroup.

CUSTOMER_GROUP

public static final CustomerGroupField<String> CUSTOMER_GROUP

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

TO_TEXT

public static final CustomerGroupLink<CustomerGroupText> TO_TEXT

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

Constructor Detail

CustomerGroup

public CustomerGroup()

CustomerGroup

public CustomerGroup(@Nullable
                     String customerGroup,
                     List<CustomerGroupText> toText)

Method Detail

getType

@Nonnull
public Class<CustomerGroup> getType()

Specified by:

getType in class VdmObject<CustomerGroup>

Returns:

The class of this object.

setCustomerGroup

public void setCustomerGroup(@Nullable
                             String customerGroup)

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

Original property name from the Odata EDM: CustomerGroup

Parameters:

customerGroup - Identifies a particular group of customers (for example, wholesale or retail) for the purpose of pricing or generating statistics.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<CustomerGroup>

getKey

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

Overrides:

getKey in class VdmObject<CustomerGroup>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<CustomerGroup>

fromMap

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

Overrides:

fromMap in class VdmObject<CustomerGroup>

field

@Nonnull
public static <T> CustomerGroupField<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> CustomerGroupField<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.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities). New ERP configuration context to apply to this entity

Overrides:

getErpConfigContext in class VdmEntity<CustomerGroup>

Returns:

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

setErpConfigContext

@Deprecated
public void setErpConfigContext(@Nullable
                                            ErpConfigContext erpConfigContext)

Deprecated. Use attachToService(String, ErpConfigContext) instead.

Description copied from class: VdmEntity

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

Overrides:

setErpConfigContext in class VdmEntity<CustomerGroup>

Parameters:

erpConfigContext - New ERP configuration context to apply to this entity

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

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nullable
                            ErpConfigContext configContext)

Description copied from class: VdmEntity

Sets the service path and ERP configuration context for the fetch commands of this entity. Ensures that both are set to some value by using defaults if null values are provided in the arguments. Existing values are preserved if null values are provided in the arguments. 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<CustomerGroup>

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.

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.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<CustomerGroup>

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<CustomerGroup>

fetchText

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

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

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

If the navigation property to_Text of a queried CustomerGroup 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 CustomerGroupText 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 Optional<List<CustomerGroupText>> getTextIfPresent()

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

If the navigation property for an entity CustomerGroup 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 CustomerGroupText entities. If not, an Optional with result state empty is returned.

setText

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

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

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

addText

public void addText(CustomerGroupText... entity)

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

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

builder

public static CustomerGroup.CustomerGroupBuilder builder()

getCustomerGroup

@Nullable
public String getCustomerGroup()

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

Original property name from the Odata EDM: CustomerGroup

Returns:

Identifies a particular group of customers (for example, wholesale or retail) for the purpose of pricing or generating statistics.

toString

public String toString()

Overrides:

toString in class VdmObject<CustomerGroup>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<CustomerGroup>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<CustomerGroup>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<CustomerGroup>