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

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

public class CustomerGroup
extends VdmEntity<CustomerGroup>

API Customer Group

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomerGroup.CustomerGroupBuilder

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.

Constructor Summary

Constructors

Constructor and Description
CustomerGroup()
CustomerGroup(String customerGroup, ErpConfigContext erpConfigContext, List<CustomerGroupText> toText)

Method Summary

Modifier and Type	Method and Description
void	addText(CustomerGroupText... entity) Adds elements to the list of associated CustomerGroupText entities.
static CustomerGroup.CustomerGroupBuilder	builder()
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.
String	getCustomerGroup() (Key Field) Constraints: Not nullable, Maximum length: 2
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
List<CustomerGroupText>	getTextOrFetch() Retrieval of associated CustomerGroupText entities (one to many).
com.google.common.base.Optional<List<CustomerGroupText>>	getTextOrNull() 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) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setText(List<CustomerGroupText> value) Overwrites the list of associated CustomerGroupText entities for the loaded navigation property to_Text.
String	toString()

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

getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object

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

@Generated(value="lombok")
public CustomerGroup()

CustomerGroup

@ConstructorProperties(value={"customerGroup","erpConfigContext","toText"})
 @Generated(value="lombok")
public CustomerGroup(@Nullable
                                                                                                                             String customerGroup,
                                                                                                                             @Nullable
                                                                                                                             ErpConfigContext erpConfigContext,
                                                                                                                             List<CustomerGroupText> toText)

Method Detail

getType

public Class<CustomerGroup> getType()

Specified by:

getType in class VdmObject<CustomerGroup>

Returns:

The class of this object.

field

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

fetchText

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

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

Retrieval of associated CustomerGroupText entities (one to many).

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.

getTextOrNull

public com.google.common.base.Optional<List<CustomerGroupText>> getTextOrNull()

Retrieval of associated CustomerGroupText entities (one to many).

If the navigation property to_Text for an entity CustomerGroup has not been resolved yet, this method will not query further information. Instead its Optional result state will be null.

Returns:

If the information for navigation property to_Text is already loaded, the result will contain the CustomerGroupText entities. If not, a null value state 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.

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

@Generated(value="lombok")
public static CustomerGroup.CustomerGroupBuilder builder()

getCustomerGroup

@Nullable
 @Generated(value="lombok")
public String getCustomerGroup()

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

Returns:

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

getErpConfigContext

@Nullable
 @Generated(value="lombok")
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.

setCustomerGroup

@Generated(value="lombok")
public void setCustomerGroup(@Nullable
                                                        String customerGroup)

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

Parameters:

customerGroup -

setErpConfigContext

@Generated(value="lombok")
public void setErpConfigContext(@Nullable
                                                           ErpConfigContext erpConfigContext)

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

Parameters:

erpConfigContext -

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class VdmObject<CustomerGroup>

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class VdmObject<CustomerGroup>

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class VdmObject<CustomerGroup>