com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.namespaces.segmentationstructureandstrategymaintenance

Class SegmentationStructureFields

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.namespaces.segmentationstructureandstrategymaintenance.SegmentationStructureFields

public class SegmentationStructureFields
extends VdmEntity<SegmentationStructureFields>

Segmentation Structure Fields

Original entity name from the Odata EDM: SegmentationStructureFieldsType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static SegmentationStructureFieldsSelectable	ALL_FIELDS Selector for all available fields of SegmentationStructureFields.
static SegmentationStructureFieldsField<String>	BLANK_IS_ENABLED Use with available fluent helpers to apply the BlankIsEnabled field to query operations.
static SegmentationStructureFieldsField<String>	NR_OF_SEGMTN_FIELDS Use with available fluent helpers to apply the NrOfSegmtnFields field to query operations.
static SegmentationStructureFieldsField<String>	PROD_SEGMENTATION_TYPE Use with available fluent helpers to apply the ProdSegmentationType field to query operations.
static SegmentationStructureFieldsField<String>	PROD_SEGMTN_STRUCTURE_FIELD Use with available fluent helpers to apply the ProdSegmtnStructureField field to query operations.
static SegmentationStructureFieldsField<String>	SEGMENTATION_STRUCTURE Use with available fluent helpers to apply the SegmentationStructure field to query operations.
static SegmentationStructureFieldsOneToOneLink<SegmentationStructure>	TO_SEGMENTATION_STRUCTURE_TP Use with available fluent helpers to apply the to_SegmentationStructureTP navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
SegmentationStructureFields()
SegmentationStructureFields(String segmentationStructure, String prodSegmentationType, String nrOfSegmtnFields, String prodSegmtnStructureField, String blankIsEnabled, SegmentationStructure toSegmentationStructureTP)

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 SegmentationStructureFields.SegmentationStructureFieldsBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
SegmentationStructure	fetchSegmentationStructureTP() Fetches the SegmentationStructure entity (one to one) associated with this entity.
static <T> SegmentationStructureFieldsField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SegmentationStructureFieldsField<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	getBlankIsEnabled() Constraints: Not nullable, Maximum length: 1
protected String	getDefaultServicePath() Used by fluent helpers and navigation property methods to construct OData queries.
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
protected Map<String,Object>	getKey()
String	getNrOfSegmtnFields() (Key Field) Constraints: Not nullable, Maximum length: 3
String	getProdSegmentationType() (Key Field) Constraints: Not nullable, Maximum length: 1
String	getProdSegmtnStructureField() Constraints: Not nullable, Maximum length: 30
String	getSegmentationStructure() (Key Field) Constraints: Not nullable, Maximum length: 4
io.vavr.control.Option<SegmentationStructure>	getSegmentationStructureTPIfPresent() Retrieval of associated SegmentationStructure entity (one to one).
SegmentationStructure	getSegmentationStructureTPOrFetch() Retrieval of associated SegmentationStructure entity (one to one).
Class<SegmentationStructureFields>	getType()
int	hashCode()
void	setBlankIsEnabled(String blankIsEnabled) Constraints: Not nullable, Maximum length: 1
void	setNrOfSegmtnFields(String nrOfSegmtnFields) (Key Field) Constraints: Not nullable, Maximum length: 3
void	setProdSegmentationType(String prodSegmentationType) (Key Field) Constraints: Not nullable, Maximum length: 1
void	setProdSegmtnStructureField(String prodSegmtnStructureField) Constraints: Not nullable, Maximum length: 30
void	setSegmentationStructure(String segmentationStructure) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setSegmentationStructureTP(SegmentationStructure value) Overwrites the associated SegmentationStructure entity for the loaded navigation property to_SegmentationStructureTP.
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 SegmentationStructureFieldsSelectable ALL_FIELDS

Selector for all available fields of SegmentationStructureFields.

SEGMENTATION_STRUCTURE

public static final SegmentationStructureFieldsField<String> SEGMENTATION_STRUCTURE

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

PROD_SEGMENTATION_TYPE

public static final SegmentationStructureFieldsField<String> PROD_SEGMENTATION_TYPE

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

NR_OF_SEGMTN_FIELDS

public static final SegmentationStructureFieldsField<String> NR_OF_SEGMTN_FIELDS

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

PROD_SEGMTN_STRUCTURE_FIELD

public static final SegmentationStructureFieldsField<String> PROD_SEGMTN_STRUCTURE_FIELD

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

BLANK_IS_ENABLED

public static final SegmentationStructureFieldsField<String> BLANK_IS_ENABLED

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

TO_SEGMENTATION_STRUCTURE_TP

