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

Class EquipmentPartner

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.namespaces.equipment.EquipmentPartner

public class EquipmentPartner
extends VdmEntity<EquipmentPartner>

Equipment Partner Functions

Original entity name from the Odata EDM: EquipmentPartnerType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static EquipmentPartnerSelectable	ALL_FIELDS Selector for all available fields of EquipmentPartner.
static EquipmentPartnerField<String>	CREATED_BY_USER Use with available fluent helpers to apply the CreatedByUser field to query operations.
static EquipmentPartnerField<LocalDateTime>	CREATION_DATE Use with available fluent helpers to apply the CreationDate field to query operations.
static EquipmentPartnerField<String>	EQUIPMENT Use with available fluent helpers to apply the Equipment field to query operations.
static EquipmentPartnerField<String>	EQUIPMENT_PARTNER_OBJECT_NMBR Use with available fluent helpers to apply the EquipmentPartnerObjectNmbr field to query operations.
static EquipmentPartnerField<String>	PARTNER Use with available fluent helpers to apply the Partner field to query operations.
static EquipmentPartnerField<String>	PARTNER_FUNCTION Use with available fluent helpers to apply the PartnerFunction field to query operations.
static EquipmentPartnerOneToOneLink<Equipment>	TO_EQUIPMENT Use with available fluent helpers to apply the to_Equipment navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
EquipmentPartner()
EquipmentPartner(String equipment, String partnerFunction, String equipmentPartnerObjectNmbr, String partner, String createdByUser, LocalDateTime creationDate, Equipment toEquipment)

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 EquipmentPartner.EquipmentPartnerBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Equipment	fetchEquipment() Fetches the Equipment entity (one to one) associated with this entity.
static <T> EquipmentPartnerField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> EquipmentPartnerField<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	getCreatedByUser() Constraints: Not nullable, Maximum length: 12
LocalDateTime	getCreationDate() Constraints: Not nullable, Precision: 0
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	getEquipment() (Key Field) Constraints: Not nullable, Maximum length: 18
io.vavr.control.Option<Equipment>	getEquipmentIfPresent() Retrieval of associated Equipment entity (one to one).
Equipment	getEquipmentOrFetch() Retrieval of associated Equipment entity (one to one).
String	getEquipmentPartnerObjectNmbr() (Key Field) Constraints: Not nullable, Maximum length: 6
protected Map<String,Object>	getKey()
String	getPartner() Constraints: Not nullable, Maximum length: 12
String	getPartnerFunction() (Key Field) Constraints: Not nullable, Maximum length: 2
Class<EquipmentPartner>	getType()
int	hashCode()
void	setCreatedByUser(String createdByUser) Constraints: Not nullable, Maximum length: 12
void	setCreationDate(LocalDateTime creationDate) Constraints: Not nullable, Precision: 0
void	setEquipment(Equipment value) Overwrites the associated Equipment entity for the loaded navigation property to_Equipment.
void	setEquipment(String equipment) (Key Field) Constraints: Not nullable, Maximum length: 18
void	setEquipmentPartnerObjectNmbr(String equipmentPartnerObjectNmbr) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setPartner(String partner) Constraints: Not nullable, Maximum length: 12
void	setPartnerFunction(String partnerFunction) (Key Field) Constraints: Not nullable, Maximum length: 2
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 EquipmentPartnerSelectable ALL_FIELDS

Selector for all available fields of EquipmentPartner.

EQUIPMENT

public static final EquipmentPartnerField<String> EQUIPMENT

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

PARTNER_FUNCTION

public static final EquipmentPartnerField<String> PARTNER_FUNCTION

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

EQUIPMENT_PARTNER_OBJECT_NMBR

public static final EquipmentPartnerField<String> EQUIPMENT_PARTNER_OBJECT_NMBR

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

PARTNER

public static final EquipmentPartnerField<String> PARTNER

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

CREATED_BY_USER

public static final EquipmentPartnerField<String> CREATED_BY_USER

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

CREATION_DATE

public static final EquipmentPartnerField<LocalDateTime> CREATION_DATE

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

TO_EQUIPMENT

public static final EquipmentPartnerOneToOneLink<Equipment> TO_EQUIPMENT

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

Constructor Detail

EquipmentPartner

