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

Class ServiceQtanItemRefObject

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.servicequotation.ServiceQtanItemRefObject

public class ServiceQtanItemRefObject
extends VdmEntity<ServiceQtanItemRefObject>

Service Quotation Item Reference Object API

Original entity name from the Odata EDM: A_ServiceQtanItemRefObjectType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ServiceQtanItemRefObjectSelectable	ALL_FIELDS Selector for all available fields of ServiceQtanItemRefObject.
static ServiceQtanItemRefObjectField<String>	SERVICE_QUOTATION Use with available fluent helpers to apply the ServiceQuotation field to query operations.
static ServiceQtanItemRefObjectField<String>	SERVICE_QUOTATION_ITEM Use with available fluent helpers to apply the ServiceQuotationItem field to query operations.
static ServiceQtanItemRefObjectField<String>	SERVICE_REF_FUNCTIONAL_LOCATION Use with available fluent helpers to apply the ServiceRefFunctionalLocation field to query operations.
static ServiceQtanItemRefObjectField<String>	SERVICE_REFERENCE_EQUIPMENT Use with available fluent helpers to apply the ServiceReferenceEquipment field to query operations.
static ServiceQtanItemRefObjectField<Boolean>	SRVC_REF_OBJ_IS_MAIN_OBJECT Use with available fluent helpers to apply the SrvcRefObjIsMainObject field to query operations.
static ServiceQtanItemRefObjectOneToOneLink<ServiceQuotation>	TO_SERVICE_QUOTATION Use with available fluent helpers to apply the to_ServiceQuotation navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
ServiceQtanItemRefObject()
ServiceQtanItemRefObject(String serviceQuotation, String serviceQuotationItem, String serviceReferenceEquipment, String serviceRefFunctionalLocation, Boolean srvcRefObjIsMainObject, ServiceQuotation toServiceQuotation)

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 ServiceQtanItemRefObject.ServiceQtanItemRefObjectBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ServiceQuotation	fetchServiceQuotation() Fetches the ServiceQuotation entity (one to one) associated with this entity.
static <T> ServiceQtanItemRefObjectField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ServiceQtanItemRefObjectField<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.
protected Map<String,Object>	getKey()
String	getServiceQuotation() (Key Field) Constraints: Not nullable, Maximum length: 10
io.vavr.control.Option<ServiceQuotation>	getServiceQuotationIfPresent() Retrieval of associated ServiceQuotation entity (one to one).
String	getServiceQuotationItem() (Key Field) Constraints: Not nullable, Maximum length: 6
ServiceQuotation	getServiceQuotationOrFetch() Retrieval of associated ServiceQuotation entity (one to one).
String	getServiceReferenceEquipment() (Key Field) Constraints: Not nullable, Maximum length: 18
String	getServiceRefFunctionalLocation() (Key Field) Constraints: Not nullable, Maximum length: 40
Boolean	getSrvcRefObjIsMainObject() Constraints: none
Class<ServiceQtanItemRefObject>	getType()
int	hashCode()
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setServiceQuotation(ServiceQuotation value) Overwrites the associated ServiceQuotation entity for the loaded navigation property to_ServiceQuotation.
void	setServiceQuotation(String serviceQuotation) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setServiceQuotationItem(String serviceQuotationItem) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setServiceReferenceEquipment(String serviceReferenceEquipment) (Key Field) Constraints: Not nullable, Maximum length: 18
void	setServiceRefFunctionalLocation(String serviceRefFunctionalLocation) (Key Field) Constraints: Not nullable, Maximum length: 40
void	setSrvcRefObjIsMainObject(Boolean srvcRefObjIsMainObject) Constraints: none
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 ServiceQtanItemRefObjectSelectable ALL_FIELDS

Selector for all available fields of ServiceQtanItemRefObject.

SERVICE_QUOTATION

public static final ServiceQtanItemRefObjectField<String> SERVICE_QUOTATION

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

SERVICE_QUOTATION_ITEM

public static final ServiceQtanItemRefObjectField<String> SERVICE_QUOTATION_ITEM

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

SERVICE_REFERENCE_EQUIPMENT

public static final ServiceQtanItemRefObjectField<String> SERVICE_REFERENCE_EQUIPMENT

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

SERVICE_REF_FUNCTIONAL_LOCATION

public static final ServiceQtanItemRefObjectField<String> SERVICE_REF_FUNCTIONAL_LOCATION

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

SRVC_REF_OBJ_IS_MAIN_OBJECT

public static final ServiceQtanItemRefObjectField<Boolean> SRVC_REF_OBJ_IS_MAIN_OBJECT

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

TO_SERVICE_QUOTATION

public static final ServiceQtanItemRefObjectOneToOneLink<ServiceQuotation> TO_SERVICE_QUOTATION

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

Constructor Detail

ServiceQtanItemRefObject

public ServiceQtanItemRefObject()

ServiceQtanItemRefObject

