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

Class ServiceContrItemObjectList

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.servicecontract.ServiceContrItemObjectList

public class ServiceContrItemObjectList
extends VdmEntity<ServiceContrItemObjectList>

Item Object List

Original entity name from the Odata EDM: A_ServiceContrItemObjectListType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ServiceContrItemObjectListSelectable	ALL_FIELDS Selector for all available fields of ServiceContrItemObjectList.
static ServiceContrItemObjectListField<String>	EQUIPMENT Use with available fluent helpers to apply the Equipment field to query operations.
static ServiceContrItemObjectListField<String>	PRODUCT Use with available fluent helpers to apply the Product field to query operations.
static ServiceContrItemObjectListField<String>	SERVICE_CONTRACT Use with available fluent helpers to apply the ServiceContract field to query operations.
static ServiceContrItemObjectListField<String>	SERVICE_CONTRACT_ITEM Use with available fluent helpers to apply the ServiceContractItem field to query operations.
static ServiceContrItemObjectListField<String>	SERVICE_REF_FUNCTIONAL_LOCATION Use with available fluent helpers to apply the ServiceRefFunctionalLocation field to query operations.
static ServiceContrItemObjectListField<String>	SERVICE_REF_OBJECT_SEQUENCE_NUMBER Use with available fluent helpers to apply the ServiceRefObjectSequenceNumber field to query operations.
static ServiceContrItemObjectListOneToOneLink<ServiceContractItem>	TO_SERVICE_CONTRACT_ITEM Use with available fluent helpers to apply the to_ServiceContractItem navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
ServiceContrItemObjectList()
ServiceContrItemObjectList(String serviceContract, String serviceContractItem, String serviceRefObjectSequenceNumber, String product, String equipment, String serviceRefFunctionalLocation, ServiceContractItem toServiceContractItem)

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 ServiceContrItemObjectList.ServiceContrItemObjectListBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ServiceContractItem	fetchServiceContractItem() Fetches the ServiceContractItem entity (one to one) associated with this entity.
static <T> ServiceContrItemObjectListField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ServiceContrItemObjectListField<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	getEquipment() Constraints: Not nullable, Maximum length: 18
protected Map<String,Object>	getKey()
String	getProduct() Constraints: Not nullable, Maximum length: 40
String	getServiceContract() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getServiceContractItem() (Key Field) Constraints: Not nullable, Maximum length: 6
io.vavr.control.Option<ServiceContractItem>	getServiceContractItemIfPresent() Retrieval of associated ServiceContractItem entity (one to one).
ServiceContractItem	getServiceContractItemOrFetch() Retrieval of associated ServiceContractItem entity (one to one).
String	getServiceRefFunctionalLocation() Constraints: Not nullable, Maximum length: 40
String	getServiceRefObjectSequenceNumber() (Key Field) Constraints: Not nullable, Maximum length: 8
Class<ServiceContrItemObjectList>	getType()
int	hashCode()
void	setEquipment(String equipment) Constraints: Not nullable, Maximum length: 18
void	setProduct(String product) Constraints: Not nullable, Maximum length: 40
void	setServiceContract(String serviceContract) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setServiceContractItem(ServiceContractItem value) Overwrites the associated ServiceContractItem entity for the loaded navigation property to_ServiceContractItem.
void	setServiceContractItem(String serviceContractItem) (Key Field) Constraints: Not nullable, Maximum length: 6
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setServiceRefFunctionalLocation(String serviceRefFunctionalLocation) Constraints: Not nullable, Maximum length: 40
void	setServiceRefObjectSequenceNumber(String serviceRefObjectSequenceNumber) (Key Field) Constraints: Not nullable, Maximum length: 8
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 ServiceContrItemObjectListSelectable ALL_FIELDS

Selector for all available fields of ServiceContrItemObjectList.

SERVICE_CONTRACT

public static final ServiceContrItemObjectListField<String> SERVICE_CONTRACT

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

SERVICE_CONTRACT_ITEM

public static final ServiceContrItemObjectListField<String> SERVICE_CONTRACT_ITEM

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

SERVICE_REF_OBJECT_SEQUENCE_NUMBER

public static final ServiceContrItemObjectListField<String> SERVICE_REF_OBJECT_SEQUENCE_NUMBER

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

PRODUCT

public static final ServiceContrItemObjectListField<String> PRODUCT

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

EQUIPMENT

public static final ServiceContrItemObjectListField<String> EQUIPMENT

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

SERVICE_REF_FUNCTIONAL_LOCATION

public static final ServiceContrItemObjectListField<String> SERVICE_REF_FUNCTIONAL_LOCATION

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

