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

Class FunctionalLocationLongText

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.functionallocation.FunctionalLocationLongText

public class FunctionalLocationLongText
extends VdmEntity<FunctionalLocationLongText>

Functional Location Text

Original entity name from the Odata EDM: FunctionalLocationLongTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static FunctionalLocationLongTextSelectable	ALL_FIELDS Selector for all available fields of FunctionalLocationLongText.
static FunctionalLocationLongTextField<String>	FUNCNL_LOC_LONG_TEXT Use with available fluent helpers to apply the FuncnlLocLongText field to query operations.
static FunctionalLocationLongTextField<String>	FUNCTIONAL_LOCATION Use with available fluent helpers to apply the FunctionalLocation field to query operations.
static FunctionalLocationLongTextField<String>	FUNCTIONAL_LOCATION_LABEL_NAME Use with available fluent helpers to apply the FunctionalLocationLabelName field to query operations.
static FunctionalLocationLongTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static FunctionalLocationLongTextField<String>	TEXT_OBJECT_KEY Use with available fluent helpers to apply the TextObjectKey field to query operations.
static FunctionalLocationLongTextOneToOneLink<FunctionalLocation>	TO_FUNCTIONAL_LOCATION Use with available fluent helpers to apply the to_FunctionalLocation navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
FunctionalLocationLongText()
FunctionalLocationLongText(String functionalLocation, String functionalLocationLabelName, String textObjectKey, String language, String funcnlLocLongText, FunctionalLocation toFunctionalLocation)

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 FunctionalLocationLongText.FunctionalLocationLongTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
FunctionalLocation	fetchFunctionalLocation() Fetches the FunctionalLocation entity (one to one) associated with this entity.
static <T> FunctionalLocationLongTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> FunctionalLocationLongTextField<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)
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.
String	getFuncnlLocLongText() Constraints: none
String	getFunctionalLocation() (Key Field) Constraints: Not nullable, Maximum length: 30
io.vavr.control.Option<FunctionalLocation>	getFunctionalLocationIfPresent() Retrieval of associated FunctionalLocation entity (one to one).
String	getFunctionalLocationLabelName() Constraints: Not nullable, Maximum length: 40
FunctionalLocation	getFunctionalLocationOrFetch() Retrieval of associated FunctionalLocation entity (one to one).
protected Map<String,Object>	getKey()
String	getLanguage() Constraints: Not nullable, Maximum length: 2
String	getTextObjectKey() Constraints: Not nullable, Maximum length: 30
Class<FunctionalLocationLongText>	getType()
int	hashCode()
void	setFuncnlLocLongText(String funcnlLocLongText) Constraints: none
void	setFunctionalLocation(FunctionalLocation value) Overwrites the associated FunctionalLocation entity for the loaded navigation property to_FunctionalLocation.
void	setFunctionalLocation(String functionalLocation) (Key Field) Constraints: Not nullable, Maximum length: 30
void	setFunctionalLocationLabelName(String functionalLocationLabelName) Constraints: Not nullable, Maximum length: 40
void	setLanguage(String language) Constraints: Not nullable, Maximum length: 2
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setTextObjectKey(String textObjectKey) Constraints: Not nullable, Maximum length: 30
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 FunctionalLocationLongTextSelectable ALL_FIELDS

Selector for all available fields of FunctionalLocationLongText.

FUNCTIONAL_LOCATION

public static final FunctionalLocationLongTextField<String> FUNCTIONAL_LOCATION

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

FUNCTIONAL_LOCATION_LABEL_NAME

public static final FunctionalLocationLongTextField<String> FUNCTIONAL_LOCATION_LABEL_NAME

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

TEXT_OBJECT_KEY

public static final FunctionalLocationLongTextField<String> TEXT_OBJECT_KEY

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

LANGUAGE

public static final FunctionalLocationLongTextField<String> LANGUAGE

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

FUNCNL_LOC_LONG_TEXT

public static final FunctionalLocationLongTextField<String> FUNCNL_LOC_LONG_TEXT

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

TO_FUNCTIONAL_LOCATION

public static final FunctionalLocationLongTextOneToOneLink<FunctionalLocation> TO_FUNCTIONAL_LOCATION

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

Constructor Detail

FunctionalLocationLongText

public FunctionalLocationLongText()

FunctionalLocationLongText

