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

Class FunctionalLocationWarranty

java.lang.Object

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

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

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

public class FunctionalLocationWarranty
extends VdmEntity<FunctionalLocationWarranty>

Functional Location Warranty

Original entity name from the Odata EDM: FunctionalLocationWarrantyType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static FunctionalLocationWarrantySelectable	ALL_FIELDS Selector for all available fields of FunctionalLocationWarranty.
static FunctionalLocationWarrantyField<String>	FUNCTIONAL_LOCATION Use with available fluent helpers to apply the FunctionalLocation field to query operations.
static FunctionalLocationWarrantyField<String>	FUNCTIONAL_LOCATION_LABEL_NAME Use with available fluent helpers to apply the FunctionalLocationLabelName field to query operations.
static FunctionalLocationWarrantyField<String>	MASTER_WARRANTY Use with available fluent helpers to apply the MasterWarranty field to query operations.
static FunctionalLocationWarrantyOneToOneLink<FunctionalLocation>	TO_FUNCTIONAL_LOCATION Use with available fluent helpers to apply the to_FunctionalLocation navigation property to query operations.
static FunctionalLocationWarrantyField<LocalDateTime>	WARRANTY_END_DATE Use with available fluent helpers to apply the WarrantyEndDate field to query operations.
static FunctionalLocationWarrantyField<LocalDateTime>	WARRANTY_START_DATE Use with available fluent helpers to apply the WarrantyStartDate field to query operations.
static FunctionalLocationWarrantyField<String>	WARRANTY_TYPE Use with available fluent helpers to apply the WarrantyType field to query operations.
static FunctionalLocationWarrantyField<String>	WRNTY_IS_INHTD_FROM_SUPERIOR_OBJECT Use with available fluent helpers to apply the WrntyIsInhtdFromSuperiorObject field to query operations.
static FunctionalLocationWarrantyField<String>	WRNTY_IS_PASSED_ON_TO_CHILD_OBJECT Use with available fluent helpers to apply the WrntyIsPassedOnToChildObject field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
FunctionalLocationWarranty()
FunctionalLocationWarranty(String functionalLocation, String warrantyType, String functionalLocationLabelName, String masterWarranty, LocalDateTime warrantyStartDate, LocalDateTime warrantyEndDate, String wrntyIsInhtdFromSuperiorObject, String wrntyIsPassedOnToChildObject, 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 FunctionalLocationWarranty.FunctionalLocationWarrantyBuilder	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> FunctionalLocationWarrantyField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> FunctionalLocationWarrantyField<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	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	getMasterWarranty() Constraints: Not nullable, Maximum length: 20
Class<FunctionalLocationWarranty>	getType()
LocalDateTime	getWarrantyEndDate() Constraints: Not nullable, Precision: 0
LocalDateTime	getWarrantyStartDate() Constraints: Not nullable, Precision: 0
String	getWarrantyType() (Key Field) Constraints: Not nullable, Maximum length: 1
String	getWrntyIsInhtdFromSuperiorObject() Constraints: Not nullable, Maximum length: 1
String	getWrntyIsPassedOnToChildObject() Constraints: Not nullable, Maximum length: 1
int	hashCode()
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	setMasterWarranty(String masterWarranty) Constraints: Not nullable, Maximum length: 20
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setWarrantyEndDate(LocalDateTime warrantyEndDate) Constraints: Not nullable, Precision: 0
void	setWarrantyStartDate(LocalDateTime warrantyStartDate) Constraints: Not nullable, Precision: 0
void	setWarrantyType(String warrantyType) (Key Field) Constraints: Not nullable, Maximum length: 1
void	setWrntyIsInhtdFromSuperiorObject(String wrntyIsInhtdFromSuperiorObject) Constraints: Not nullable, Maximum length: 1
void	setWrntyIsPassedOnToChildObject(String wrntyIsPassedOnToChildObject) Constraints: Not nullable, Maximum length: 1
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 FunctionalLocationWarrantySelectable ALL_FIELDS

Selector for all available fields of FunctionalLocationWarranty.

FUNCTIONAL_LOCATION

public static final FunctionalLocationWarrantyField<String> FUNCTIONAL_LOCATION

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

WARRANTY_TYPE

public static final FunctionalLocationWarrantyField<String> WARRANTY_TYPE

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

FUNCTIONAL_LOCATION_LABEL_NAME

public static final FunctionalLocationWarrantyField<String> FUNCTIONAL_LOCATION_LABEL_NAME

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

MASTER_WARRANTY

public static final FunctionalLocationWarrantyField<String> MASTER_WARRANTY

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

WARRANTY_START_DATE

public static final FunctionalLocationWarrantyField<LocalDateTime> WARRANTY_START_DATE

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

WARRANTY_END_DATE

public static final FunctionalLocationWarrantyField<LocalDateTime> WARRANTY_END_DATE

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

WRNTY_IS_INHTD_FROM_SUPERIOR_OBJECT

public static final FunctionalLocationWarrantyField<String> WRNTY_IS_INHTD_FROM_SUPERIOR_OBJECT

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

WRNTY_IS_PASSED_ON_TO_CHILD_OBJECT

public static final FunctionalLocationWarrantyField<String> WRNTY_IS_PASSED_ON_TO_CHILD_OBJECT

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

TO_FUNCTIONAL_LOCATION

public static final FunctionalLocationWarrantyOneToOneLink<FunctionalLocation> TO_FUNCTIONAL_LOCATION

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

Constructor Detail

FunctionalLocationWarranty

public FunctionalLocationWarranty()

FunctionalLocationWarranty

public FunctionalLocationWarranty(@Nullable
                                  String functionalLocation,
                                  @Nullable
                                  String warrantyType,
                                  @Nullable
                                  String functionalLocationLabelName,
                                  @Nullable
                                  String masterWarranty,
                                  @Nullable
                                  LocalDateTime warrantyStartDate,
                                  @Nullable
                                  LocalDateTime warrantyEndDate,
                                  @Nullable
                                  String wrntyIsInhtdFromSuperiorObject,
                                  @Nullable
                                  String wrntyIsPassedOnToChildObject,
                                  @Nullable
                                  FunctionalLocation toFunctionalLocation)

Method Detail

getType

@Nonnull
public Class<FunctionalLocationWarranty> getType()

Specified by:

getType in class VdmObject<FunctionalLocationWarranty>

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.

setWarrantyType

public void setWarrantyType(@Nullable
                            String warrantyType)

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

Original property name from the Odata EDM: WarrantyType

Parameters:

warrantyType - Key that describes the warranty type. The warranty type is assigned to an internal warranty category that specifies whether you are the warrantee or the guarantor.

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.

setMasterWarranty

public void setMasterWarranty(@Nullable
                              String masterWarranty)

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: MasterWarranty

This number, which has a maximum of 20 digits, can be assigned both internally and externally, depending on the way the system is set up for your company.

Parameters:

masterWarranty - Displays the number of the master warranty.

setWarrantyStartDate

public void setWarrantyStartDate(@Nullable
                                 LocalDateTime warrantyStartDate)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: WarrantyStartDate

Normally, a warranty begins when the customer receives the goods. If delivery from your shipping point to the customer takes only a day or so, you can start the warranty period on the same day the goods are issued. In this case, leave the field blank. However, if delivery takes a longer time, enter a future date.

Parameters:

warrantyStartDate - The date that marks the beginning of a warranty period.

setWarrantyEndDate

public void setWarrantyEndDate(@Nullable
                               LocalDateTime warrantyEndDate)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: WarrantyEndDate

Parameters:

warrantyEndDate - Date on which the technical object's warranty/guarantee expires

setWrntyIsInhtdFromSuperiorObject

public void setWrntyIsInhtdFromSuperiorObject(@Nullable
                                              String wrntyIsInhtdFromSuperiorObject)

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: WrntyIsInhtdFromSuperiorObject

Parameters:

wrntyIsInhtdFromSuperiorObject - This indicator specifies whether the master warranty or the warranty period can or cannot be inherited from the next-highest technical object in the hiararchy. If the indicator is set, the inherited warranties and those belonging to the technical object are displayed during the warranty check. If the indicator is not set, only the warranties belonging to the technical object are displayed.

setWrntyIsPassedOnToChildObject

public void setWrntyIsPassedOnToChildObject(@Nullable
                                            String wrntyIsPassedOnToChildObject)

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: WrntyIsPassedOnToChildObject

Parameters:

wrntyIsPassedOnToChildObject - This indicator specifies whether the master warranty of the technical object should be passed on to the technical objects lower down in the hierarchy. When a warranty check of the lower technical object is performed, the technical object of the upper hierarchy level is also displayed. A maximum of two higher technical objects (a piece of equipment and a functional location) are displayed per warranty type.

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<FunctionalLocationWarranty>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<FunctionalLocationWarranty>

fromMap

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

Overrides:

fromMap in class VdmObject<FunctionalLocationWarranty>

field

@Nonnull
public static <T> FunctionalLocationWarrantyField<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> FunctionalLocationWarrantyField<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<FunctionalLocationWarranty>

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

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

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

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

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 FunctionalLocationWarranty 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 FunctionalLocationWarranty 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 FunctionalLocationWarranty.FunctionalLocationWarrantyBuilder 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.

getWarrantyType

@Nullable
public String getWarrantyType()

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

Original property name from the Odata EDM: WarrantyType

Returns:

Key that describes the warranty type. The warranty type is assigned to an internal warranty category that specifies whether you are the warrantee or the guarantor.

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.

getMasterWarranty

@Nullable
public String getMasterWarranty()

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: MasterWarranty

This number, which has a maximum of 20 digits, can be assigned both internally and externally, depending on the way the system is set up for your company.

Returns:

Displays the number of the master warranty.

getWarrantyStartDate

@Nullable
public LocalDateTime getWarrantyStartDate()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: WarrantyStartDate

Normally, a warranty begins when the customer receives the goods. If delivery from your shipping point to the customer takes only a day or so, you can start the warranty period on the same day the goods are issued. In this case, leave the field blank. However, if delivery takes a longer time, enter a future date.

Returns:

The date that marks the beginning of a warranty period.

getWarrantyEndDate

@Nullable
public LocalDateTime getWarrantyEndDate()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: WarrantyEndDate

Returns:

Date on which the technical object's warranty/guarantee expires

getWrntyIsInhtdFromSuperiorObject

@Nullable
public String getWrntyIsInhtdFromSuperiorObject()

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: WrntyIsInhtdFromSuperiorObject

Returns:

This indicator specifies whether the master warranty or the warranty period can or cannot be inherited from the next-highest technical object in the hiararchy. If the indicator is set, the inherited warranties and those belonging to the technical object are displayed during the warranty check. If the indicator is not set, only the warranties belonging to the technical object are displayed.

getWrntyIsPassedOnToChildObject

@Nullable
public String getWrntyIsPassedOnToChildObject()

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: WrntyIsPassedOnToChildObject

Returns:

This indicator specifies whether the master warranty of the technical object should be passed on to the technical objects lower down in the hierarchy. When a warranty check of the lower technical object is performed, the technical object of the upper hierarchy level is also displayed. A maximum of two higher technical objects (a piece of equipment and a functional location) are displayed per warranty type.

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<FunctionalLocationWarranty>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<FunctionalLocationWarranty>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<FunctionalLocationWarranty>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<FunctionalLocationWarranty>