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

Class WarehouseTaskExceptionCode

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehousetask.WarehouseTaskExceptionCode

public class WarehouseTaskExceptionCode
extends VdmEntity<WarehouseTaskExceptionCode>

Warehouse Task Exception Code

Original entity name from the Odata EDM: WarehouseTaskExceptionCodeType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static WarehouseTaskExceptionCodeSelectable	ALL_FIELDS Selector for all available fields of WarehouseTaskExceptionCode.
static WarehouseTaskExceptionCodeField<String>	BUSINESS_CONTEXT Use with available fluent helpers to apply the BusinessContext field to query operations.
static WarehouseTaskExceptionCodeField<String>	BUSINESS_CONTEXT_EXECUTION_STEP Use with available fluent helpers to apply the BusinessContextExecutionStep field to query operations.
static WarehouseTaskExceptionCodeOneToOneLink<WarehouseTask>	TO_WAREHOUSE_TASK Use with available fluent helpers to apply the to_WarehouseTask navigation property to query operations.
static WarehouseTaskExceptionCodeField<String>	WAREHOUSE Use with available fluent helpers to apply the Warehouse field to query operations.
static WarehouseTaskExceptionCodeField<String>	WAREHOUSE_TASK Use with available fluent helpers to apply the WarehouseTask field to query operations.
static WarehouseTaskExceptionCodeField<String>	WAREHOUSE_TASK_EXCEPTION_CODE Use with available fluent helpers to apply the WarehouseTaskExceptionCode field to query operations.
static WarehouseTaskExceptionCodeField<String>	WAREHOUSE_TASK_ITEM Use with available fluent helpers to apply the WarehouseTaskItem field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
WarehouseTaskExceptionCode()
WarehouseTaskExceptionCode(String warehouse, String warehouseTask, String warehouseTaskItem, String warehouseTaskExceptionCode, String businessContext, String businessContextExecutionStep, WarehouseTask toWarehouseTask)

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 WarehouseTaskExceptionCode.WarehouseTaskExceptionCodeBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
WarehouseTask	fetchWarehouseTask() Fetches the WarehouseTask entity (one to one) associated with this entity.
static <T> WarehouseTaskExceptionCodeField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> WarehouseTaskExceptionCodeField<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)
String	getBusinessContext() (Key Field) Constraints: Not nullable, Maximum length: 3
String	getBusinessContextExecutionStep() (Key Field) Constraints: Not nullable, Maximum length: 2
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<WarehouseTaskExceptionCode>	getType()
String	getWarehouse() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getWarehouseTask() (Key Field) Constraints: Not nullable, Maximum length: 12
String	getWarehouseTaskExceptionCode() (Key Field) Constraints: Not nullable, Maximum length: 4
io.vavr.control.Option<WarehouseTask>	getWarehouseTaskIfPresent() Retrieval of associated WarehouseTask entity (one to one).
String	getWarehouseTaskItem() (Key Field) Constraints: Not nullable, Maximum length: 4
WarehouseTask	getWarehouseTaskOrFetch() Retrieval of associated WarehouseTask entity (one to one).
int	hashCode()
void	setBusinessContext(String businessContext) (Key Field) Constraints: Not nullable, Maximum length: 3
void	setBusinessContextExecutionStep(String businessContextExecutionStep) (Key Field) Constraints: Not nullable, Maximum length: 2
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	setWarehouseTask(String warehouseTask) (Key Field) Constraints: Not nullable, Maximum length: 12
void	setWarehouseTask(WarehouseTask value) Overwrites the associated WarehouseTask entity for the loaded navigation property to_WarehouseTask.
void	setWarehouseTaskExceptionCode(String warehouseTaskExceptionCode) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setWarehouseTaskItem(String warehouseTaskItem) (Key Field) Constraints: Not nullable, Maximum length: 4
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 WarehouseTaskExceptionCodeSelectable ALL_FIELDS

Selector for all available fields of WarehouseTaskExceptionCode.

WAREHOUSE

public static final WarehouseTaskExceptionCodeField<String> WAREHOUSE

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

WAREHOUSE_TASK

public static final WarehouseTaskExceptionCodeField<String> WAREHOUSE_TASK

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

WAREHOUSE_TASK_ITEM

public static final WarehouseTaskExceptionCodeField<String> WAREHOUSE_TASK_ITEM

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

WAREHOUSE_TASK_EXCEPTION_CODE

public static final WarehouseTaskExceptionCodeField<String> WAREHOUSE_TASK_EXCEPTION_CODE

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

BUSINESS_CONTEXT

public static final WarehouseTaskExceptionCodeField<String> BUSINESS_CONTEXT

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

BUSINESS_CONTEXT_EXECUTION_STEP

public static final WarehouseTaskExceptionCodeField<String> BUSINESS_CONTEXT_EXECUTION_STEP

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

TO_WAREHOUSE_TASK

public static final WarehouseTaskExceptionCodeOneToOneLink<WarehouseTask> TO_WAREHOUSE_TASK

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

Constructor Detail

WarehouseTaskExceptionCode

public WarehouseTaskExceptionCode()

WarehouseTaskExceptionCode

