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

Class PackingInstructionText

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.packinginstruction.PackingInstructionText

public class PackingInstructionText
extends VdmEntity<PackingInstructionText>

Packing Instruction Text

Original entity name from the Odata EDM: PackingInstructionTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static PackingInstructionTextSelectable	ALL_FIELDS Selector for all available fields of PackingInstructionText.
static PackingInstructionTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static PackingInstructionTextField<UUID>	PACKING_INSTRUCTION_SYSTEM_UUID Use with available fluent helpers to apply the PackingInstructionSystemUUID field to query operations.
static PackingInstructionTextField<String>	PACKING_INSTRUCTION_TEXT Use with available fluent helpers to apply the PackingInstructionText field to query operations.
static PackingInstructionTextOneToOneLink<PackingInstructionHeader>	TO_PACKING_INSTRUCTION_HEADER Use with available fluent helpers to apply the to_PackingInstructionHeader navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
PackingInstructionText()
PackingInstructionText(String language, UUID packingInstructionSystemUUID, String packingInstructionText, PackingInstructionHeader toPackingInstructionHeader)

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 PackingInstructionText.PackingInstructionTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
PackingInstructionHeader	fetchPackingInstructionHeader() Fetches the PackingInstructionHeader entity (one to one) associated with this entity.
static <T> PackingInstructionTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> PackingInstructionTextField<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	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
io.vavr.control.Option<PackingInstructionHeader>	getPackingInstructionHeaderIfPresent() Retrieval of associated PackingInstructionHeader entity (one to one).
PackingInstructionHeader	getPackingInstructionHeaderOrFetch() Retrieval of associated PackingInstructionHeader entity (one to one).
UUID	getPackingInstructionSystemUUID() (Key Field) Constraints: Not nullable
String	getPackingInstructionText() Constraints: Not nullable, Maximum length: 40
Class<PackingInstructionText>	getType()
int	hashCode()
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setPackingInstructionHeader(PackingInstructionHeader value) Overwrites the associated PackingInstructionHeader entity for the loaded navigation property to_PackingInstructionHeader.
void	setPackingInstructionSystemUUID(UUID packingInstructionSystemUUID) (Key Field) Constraints: Not nullable
void	setPackingInstructionText(String packingInstructionText) Constraints: Not nullable, Maximum length: 40
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 PackingInstructionTextSelectable ALL_FIELDS

Selector for all available fields of PackingInstructionText.

LANGUAGE

public static final PackingInstructionTextField<String> LANGUAGE

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

PACKING_INSTRUCTION_SYSTEM_UUID

public static final PackingInstructionTextField<UUID> PACKING_INSTRUCTION_SYSTEM_UUID

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

PACKING_INSTRUCTION_TEXT

public static final PackingInstructionTextField<String> PACKING_INSTRUCTION_TEXT

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

TO_PACKING_INSTRUCTION_HEADER

public static final PackingInstructionTextOneToOneLink<PackingInstructionHeader> TO_PACKING_INSTRUCTION_HEADER

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

Constructor Detail

PackingInstructionText

public PackingInstructionText()

PackingInstructionText

public PackingInstructionText(@Nullable
                              String language,
                              @Nullable
                              UUID packingInstructionSystemUUID,
                              @Nullable
                              String packingInstructionText,
                              @Nullable
                              PackingInstructionHeader toPackingInstructionHeader)

Method Detail

getType

@Nonnull
public Class<PackingInstructionText> getType()

Specified by:

getType in class VdmObject<PackingInstructionText>

Returns:

The class of this object.

setLanguage

public void setLanguage(@Nullable
                        String language)

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

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Parameters:

language - The language key indicates

setPackingInstructionSystemUUID

public void setPackingInstructionSystemUUID(@Nullable
                                            UUID packingInstructionSystemUUID)

(Key Field) Constraints: Not nullable

Original property name from the Odata EDM: PackingInstructionSystemUUID

Parameters:

packingInstructionSystemUUID - Packing Instruction Number

setPackingInstructionText

public void setPackingInstructionText(@Nullable
                                      String packingInstructionText)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: PackingInstructionText

Parameters:

packingInstructionText - Detailed description of the packing instruction.

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<PackingInstructionText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<PackingInstructionText>

fromMap

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

Overrides:

fromMap in class VdmObject<PackingInstructionText>

field

@Nonnull
public static <T> PackingInstructionTextField<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> PackingInstructionTextField<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<PackingInstructionText>

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

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

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

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

fetchPackingInstructionHeader

@Nullable
public PackingInstructionHeader fetchPackingInstructionHeader()
                                                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getPackingInstructionHeaderOrFetch

@Nullable
public PackingInstructionHeader getPackingInstructionHeaderOrFetch()
                                                                      throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated PackingInstructionHeader entity (one to one). This corresponds to the OData navigation property to_PackingInstructionHeader.

If the navigation property to_PackingInstructionHeader of a queried PackingInstructionText 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 PackingInstructionHeader 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.

getPackingInstructionHeaderIfPresent

@Nonnull
public io.vavr.control.Option<PackingInstructionHeader> getPackingInstructionHeaderIfPresent()

Retrieval of associated PackingInstructionHeader entity (one to one). This corresponds to the OData navigation property to_PackingInstructionHeader.

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

setPackingInstructionHeader

public void setPackingInstructionHeader(PackingInstructionHeader value)

Overwrites the associated PackingInstructionHeader entity for the loaded navigation property to_PackingInstructionHeader.

Parameters:

value - New PackingInstructionHeader entity.

builder

@Nonnull
public static PackingInstructionText.PackingInstructionTextBuilder builder()

getLanguage

@Nullable
public String getLanguage()

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

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Returns:

The language key indicates

getPackingInstructionSystemUUID

@Nullable
public UUID getPackingInstructionSystemUUID()

(Key Field) Constraints: Not nullable

Original property name from the Odata EDM: PackingInstructionSystemUUID

Returns:

Packing Instruction Number

getPackingInstructionText

@Nullable
public String getPackingInstructionText()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: PackingInstructionText

Returns:

Detailed description of the packing instruction.

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<PackingInstructionText>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<PackingInstructionText>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<PackingInstructionText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<PackingInstructionText>