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

Class SpecificationPhraseItem

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.namespaces.specificationphrase.SpecificationPhraseItem

public class SpecificationPhraseItem
extends VdmEntity<SpecificationPhraseItem>

Specification Phrase Item

Original entity name from the Odata EDM: SpecificationPhraseItemType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static SpecificationPhraseItemSelectable	ALL_FIELDS Selector for all available fields of SpecificationPhraseItem.
static SpecificationPhraseItemField<String>	SPEC_PHRASE_INTERNAL_ID Use with available fluent helpers to apply the SpecPhraseInternalID field to query operations.
static SpecificationPhraseItemField<LocalDateTime>	SPEC_PHRASE_ITEM_CHANGE_DATE Use with available fluent helpers to apply the SpecPhraseItemChangeDate field to query operations.
static SpecificationPhraseItemField<String>	SPEC_PHRASE_ITEM_CHG_INT_ID Use with available fluent helpers to apply the SpecPhraseItemChgIntID field to query operations.
static SpecificationPhraseItemField<String>	SPEC_PHRASE_ITEM_CODE Use with available fluent helpers to apply the SpecPhraseItemCode field to query operations.
static SpecificationPhraseItemField<String>	SPEC_PHRASE_ITEM_INTERNAL_ID Use with available fluent helpers to apply the SpecPhraseItemInternalID field to query operations.
static SpecificationPhraseItemField<Boolean>	SPEC_PHRASE_ITEM_IS_DELETED Use with available fluent helpers to apply the SpecPhraseItemIsDeleted field to query operations.
static SpecificationPhraseItemField<String>	SPEC_PHRASE_ITEM_LANGUAGE Use with available fluent helpers to apply the SpecPhraseItemLanguage field to query operations.
static SpecificationPhraseItemField<String>	SPEC_PHRASE_ITEM_STATUS Use with available fluent helpers to apply the SpecPhraseItemStatus field to query operations.
static SpecificationPhraseItemField<String>	SPEC_PHRASE_ITEM_TEXT Use with available fluent helpers to apply the SpecPhraseItemText field to query operations.
static SpecificationPhraseItemLink<SpecificationPhrase>	TO_SPECIFICATION_PHRASE Use with available fluent helpers to apply the to_SpecificationPhrase navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
SpecificationPhraseItem()
SpecificationPhraseItem(String specPhraseItemInternalID, String specPhraseItemChgIntID, String specPhraseInternalID, String specPhraseItemStatus, String specPhraseItemCode, Boolean specPhraseItemIsDeleted, LocalDateTime specPhraseItemChangeDate, String specPhraseItemLanguage, String specPhraseItemText, List<SpecificationPhrase> toSpecificationPhrase)

Method Summary

Modifier and Type	Method and Description
void	addSpecificationPhrase(SpecificationPhrase... entity) Adds elements to the list of associated SpecificationPhrase entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static SpecificationPhraseItem.SpecificationPhraseItemBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<SpecificationPhrase>	fetchSpecificationPhrase() Fetches the SpecificationPhrase entities (one to many) associated with this entity.
static <T> SpecificationPhraseItemField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SpecificationPhraseItemField<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()
io.vavr.control.Option<List<SpecificationPhrase>>	getSpecificationPhraseIfPresent() Retrieval of associated SpecificationPhrase entities (one to many).
List<SpecificationPhrase>	getSpecificationPhraseOrFetch() Retrieval of associated SpecificationPhrase entities (one to many).
String	getSpecPhraseInternalID() Constraints: Not nullable, Maximum length: 20
LocalDateTime	getSpecPhraseItemChangeDate() Constraints: Not nullable, Precision: 0
String	getSpecPhraseItemChgIntID() (Key Field) Constraints: Not nullable, Maximum length: 20
String	getSpecPhraseItemCode() Constraints: Not nullable, Maximum length: 40
String	getSpecPhraseItemInternalID() (Key Field) Constraints: Not nullable, Maximum length: 20
Boolean	getSpecPhraseItemIsDeleted() Constraints: none
String	getSpecPhraseItemLanguage() Constraints: Not nullable, Maximum length: 2
String	getSpecPhraseItemStatus() Constraints: Not nullable, Maximum length: 5
String	getSpecPhraseItemText() Constraints: Not nullable, Maximum length: 132
Class<SpecificationPhraseItem>	getType()
int	hashCode()
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setSpecificationPhrase(List<SpecificationPhrase> value) Overwrites the list of associated SpecificationPhrase entities for the loaded navigation property to_SpecificationPhrase.
void	setSpecPhraseInternalID(String specPhraseInternalID) Constraints: Not nullable, Maximum length: 20
void	setSpecPhraseItemChangeDate(LocalDateTime specPhraseItemChangeDate) Constraints: Not nullable, Precision: 0
void	setSpecPhraseItemChgIntID(String specPhraseItemChgIntID) (Key Field) Constraints: Not nullable, Maximum length: 20
void	setSpecPhraseItemCode(String specPhraseItemCode) Constraints: Not nullable, Maximum length: 40
void	setSpecPhraseItemInternalID(String specPhraseItemInternalID) (Key Field) Constraints: Not nullable, Maximum length: 20
void	setSpecPhraseItemIsDeleted(Boolean specPhraseItemIsDeleted) Constraints: none
void	setSpecPhraseItemLanguage(String specPhraseItemLanguage) Constraints: Not nullable, Maximum length: 2
void	setSpecPhraseItemStatus(String specPhraseItemStatus) Constraints: Not nullable, Maximum length: 5
void	setSpecPhraseItemText(String specPhraseItemText) Constraints: Not nullable, Maximum length: 132
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 SpecificationPhraseItemSelectable ALL_FIELDS

