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

Class Warehouse

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouse.Warehouse

public class Warehouse
extends VdmEntity<Warehouse>

Warehouse

Original entity name from the Odata EDM: WarehouseType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static WarehouseSelectable	ALL_FIELDS Selector for all available fields of Warehouse.
static WarehouseLink<WarehouseStorageType>	TO_WAREHOUSE_STORAGE_TYPE Use with available fluent helpers to apply the to_WarehouseStorageType navigation property to query operations.
static WarehouseLink<WarehouseText>	TO_WAREHOUSE_TEXT Use with available fluent helpers to apply the to_WarehouseText navigation property to query operations.
static WarehouseField<String>	WAREHOUSE Use with available fluent helpers to apply the Warehouse field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
Warehouse()
Warehouse(String warehouse, List<WarehouseStorageType> toWarehouseStorageType, List<WarehouseText> toWarehouseText)

Method Summary

Modifier and Type	Method and Description
void	addWarehouseStorageType(WarehouseStorageType... entity) Adds elements to the list of associated WarehouseStorageType entities.
void	addWarehouseText(WarehouseText... entity) Adds elements to the list of associated WarehouseText entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static Warehouse.WarehouseBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<WarehouseStorageType>	fetchWarehouseStorageType() Fetches the WarehouseStorageType entities (one to many) associated with this entity.
List<WarehouseText>	fetchWarehouseText() Fetches the WarehouseText entities (one to many) associated with this entity.
static <T> WarehouseField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> WarehouseField<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()
Class<Warehouse>	getType()
String	getWarehouse() (Key Field) Constraints: Not nullable, Maximum length: 4
io.vavr.control.Option<List<WarehouseStorageType>>	getWarehouseStorageTypeIfPresent() Retrieval of associated WarehouseStorageType entities (one to many).
List<WarehouseStorageType>	getWarehouseStorageTypeOrFetch() Retrieval of associated WarehouseStorageType entities (one to many).
io.vavr.control.Option<List<WarehouseText>>	getWarehouseTextIfPresent() Retrieval of associated WarehouseText entities (one to many).
List<WarehouseText>	getWarehouseTextOrFetch() Retrieval of associated WarehouseText entities (one to many).
int	hashCode()
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setWarehouse(String warehouse) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setWarehouseStorageType(List<WarehouseStorageType> value) Overwrites the list of associated WarehouseStorageType entities for the loaded navigation property to_WarehouseStorageType.
void	setWarehouseText(List<WarehouseText> value) Overwrites the list of associated WarehouseText entities for the loaded navigation property to_WarehouseText.
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 WarehouseSelectable ALL_FIELDS

Selector for all available fields of Warehouse.

WAREHOUSE

public static final WarehouseField<String> WAREHOUSE

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

TO_WAREHOUSE_STORAGE_TYPE

public static final WarehouseLink<WarehouseStorageType> TO_WAREHOUSE_STORAGE_TYPE

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

TO_WAREHOUSE_TEXT

public static final WarehouseLink<WarehouseText> TO_WAREHOUSE_TEXT

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

Constructor Detail

Warehouse

public Warehouse()

Warehouse

public Warehouse(@Nullable
                 String warehouse,
                 List<WarehouseStorageType> toWarehouseStorageType,
                 List<WarehouseText> toWarehouseText)

Method Detail

getType

@Nonnull
public Class<Warehouse> getType()

Specified by:

getType in class VdmObject<Warehouse>

Returns:

The class of this object.

setWarehouse

public void setWarehouse(@Nullable
                         String warehouse)

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

Original property name from the Odata EDM: Warehouse

All activities within a warehouse, for example, goods movements and physical inventory, are assigned to a specific warehouse number. The physical warehouse where these activities take place is identified by the warehouse number.

Parameters:

warehouse - Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<Warehouse>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<Warehouse>

fromMap

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

Overrides:

fromMap in class VdmObject<Warehouse>

field

@Nonnull
public static <T> WarehouseField<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> WarehouseField<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<Warehouse>

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

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

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

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

fetchWarehouseStorageType

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

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

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

Returns:

List containing one or more associated WarehouseStorageType 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.

getWarehouseStorageTypeOrFetch

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

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

If the navigation property to_WarehouseStorageType of a queried Warehouse 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 WarehouseStorageType 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.

getWarehouseStorageTypeIfPresent

@Nonnull
public io.vavr.control.Option<List<WarehouseStorageType>> getWarehouseStorageTypeIfPresent()

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

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

setWarehouseStorageType

public void setWarehouseStorageType(@Nonnull
                                    List<WarehouseStorageType> value)

Overwrites the list of associated WarehouseStorageType entities for the loaded navigation property to_WarehouseStorageType.

If the navigation property to_WarehouseStorageType of a queried Warehouse 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 WarehouseStorageType entities.

addWarehouseStorageType

public void addWarehouseStorageType(WarehouseStorageType... entity)

Adds elements to the list of associated WarehouseStorageType entities. This corresponds to the OData navigation property to_WarehouseStorageType.

If the navigation property to_WarehouseStorageType of a queried Warehouse 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 WarehouseStorageType entities.

fetchWarehouseText

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

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

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

Returns:

List containing one or more associated WarehouseText 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.

getWarehouseTextOrFetch

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

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

If the navigation property to_WarehouseText of a queried Warehouse 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 WarehouseText 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.

getWarehouseTextIfPresent

@Nonnull
public io.vavr.control.Option<List<WarehouseText>> getWarehouseTextIfPresent()

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

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

setWarehouseText

public void setWarehouseText(@Nonnull
                             List<WarehouseText> value)

Overwrites the list of associated WarehouseText entities for the loaded navigation property to_WarehouseText.

If the navigation property to_WarehouseText of a queried Warehouse 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 WarehouseText entities.

addWarehouseText

public void addWarehouseText(WarehouseText... entity)

Adds elements to the list of associated WarehouseText entities. This corresponds to the OData navigation property to_WarehouseText.

If the navigation property to_WarehouseText of a queried Warehouse 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 WarehouseText entities.

builder

@Nonnull
public static Warehouse.WarehouseBuilder builder()

getWarehouse

@Nullable
public String getWarehouse()

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

Original property name from the Odata EDM: Warehouse

All activities within a warehouse, for example, goods movements and physical inventory, are assigned to a specific warehouse number. The physical warehouse where these activities take place is identified by the warehouse number.

Returns:

Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<Warehouse>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<Warehouse>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<Warehouse>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<Warehouse>