public FunctionalLocationLongText(@Nullable
                                  String functionalLocation,
                                  @Nullable
                                  String functionalLocationLabelName,
                                  @Nullable
                                  String textObjectKey,
                                  @Nullable
                                  String language,
                                  @Nullable
                                  String funcnlLocLongText,
                                  @Nullable
                                  FunctionalLocation toFunctionalLocation)

Method Detail

getType

@Nonnull
public Class<FunctionalLocationLongText> getType()

Specified by:

getType in class VdmObject<FunctionalLocationLongText>

Returns:

The class of this object.

setFunctionalLocation

public void setFunctionalLocation(@Nullable
                                  String functionalLocation)

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

Original property name from the Odata EDM: FunctionalLocation

Parameters:

functionalLocation - Label that uniquely identifies a funtional location.

setFunctionalLocationLabelName

public void setFunctionalLocationLabelName(@Nullable
                                           String functionalLocationLabelName)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: FunctionalLocationLabelName

The functional location label can be changed where necessary. The system then automatically creates a labeling history and prevents historical labels from being reused without this first being checked. The labeling history also enables the interpretation of historical location labels in non-changeable documents outside the SAP System.You can assign one primary and several alternative labels to a functional location.

Parameters:

functionalLocationLabelName - The label is used to identify a functional location from a user's point of view.

setTextObjectKey

public void setTextObjectKey(@Nullable
                             String textObjectKey)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: TextObjectKey

Parameters:

textObjectKey - Label that uniquely identifies a funtional location.

setLanguage

public void setLanguage(@Nullable
                        String language)

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Parameters:

language - The language key indicates

setFuncnlLocLongText

public void setFuncnlLocLongText(@Nullable
                                 String funcnlLocLongText)

Constraints: none

Original property name from the Odata EDM: FuncnlLocLongText

Parameters:

funcnlLocLongText - Long Text

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<FunctionalLocationLongText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<FunctionalLocationLongText>

fromMap

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

Overrides:

fromMap in class VdmObject<FunctionalLocationLongText>

field

@Nonnull
public static <T> FunctionalLocationLongTextField<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> FunctionalLocationLongTextField<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). New destination to apply to this entity

Overrides:

getDestinationForFetch in class VdmEntity<FunctionalLocationLongText>

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

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

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

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

fetchFunctionalLocation

@Nullable
public FunctionalLocation fetchFunctionalLocation()
                                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getFunctionalLocationOrFetch

@Nullable
public FunctionalLocation getFunctionalLocationOrFetch()
                                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated FunctionalLocation entity (one to one). This corresponds to the OData navigation property to_FunctionalLocation.

If the navigation property to_FunctionalLocation of a queried FunctionalLocationLongText 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 FunctionalLocation 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.

getFunctionalLocationIfPresent

@Nonnull
public io.vavr.control.Option<FunctionalLocation> getFunctionalLocationIfPresent()

Retrieval of associated FunctionalLocation entity (one to one). This corresponds to the OData navigation property to_FunctionalLocation.

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

setFunctionalLocation

public void setFunctionalLocation(FunctionalLocation value)

Overwrites the associated FunctionalLocation entity for the loaded navigation property to_FunctionalLocation.

Parameters:

value - New FunctionalLocation entity.

builder

@Nonnull
public static FunctionalLocationLongText.FunctionalLocationLongTextBuilder builder()

getFunctionalLocation

@Nullable
public String getFunctionalLocation()

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

Original property name from the Odata EDM: FunctionalLocation

Returns:

Label that uniquely identifies a funtional location.

getFunctionalLocationLabelName

@Nullable
public String getFunctionalLocationLabelName()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: FunctionalLocationLabelName

The functional location label can be changed where necessary. The system then automatically creates a labeling history and prevents historical labels from being reused without this first being checked. The labeling history also enables the interpretation of historical location labels in non-changeable documents outside the SAP System.You can assign one primary and several alternative labels to a functional location.

Returns:

The label is used to identify a functional location from a user's point of view.

getTextObjectKey

@Nullable
public String getTextObjectKey()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: TextObjectKey

Returns:

Label that uniquely identifies a funtional location.

getLanguage

@Nullable
public String getLanguage()

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Returns:

The language key indicates

getFuncnlLocLongText

@Nullable
public String getFuncnlLocLongText()

Constraints: none

Original property name from the Odata EDM: FuncnlLocLongText

Returns:

Long Text

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<FunctionalLocationLongText>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<FunctionalLocationLongText>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<FunctionalLocationLongText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<FunctionalLocationLongText>