public WarehouseTaskExceptionCode(@Nullable
                                  String warehouse,
                                  @Nullable
                                  String warehouseTask,
                                  @Nullable
                                  String warehouseTaskItem,
                                  @Nullable
                                  String warehouseTaskExceptionCode,
                                  @Nullable
                                  String businessContext,
                                  @Nullable
                                  String businessContextExecutionStep,
                                  @Nullable
                                  WarehouseTask toWarehouseTask)

Method Detail

getType

@Nonnull
public Class<WarehouseTaskExceptionCode> getType()

Specified by:

getType in class VdmObject<WarehouseTaskExceptionCode>

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.

setWarehouseTask

public void setWarehouseTask(@Nullable
                             String warehouseTask)

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

Original property name from the Odata EDM: WarehouseTask

All movements in a warehouse are processed in the system via warehouse tasks.

Parameters:

warehouseTask - Number that uniquely identifies the warehouse task within a warehouse.

setWarehouseTaskItem

public void setWarehouseTaskItem(@Nullable
                                 String warehouseTaskItem)

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

Original property name from the Odata EDM: WarehouseTaskItem

Every WT item moves a product in a particular attribute and quantity from a storage bin (possibly cross-storage type) to a different storage bin (and if necessary, a remaining quantity to a third storage bin).

Parameters:

warehouseTaskItem - Uniquely identifes a movement within a warehouse task (WT)

setWarehouseTaskExceptionCode

public void setWarehouseTaskExceptionCode(@Nullable
                                          String warehouseTaskExceptionCode)

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

Original property name from the Odata EDM: WarehouseTaskExceptionCode

Storage bin is empty, storage bin is not accessible

Parameters:

warehouseTaskExceptionCode - Code with which an exception situation in the warehouse can be documented.

setBusinessContext

public void setBusinessContext(@Nullable
                               String businessContext)

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

Original property name from the Odata EDM: BusinessContext

Confirm warehouse task and count physical inventory.

Parameters:

businessContext - Context in which special exception codes can be made available.

setBusinessContextExecutionStep

public void setBusinessContextExecutionStep(@Nullable
                                            String businessContextExecutionStep)

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

Original property name from the Odata EDM: BusinessContextExecutionStep

Parameters:

businessContextExecutionStep - Execution Step in Business Context

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<WarehouseTaskExceptionCode>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<WarehouseTaskExceptionCode>

fromMap

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

Overrides:

fromMap in class VdmObject<WarehouseTaskExceptionCode>

field

@Nonnull
public static <T> WarehouseTaskExceptionCodeField<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> WarehouseTaskExceptionCodeField<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<WarehouseTaskExceptionCode>

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

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

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

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

fetchWarehouseTask

@Nullable
public WarehouseTask fetchWarehouseTask()
                                           throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getWarehouseTaskOrFetch

@Nullable
public WarehouseTask getWarehouseTaskOrFetch()
                                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated WarehouseTask entity (one to one). This corresponds to the OData navigation property to_WarehouseTask.

If the navigation property to_WarehouseTask of a queried WarehouseTaskExceptionCode 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 WarehouseTask 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.

getWarehouseTaskIfPresent

@Nonnull
public io.vavr.control.Option<WarehouseTask> getWarehouseTaskIfPresent()

Retrieval of associated WarehouseTask entity (one to one). This corresponds to the OData navigation property to_WarehouseTask.

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

setWarehouseTask

public void setWarehouseTask(WarehouseTask value)

Overwrites the associated WarehouseTask entity for the loaded navigation property to_WarehouseTask.

Parameters:

value - New WarehouseTask entity.

builder

@Nonnull
public static WarehouseTaskExceptionCode.WarehouseTaskExceptionCodeBuilder 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.

getWarehouseTask

@Nullable
public String getWarehouseTask()

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

Original property name from the Odata EDM: WarehouseTask

All movements in a warehouse are processed in the system via warehouse tasks.

Returns:

Number that uniquely identifies the warehouse task within a warehouse.

getWarehouseTaskItem

@Nullable
public String getWarehouseTaskItem()

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

Original property name from the Odata EDM: WarehouseTaskItem

Every WT item moves a product in a particular attribute and quantity from a storage bin (possibly cross-storage type) to a different storage bin (and if necessary, a remaining quantity to a third storage bin).

Returns:

Uniquely identifes a movement within a warehouse task (WT)

getWarehouseTaskExceptionCode

@Nullable
public String getWarehouseTaskExceptionCode()

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

Original property name from the Odata EDM: WarehouseTaskExceptionCode

Storage bin is empty, storage bin is not accessible

Returns:

Code with which an exception situation in the warehouse can be documented.

getBusinessContext

@Nullable
public String getBusinessContext()

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

Original property name from the Odata EDM: BusinessContext

Confirm warehouse task and count physical inventory.

Returns:

Context in which special exception codes can be made available.

getBusinessContextExecutionStep

@Nullable
public String getBusinessContextExecutionStep()

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

Original property name from the Odata EDM: BusinessContextExecutionStep

Returns:

Execution Step in Business Context

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<WarehouseTaskExceptionCode>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<WarehouseTaskExceptionCode>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<WarehouseTaskExceptionCode>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<WarehouseTaskExceptionCode>