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

Class DistributionChannel

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readdistributionchannel.DistributionChannel

public class DistributionChannel
extends VdmEntity<DistributionChannel>

API Distribution Channel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DistributionChannel.DistributionChannelBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static DistributionChannelSelectable	ALL_FIELDS Selector for all available fields of DistributionChannel.
static DistributionChannelField<String>	DISTRIBUTION_CHANNEL Use with available fluent helpers to apply the DistributionChannel field to query operations.
static DistributionChannelLink<DistributionChannelText>	TO_TEXT Use with available fluent helpers to apply the to_Text navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
DistributionChannel()
DistributionChannel(String distributionChannel, ErpConfigContext erpConfigContext, List<DistributionChannelText> toText)

Method Summary

Modifier and Type	Method and Description
void	addText(DistributionChannelText... entity) Adds elements to the list of associated DistributionChannelText entities.
static DistributionChannel.DistributionChannelBuilder	builder()
boolean	equals(Object o)
List<DistributionChannelText>	fetchText() Fetches the DistributionChannelText entities (one to many) associated with this entity.
static <T> DistributionChannelField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getDistributionChannel() (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<DistributionChannelText>	getTextOrFetch() Retrieval of associated DistributionChannelText entities (one to many).
com.google.common.base.Optional<List<DistributionChannelText>>	getTextOrNull() Retrieval of associated DistributionChannelText entities (one to many).
Class<DistributionChannel>	getType()
int	hashCode()
void	setDistributionChannel(String distributionChannel) (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<DistributionChannelText> value) Overwrites the list of associated DistributionChannelText 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 DistributionChannelSelectable ALL_FIELDS

Selector for all available fields of DistributionChannel.

DISTRIBUTION_CHANNEL

public static final DistributionChannelField<String> DISTRIBUTION_CHANNEL

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

TO_TEXT

public static final DistributionChannelLink<DistributionChannelText> TO_TEXT

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

Constructor Detail

DistributionChannel

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

DistributionChannel

@ConstructorProperties(value={"distributionChannel","erpConfigContext","toText"})
 @Generated(value="lombok")
public DistributionChannel(@Nullable
                                                                                                                                         String distributionChannel,
                                                                                                                                         @Nullable
                                                                                                                                         ErpConfigContext erpConfigContext,
                                                                                                                                         List<DistributionChannelText> toText)

Method Detail

getType

public Class<DistributionChannel> getType()

Specified by:

getType in class VdmObject<DistributionChannel>

Returns:

The class of this object.

field

public static <T> DistributionChannelField<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<DistributionChannelText> fetchText()
                                        throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

Retrieval of associated DistributionChannelText entities (one to many).

If the navigation property to_Text of a queried DistributionChannel 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 DistributionChannelText 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<DistributionChannelText>> getTextOrNull()

Retrieval of associated DistributionChannelText entities (one to many).

If the navigation property to_Text for an entity DistributionChannel 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 DistributionChannelText entities. If not, a null value state is returned.

setText

public void setText(@NonNull
                    List<DistributionChannelText> value)

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

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

addText

public void addText(DistributionChannelText... entity)

Adds elements to the list of associated DistributionChannelText entities.

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

builder

@Generated(value="lombok")
public static DistributionChannel.DistributionChannelBuilder builder()

getDistributionChannel

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

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

You can maintain information about customers and materials by sales organization and distribution channel. Within a sales organization you can deliver goods to a given customer through more than one distribution channel. You can assign a distribution channel to one or more sales organizations. If, for example, you have numerous sales organizations, each sales organization may use the "Wholesale" distribution channel. For each combination of sales organization and distribution channel, you can further assign one or more of the divisions that are defined for the sales organization. You can, for example, assign "Food" and "Non-food" divisions to the "Wholesale" distribution channel. A particular combination of sales organization, distribution channel, and division is known as a sales area.

Returns:

The way in which products or services reach the customer. Typical examples of distribution channels are wholesale, retail, or direct sales.

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.

setDistributionChannel

@Generated(value="lombok")
public void setDistributionChannel(@Nullable
                                                              String distributionChannel)

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

You can maintain information about customers and materials by sales organization and distribution channel. Within a sales organization you can deliver goods to a given customer through more than one distribution channel. You can assign a distribution channel to one or more sales organizations. If, for example, you have numerous sales organizations, each sales organization may use the "Wholesale" distribution channel. For each combination of sales organization and distribution channel, you can further assign one or more of the divisions that are defined for the sales organization. You can, for example, assign "Food" and "Non-food" divisions to the "Wholesale" distribution channel. A particular combination of sales organization, distribution channel, and division is known as a sales area.

Parameters:

distributionChannel -

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

equals

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

Overrides:

equals in class VdmObject<DistributionChannel>

hashCode

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

Overrides:

hashCode in class VdmObject<DistributionChannel>