public static final SegmentationStructureFieldsOneToOneLink<SegmentationStructure> TO_SEGMENTATION_STRUCTURE_TP

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

Constructor Detail

SegmentationStructureFields

public SegmentationStructureFields()

SegmentationStructureFields

public SegmentationStructureFields(@Nullable
                                   String segmentationStructure,
                                   @Nullable
                                   String prodSegmentationType,
                                   @Nullable
                                   String nrOfSegmtnFields,
                                   @Nullable
                                   String prodSegmtnStructureField,
                                   @Nullable
                                   String blankIsEnabled,
                                   @Nullable
                                   SegmentationStructure toSegmentationStructureTP)

Method Detail

getType

@Nonnull
public Class<SegmentationStructureFields> getType()

Specified by:

getType in class VdmObject<SegmentationStructureFields>

Returns:

The class of this object.

setSegmentationStructure

public void setSegmentationStructure(@Nullable
                                     String segmentationStructure)

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

Original property name from the Odata EDM: SegmentationStructure

Parameters:

segmentationStructure - Segmentation Structure

setProdSegmentationType

public void setProdSegmentationType(@Nullable
                                    String prodSegmentationType)

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

Original property name from the Odata EDM: ProdSegmentationType

Parameters:

prodSegmentationType - Segmentation Type

setNrOfSegmtnFields

public void setNrOfSegmtnFields(@Nullable
                                String nrOfSegmtnFields)

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

Original property name from the Odata EDM: NrOfSegmtnFields

Parameters:

nrOfSegmtnFields - Consecutive Number of Segmentation Fields

setProdSegmtnStructureField

public void setProdSegmtnStructureField(@Nullable
                                        String prodSegmtnStructureField)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: ProdSegmtnStructureField

Parameters:

prodSegmtnStructureField - Name for Segmentation Structure Field

setBlankIsEnabled

public void setBlankIsEnabled(@Nullable
                              String blankIsEnabled)

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: BlankIsEnabled

Parameters:

blankIsEnabled - Indicator for Enabling Blank as a Valid Entry

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<SegmentationStructureFields>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<SegmentationStructureFields>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<SegmentationStructureFields>

fromMap

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

Overrides:

fromMap in class VdmObject<SegmentationStructureFields>

field

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

Overrides:

getDestinationForFetch in class VdmEntity<SegmentationStructureFields>

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

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

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

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<SegmentationStructureFields>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<SegmentationStructureFields>

fetchSegmentationStructureTP

@Nullable
public SegmentationStructure fetchSegmentationStructureTP()
                                                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

The single associated SegmentationStructure 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.

getSegmentationStructureTPOrFetch

@Nullable
public SegmentationStructure getSegmentationStructureTPOrFetch()
                                                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated SegmentationStructure entity (one to one). This corresponds to the OData navigation property to_SegmentationStructureTP.

If the navigation property to_SegmentationStructureTP of a queried SegmentationStructureFields 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 SegmentationStructure 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.

getSegmentationStructureTPIfPresent

@Nonnull
public io.vavr.control.Option<SegmentationStructure> getSegmentationStructureTPIfPresent()

Retrieval of associated SegmentationStructure entity (one to one). This corresponds to the OData navigation property to_SegmentationStructureTP.

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

setSegmentationStructureTP

public void setSegmentationStructureTP(SegmentationStructure value)

Overwrites the associated SegmentationStructure entity for the loaded navigation property to_SegmentationStructureTP.

Parameters:

value - New SegmentationStructure entity.

builder

@Nonnull
public static SegmentationStructureFields.SegmentationStructureFieldsBuilder builder()

getSegmentationStructure

@Nullable
public String getSegmentationStructure()

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

Original property name from the Odata EDM: SegmentationStructure

Returns:

Segmentation Structure

getProdSegmentationType

@Nullable
public String getProdSegmentationType()

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

Original property name from the Odata EDM: ProdSegmentationType

Returns:

Segmentation Type

getNrOfSegmtnFields

@Nullable
public String getNrOfSegmtnFields()

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

Original property name from the Odata EDM: NrOfSegmtnFields

Returns:

Consecutive Number of Segmentation Fields

getProdSegmtnStructureField

@Nullable
public String getProdSegmtnStructureField()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: ProdSegmtnStructureField

Returns:

Name for Segmentation Structure Field

getBlankIsEnabled

@Nullable
public String getBlankIsEnabled()

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: BlankIsEnabled

Returns:

Indicator for Enabling Blank as a Valid Entry

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<SegmentationStructureFields>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<SegmentationStructureFields>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<SegmentationStructureFields>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SegmentationStructureFields>