TO_SERVICE_CONTRACT_ITEM

public static final ServiceContrItemObjectListOneToOneLink<ServiceContractItem> TO_SERVICE_CONTRACT_ITEM

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

Constructor Detail

ServiceContrItemObjectList

public ServiceContrItemObjectList()

ServiceContrItemObjectList

public ServiceContrItemObjectList(@Nullable
                                  String serviceContract,
                                  @Nullable
                                  String serviceContractItem,
                                  @Nullable
                                  String serviceRefObjectSequenceNumber,
                                  @Nullable
                                  String product,
                                  @Nullable
                                  String equipment,
                                  @Nullable
                                  String serviceRefFunctionalLocation,
                                  @Nullable
                                  ServiceContractItem toServiceContractItem)

Method Detail

getType

@Nonnull
public Class<ServiceContrItemObjectList> getType()

Specified by:

getType in class VdmObject<ServiceContrItemObjectList>

Returns:

The class of this object.

setServiceContract

public void setServiceContract(@Nullable
                               String serviceContract)

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

Original property name from the Odata EDM: ServiceContract

Parameters:

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

setServiceContractItem

public void setServiceContractItem(@Nullable
                                   String serviceContractItem)

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

Original property name from the Odata EDM: ServiceContractItem

Parameters:

serviceContractItem - Shortened Item Number in Document

setServiceRefObjectSequenceNumber

public void setServiceRefObjectSequenceNumber(@Nullable
                                              String serviceRefObjectSequenceNumber)

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

Original property name from the Odata EDM: ServiceRefObjectSequenceNumber

Parameters:

serviceRefObjectSequenceNumber - Reference Object Counter

setProduct

public void setProduct(@Nullable
                       String product)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: Product

Parameters:

product - Alphanumeric key uniquely identifying the material.

setEquipment

public void setEquipment(@Nullable
                         String equipment)

Constraints: Not nullable, Maximum length: 18

Original property name from the Odata EDM: Equipment

Parameters:

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

setServiceRefFunctionalLocation

public void setServiceRefFunctionalLocation(@Nullable
                                            String serviceRefFunctionalLocation)

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.

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<ServiceContrItemObjectList>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ServiceContrItemObjectList>

fromMap

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

Overrides:

fromMap in class VdmObject<ServiceContrItemObjectList>

field

@Nonnull
public static <T> ServiceContrItemObjectListField<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> ServiceContrItemObjectListField<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<ServiceContrItemObjectList>

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

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

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

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

fetchServiceContractItem

@Nullable
public ServiceContractItem fetchServiceContractItem()
                                                       throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getServiceContractItemOrFetch

@Nullable
public ServiceContractItem getServiceContractItemOrFetch()
                                                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated ServiceContractItem entity (one to one). This corresponds to the OData navigation property to_ServiceContractItem.

If the navigation property to_ServiceContractItem of a queried ServiceContrItemObjectList 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 ServiceContractItem 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.

getServiceContractItemIfPresent

@Nonnull
public io.vavr.control.Option<ServiceContractItem> getServiceContractItemIfPresent()

Retrieval of associated ServiceContractItem entity (one to one). This corresponds to the OData navigation property to_ServiceContractItem.

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

setServiceContractItem

public void setServiceContractItem(ServiceContractItem value)

Overwrites the associated ServiceContractItem entity for the loaded navigation property to_ServiceContractItem.

Parameters:

value - New ServiceContractItem entity.

builder

@Nonnull
public static ServiceContrItemObjectList.ServiceContrItemObjectListBuilder builder()

getServiceContract

@Nullable
public String getServiceContract()

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

Original property name from the Odata EDM: ServiceContract

Returns:

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

getServiceContractItem

@Nullable
public String getServiceContractItem()

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

Original property name from the Odata EDM: ServiceContractItem

Returns:

Shortened Item Number in Document

getServiceRefObjectSequenceNumber

@Nullable
public String getServiceRefObjectSequenceNumber()

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

Original property name from the Odata EDM: ServiceRefObjectSequenceNumber

Returns:

Reference Object Counter

getProduct

@Nullable
public String getProduct()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: Product

Returns:

Alphanumeric key uniquely identifying the material.

getEquipment

@Nullable
public String getEquipment()

Constraints: Not nullable, Maximum length: 18

Original property name from the Odata EDM: Equipment

Returns:

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

getServiceRefFunctionalLocation

@Nullable
public String getServiceRefFunctionalLocation()

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.

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<ServiceContrItemObjectList>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<ServiceContrItemObjectList>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<ServiceContrItemObjectList>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ServiceContrItemObjectList>