public ServiceQtanItemRefObject(@Nullable
                                String serviceQuotation,
                                @Nullable
                                String serviceQuotationItem,
                                @Nullable
                                String serviceReferenceEquipment,
                                @Nullable
                                String serviceRefFunctionalLocation,
                                @Nullable
                                Boolean srvcRefObjIsMainObject,
                                @Nullable
                                ServiceQuotation toServiceQuotation)

Method Detail

getType

@Nonnull
public Class<ServiceQtanItemRefObject> getType()

Specified by:

getType in class VdmObject<ServiceQtanItemRefObject>

Returns:

The class of this object.

setServiceQuotation

public void setServiceQuotation(@Nullable
                                String serviceQuotation)

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

Original property name from the Odata EDM: ServiceQuotation

Parameters:

serviceQuotation - Number that identifies the transaction document. It is unique for each business transaction category.

setServiceQuotationItem

public void setServiceQuotationItem(@Nullable
                                    String serviceQuotationItem)

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

Original property name from the Odata EDM: ServiceQuotationItem

Parameters:

serviceQuotationItem - Shortened Item Number in Document

setServiceReferenceEquipment

public void setServiceReferenceEquipment(@Nullable
                                         String serviceReferenceEquipment)

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

Original property name from the Odata EDM: ServiceReferenceEquipment

Parameters:

serviceReferenceEquipment - Number by which a piece of equipment can be clearly identified.

setServiceRefFunctionalLocation

public void setServiceRefFunctionalLocation(@Nullable
                                            String serviceRefFunctionalLocation)

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

Original property name from the Odata EDM: ServiceRefFunctionalLocation

If alternative labels exist for a functional location, you can define in your user profile which label should be displayed in this field.

Parameters:

serviceRefFunctionalLocation - Label that uniquely identifies a functional location.

setSrvcRefObjIsMainObject

public void setSrvcRefObjIsMainObject(@Nullable
                                      Boolean srvcRefObjIsMainObject)

Constraints: none

Original property name from the Odata EDM: SrvcRefObjIsMainObject

Parameters:

srvcRefObjIsMainObject - Main Reference Object

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<ServiceQtanItemRefObject>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ServiceQtanItemRefObject>

fromMap

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

Overrides:

fromMap in class VdmObject<ServiceQtanItemRefObject>

field

@Nonnull
public static <T> ServiceQtanItemRefObjectField<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> ServiceQtanItemRefObjectField<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<ServiceQtanItemRefObject>

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

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

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

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

fetchServiceQuotation

@Nullable
public ServiceQuotation fetchServiceQuotation()
                                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getServiceQuotationOrFetch

@Nullable
public ServiceQuotation getServiceQuotationOrFetch()
                                                      throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated ServiceQuotation entity (one to one). This corresponds to the OData navigation property to_ServiceQuotation.

If the navigation property to_ServiceQuotation of a queried ServiceQtanItemRefObject 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 ServiceQuotation 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.

getServiceQuotationIfPresent

@Nonnull
public io.vavr.control.Option<ServiceQuotation> getServiceQuotationIfPresent()

Retrieval of associated ServiceQuotation entity (one to one). This corresponds to the OData navigation property to_ServiceQuotation.

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

setServiceQuotation

public void setServiceQuotation(ServiceQuotation value)

Overwrites the associated ServiceQuotation entity for the loaded navigation property to_ServiceQuotation.

Parameters:

value - New ServiceQuotation entity.

builder

public static ServiceQtanItemRefObject.ServiceQtanItemRefObjectBuilder builder()

getServiceQuotation

@Nullable
public String getServiceQuotation()

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

Original property name from the Odata EDM: ServiceQuotation

Returns:

Number that identifies the transaction document. It is unique for each business transaction category.

getServiceQuotationItem

@Nullable
public String getServiceQuotationItem()

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

Original property name from the Odata EDM: ServiceQuotationItem

Returns:

Shortened Item Number in Document

getServiceReferenceEquipment

@Nullable
public String getServiceReferenceEquipment()

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

Original property name from the Odata EDM: ServiceReferenceEquipment

Returns:

Number by which a piece of equipment can be clearly identified.

getServiceRefFunctionalLocation

@Nullable
public String getServiceRefFunctionalLocation()

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

Original property name from the Odata EDM: ServiceRefFunctionalLocation

If alternative labels exist for a functional location, you can define in your user profile which label should be displayed in this field.

Returns:

Label that uniquely identifies a functional location.

getSrvcRefObjIsMainObject

@Nullable
public Boolean getSrvcRefObjIsMainObject()

Constraints: none

Original property name from the Odata EDM: SrvcRefObjIsMainObject

Returns:

Main Reference Object

toString

public String toString()

Overrides:

toString in class VdmObject<ServiceQtanItemRefObject>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<ServiceQtanItemRefObject>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<ServiceQtanItemRefObject>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ServiceQtanItemRefObject>