Selector for all available fields of SpecificationPhraseItem.

SPEC_PHRASE_ITEM_INTERNAL_ID

public static final SpecificationPhraseItemField<String> SPEC_PHRASE_ITEM_INTERNAL_ID

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

SPEC_PHRASE_ITEM_CHG_INT_ID

public static final SpecificationPhraseItemField<String> SPEC_PHRASE_ITEM_CHG_INT_ID

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

SPEC_PHRASE_INTERNAL_ID

public static final SpecificationPhraseItemField<String> SPEC_PHRASE_INTERNAL_ID

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

SPEC_PHRASE_ITEM_STATUS

public static final SpecificationPhraseItemField<String> SPEC_PHRASE_ITEM_STATUS

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

SPEC_PHRASE_ITEM_CODE

public static final SpecificationPhraseItemField<String> SPEC_PHRASE_ITEM_CODE

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

SPEC_PHRASE_ITEM_IS_DELETED

public static final SpecificationPhraseItemField<Boolean> SPEC_PHRASE_ITEM_IS_DELETED

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

SPEC_PHRASE_ITEM_CHANGE_DATE

public static final SpecificationPhraseItemField<LocalDateTime> SPEC_PHRASE_ITEM_CHANGE_DATE

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

SPEC_PHRASE_ITEM_LANGUAGE

public static final SpecificationPhraseItemField<String> SPEC_PHRASE_ITEM_LANGUAGE

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

SPEC_PHRASE_ITEM_TEXT

public static final SpecificationPhraseItemField<String> SPEC_PHRASE_ITEM_TEXT

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

TO_SPECIFICATION_PHRASE

public static final SpecificationPhraseItemLink<SpecificationPhrase> TO_SPECIFICATION_PHRASE

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

Constructor Detail

SpecificationPhraseItem

public SpecificationPhraseItem()

SpecificationPhraseItem

public SpecificationPhraseItem(@Nullable
                               String specPhraseItemInternalID,
                               @Nullable
                               String specPhraseItemChgIntID,
                               @Nullable
                               String specPhraseInternalID,
                               @Nullable
                               String specPhraseItemStatus,
                               @Nullable
                               String specPhraseItemCode,
                               @Nullable
                               Boolean specPhraseItemIsDeleted,
                               @Nullable
                               LocalDateTime specPhraseItemChangeDate,
                               @Nullable
                               String specPhraseItemLanguage,
                               @Nullable
                               String specPhraseItemText,
                               List<SpecificationPhrase> toSpecificationPhrase)

Method Detail

getType

@Nonnull
public Class<SpecificationPhraseItem> getType()

Specified by:

getType in class VdmObject<SpecificationPhraseItem>

Returns:

The class of this object.

setSpecPhraseItemInternalID

public void setSpecPhraseItemInternalID(@Nullable
                                        String specPhraseItemInternalID)

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

Original property name from the Odata EDM: SpecPhraseItemInternalID

Parameters:

specPhraseItemInternalID - Phrase Item Internal ID

setSpecPhraseItemChgIntID

public void setSpecPhraseItemChgIntID(@Nullable
                                      String specPhraseItemChgIntID)

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

Original property name from the Odata EDM: SpecPhraseItemChgIntID

Parameters:

specPhraseItemChgIntID - Phrase Item Change State

setSpecPhraseInternalID

public void setSpecPhraseInternalID(@Nullable
                                    String specPhraseInternalID)

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: SpecPhraseInternalID

Parameters:

specPhraseInternalID - Phrase Internal ID

setSpecPhraseItemStatus

public void setSpecPhraseItemStatus(@Nullable
                                    String specPhraseItemStatus)

Constraints: Not nullable, Maximum length: 5

Original property name from the Odata EDM: SpecPhraseItemStatus

Parameters:

specPhraseItemStatus - Phrase Status

setSpecPhraseItemCode

public void setSpecPhraseItemCode(@Nullable
                                  String specPhraseItemCode)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: SpecPhraseItemCode

Parameters:

specPhraseItemCode - Phrase Code

setSpecPhraseItemIsDeleted

public void setSpecPhraseItemIsDeleted(@Nullable
                                       Boolean specPhraseItemIsDeleted)

Constraints: none

Original property name from the Odata EDM: SpecPhraseItemIsDeleted

Parameters:

specPhraseItemIsDeleted - Deletion Indicator

setSpecPhraseItemChangeDate

public void setSpecPhraseItemChangeDate(@Nullable
                                        LocalDateTime specPhraseItemChangeDate)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: SpecPhraseItemChangeDate

Parameters:

specPhraseItemChangeDate - Last Changed On

setSpecPhraseItemLanguage

public void setSpecPhraseItemLanguage(@Nullable
                                      String specPhraseItemLanguage)

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: SpecPhraseItemLanguage

Parameters:

specPhraseItemLanguage - Language

setSpecPhraseItemText

public void setSpecPhraseItemText(@Nullable
                                  String specPhraseItemText)

Constraints: Not nullable, Maximum length: 132

Original property name from the Odata EDM: SpecPhraseItemText

Parameters:

specPhraseItemText - Phrase 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<SpecificationPhraseItem>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<SpecificationPhraseItem>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<SpecificationPhraseItem>

fromMap

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

Overrides:

fromMap in class VdmObject<SpecificationPhraseItem>

field

@Nonnull
public static <T> SpecificationPhraseItemField<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> SpecificationPhraseItemField<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<SpecificationPhraseItem>

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

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

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

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

fetchSpecificationPhrase

@Nonnull
public List<SpecificationPhrase> fetchSpecificationPhrase()
                                                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the SpecificationPhrase entities (one to many) associated with this entity. This corresponds to the OData navigation property to_SpecificationPhrase.

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

Returns:

List containing one or more associated SpecificationPhrase entities. If no entities are associated then an empty list is returned.

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.

getSpecificationPhraseOrFetch

@Nonnull
public List<SpecificationPhrase> getSpecificationPhraseOrFetch()
                                                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated SpecificationPhrase entities (one to many). This corresponds to the OData navigation property to_SpecificationPhrase.

If the navigation property to_SpecificationPhrase of a queried SpecificationPhraseItem 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 SpecificationPhrase entities.

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.

getSpecificationPhraseIfPresent

@Nonnull
public io.vavr.control.Option<List<SpecificationPhrase>> getSpecificationPhraseIfPresent()

Retrieval of associated SpecificationPhrase entities (one to many). This corresponds to the OData navigation property to_SpecificationPhrase.

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

setSpecificationPhrase

public void setSpecificationPhrase(@Nonnull
                                   List<SpecificationPhrase> value)

Overwrites the list of associated SpecificationPhrase entities for the loaded navigation property to_SpecificationPhrase.

If the navigation property to_SpecificationPhrase of a queried SpecificationPhraseItem 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.

Parameters:

value - List of SpecificationPhrase entities.

addSpecificationPhrase

public void addSpecificationPhrase(SpecificationPhrase... entity)

Adds elements to the list of associated SpecificationPhrase entities. This corresponds to the OData navigation property to_SpecificationPhrase.

If the navigation property to_SpecificationPhrase of a queried SpecificationPhraseItem 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.

Parameters:

entity - Array of SpecificationPhrase entities.

builder

@Nonnull
public static SpecificationPhraseItem.SpecificationPhraseItemBuilder builder()

getSpecPhraseItemInternalID

@Nullable
public String getSpecPhraseItemInternalID()

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

Original property name from the Odata EDM: SpecPhraseItemInternalID

Returns:

Phrase Item Internal ID

getSpecPhraseItemChgIntID

@Nullable
public String getSpecPhraseItemChgIntID()

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

Original property name from the Odata EDM: SpecPhraseItemChgIntID

Returns:

Phrase Item Change State

getSpecPhraseInternalID

@Nullable
public String getSpecPhraseInternalID()

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: SpecPhraseInternalID

Returns:

Phrase Internal ID

getSpecPhraseItemStatus

@Nullable
public String getSpecPhraseItemStatus()

Constraints: Not nullable, Maximum length: 5

Original property name from the Odata EDM: SpecPhraseItemStatus

Returns:

Phrase Status

getSpecPhraseItemCode

@Nullable
public String getSpecPhraseItemCode()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: SpecPhraseItemCode

Returns:

Phrase Code

getSpecPhraseItemIsDeleted

@Nullable
public Boolean getSpecPhraseItemIsDeleted()

Constraints: none

Original property name from the Odata EDM: SpecPhraseItemIsDeleted

Returns:

Deletion Indicator

getSpecPhraseItemChangeDate

@Nullable
public LocalDateTime getSpecPhraseItemChangeDate()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: SpecPhraseItemChangeDate

Returns:

Last Changed On

getSpecPhraseItemLanguage

@Nullable
public String getSpecPhraseItemLanguage()

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: SpecPhraseItemLanguage

Returns:

Language

getSpecPhraseItemText

@Nullable
public String getSpecPhraseItemText()

Constraints: Not nullable, Maximum length: 132

Original property name from the Odata EDM: SpecPhraseItemText

Returns:

Phrase Text

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<SpecificationPhraseItem>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<SpecificationPhraseItem>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<SpecificationPhraseItem>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SpecificationPhraseItem>