public EquipmentPartner()

EquipmentPartner

public EquipmentPartner(@Nullable
                        String equipment,
                        @Nullable
                        String partnerFunction,
                        @Nullable
                        String equipmentPartnerObjectNmbr,
                        @Nullable
                        String partner,
                        @Nullable
                        String createdByUser,
                        @Nullable
                        LocalDateTime creationDate,
                        @Nullable
                        Equipment toEquipment)

Method Detail

getType

@Nonnull
public Class<EquipmentPartner> getType()

Specified by:

getType in class VdmObject<EquipmentPartner>

Returns:

The class of this object.

setEquipment

public void setEquipment(@Nullable
                         String equipment)

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

Original property name from the Odata EDM: Equipment

Parameters:

equipment - Equipment Number

setPartnerFunction

public void setPartnerFunction(@Nullable
                               String partnerFunction)

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

Original property name from the Odata EDM: PartnerFunction

Parameters:

partnerFunction - Partner Function (Not Converted)

setEquipmentPartnerObjectNmbr

public void setEquipmentPartnerObjectNmbr(@Nullable
                                          String equipmentPartnerObjectNmbr)

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

Original property name from the Odata EDM: EquipmentPartnerObjectNmbr

Parameters:

equipmentPartnerObjectNmbr - Counter for differentiation 6-digit

setPartner

public void setPartner(@Nullable
                       String partner)

Constraints: Not nullable, Maximum length: 12

Original property name from the Odata EDM: Partner

Parameters:

partner - Partner

setCreatedByUser

public void setCreatedByUser(@Nullable
                             String createdByUser)

Constraints: Not nullable, Maximum length: 12

Original property name from the Odata EDM: CreatedByUser

Parameters:

createdByUser - Name of Person Who Created Object

setCreationDate

public void setCreationDate(@Nullable
                            LocalDateTime creationDate)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: CreationDate

Parameters:

creationDate - Date on which the record was created

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<EquipmentPartner>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<EquipmentPartner>

fromMap

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

Overrides:

fromMap in class VdmObject<EquipmentPartner>

field

@Nonnull
public static <T> EquipmentPartnerField<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> EquipmentPartnerField<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<EquipmentPartner>

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

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

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

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

fetchEquipment

@Nullable
public Equipment fetchEquipment()
                                   throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getEquipmentOrFetch

@Nullable
public Equipment getEquipmentOrFetch()
                                        throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated Equipment entity (one to one). This corresponds to the OData navigation property to_Equipment.

If the navigation property to_Equipment of a queried EquipmentPartner 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 Equipment 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.

getEquipmentIfPresent

@Nonnull
public io.vavr.control.Option<Equipment> getEquipmentIfPresent()

Retrieval of associated Equipment entity (one to one). This corresponds to the OData navigation property to_Equipment.

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

setEquipment

public void setEquipment(Equipment value)

Overwrites the associated Equipment entity for the loaded navigation property to_Equipment.

Parameters:

value - New Equipment entity.

builder

@Nonnull
public static EquipmentPartner.EquipmentPartnerBuilder builder()

getEquipment

@Nullable
public String getEquipment()

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

Original property name from the Odata EDM: Equipment

Returns:

Equipment Number

getPartnerFunction

@Nullable
public String getPartnerFunction()

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

Original property name from the Odata EDM: PartnerFunction

Returns:

Partner Function (Not Converted)

getEquipmentPartnerObjectNmbr

@Nullable
public String getEquipmentPartnerObjectNmbr()

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

Original property name from the Odata EDM: EquipmentPartnerObjectNmbr

Returns:

Counter for differentiation 6-digit

getPartner

@Nullable
public String getPartner()

Constraints: Not nullable, Maximum length: 12

Original property name from the Odata EDM: Partner

Returns:

Partner

getCreatedByUser

@Nullable
public String getCreatedByUser()

Constraints: Not nullable, Maximum length: 12

Original property name from the Odata EDM: CreatedByUser

Returns:

Name of Person Who Created Object

getCreationDate

@Nullable
public LocalDateTime getCreationDate()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: CreationDate

Returns:

Date on which the record was created

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<EquipmentPartner>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<EquipmentPartner>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<EquipmentPartner>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<EquipmentPartner>