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

Class MaintainYearsPeriod

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedindependentrequirement.MaintainYearsPeriod

public class MaintainYearsPeriod
extends VdmEntity<MaintainYearsPeriod>

Original entity name from the Odata EDM: MaintainYearsPeriod

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MaintainYearsPeriod.MaintainYearsPeriodBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static MaintainYearsPeriodSelectable	ALL_FIELDS Selector for all available fields of MaintainYearsPeriod.
static MaintainYearsPeriodField<String>	FORECAST_DEMAND_VERSION Use with available fluent helpers to apply the ForecastDemandVersion field to query operations.
static MaintainYearsPeriodField<LocalDateTime>	FORECAST_PERIOD_START_DATE Use with available fluent helpers to apply the ForecastPeriodStartDate field to query operations.
static MaintainYearsPeriodField<String>	FORECAST_PERIOD_TYPE Use with available fluent helpers to apply the ForecastPeriodType field to query operations.
static MaintainYearsPeriodField<BigDecimal>	FORECAST_QUANTITY Use with available fluent helpers to apply the ForecastQuantity field to query operations.
static MaintainYearsPeriodField<String>	MATERIAL Use with available fluent helpers to apply the Material field to query operations.
static MaintainYearsPeriodField<String>	MRP_AREA Use with available fluent helpers to apply the MRPArea field to query operations.
static MaintainYearsPeriodField<String>	PLANT Use with available fluent helpers to apply the Plant field to query operations.
static MaintainYearsPeriodField<String>	PRODUCT_BASE_UNIT Use with available fluent helpers to apply the ProductBaseUnit field to query operations.
static MaintainYearsPeriodField<String>	REQUIREMENTS_TYPE Use with available fluent helpers to apply the RequirementsType field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
MaintainYearsPeriod()
MaintainYearsPeriod(String material, String plant, String mRPArea, String requirementsType, String forecastDemandVersion, LocalDateTime forecastPeriodStartDate, String forecastPeriodType, String productBaseUnit, BigDecimal forecastQuantity)

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 MaintainYearsPeriod.MaintainYearsPeriodBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static <T> MaintainYearsPeriodField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> MaintainYearsPeriodField<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()
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection()
String	getForecastDemandVersion() (Key Field) Constraints: Not nullable, Maximum length: 2
LocalDateTime	getForecastPeriodStartDate() (Key Field) Constraints: Not nullable, Precision: 7
String	getForecastPeriodType() Constraints: Not nullable, Maximum length: 1
BigDecimal	getForecastQuantity() Constraints: Not nullable, Precision: 13, Scale: 3
protected Map<String,Object>	getKey()
String	getMaterial() (Key Field) Constraints: Not nullable, Maximum length: 40
String	getMRPArea() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getPlant() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getProductBaseUnit() Constraints: Not nullable, Maximum length: 3
String	getRequirementsType() (Key Field) Constraints: Not nullable, Maximum length: 4
Class<MaintainYearsPeriod>	getType()
int	hashCode()
void	setForecastDemandVersion(String forecastDemandVersion) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setForecastPeriodStartDate(LocalDateTime forecastPeriodStartDate) (Key Field) Constraints: Not nullable, Precision: 7
void	setForecastPeriodType(String forecastPeriodType) Constraints: Not nullable, Maximum length: 1
void	setForecastQuantity(BigDecimal forecastQuantity) Constraints: Not nullable, Precision: 13, Scale: 3
void	setMaterial(String material) (Key Field) Constraints: Not nullable, Maximum length: 40
void	setMRPArea(String mRPArea) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setPlant(String plant) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setProductBaseUnit(String productBaseUnit) Constraints: Not nullable, Maximum length: 3
void	setRequirementsType(String requirementsType) (Key Field) Constraints: Not nullable, Maximum length: 4
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
protected Map<String,Object>	toMapOfFields()
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, toMapOfNavigationProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final MaintainYearsPeriodSelectable ALL_FIELDS

Selector for all available fields of MaintainYearsPeriod.

MATERIAL

public static final MaintainYearsPeriodField<String> MATERIAL

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

PLANT

public static final MaintainYearsPeriodField<String> PLANT

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

MRP_AREA

public static final MaintainYearsPeriodField<String> MRP_AREA

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

REQUIREMENTS_TYPE

public static final MaintainYearsPeriodField<String> REQUIREMENTS_TYPE

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

FORECAST_DEMAND_VERSION

public static final MaintainYearsPeriodField<String> FORECAST_DEMAND_VERSION

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

FORECAST_PERIOD_START_DATE

public static final MaintainYearsPeriodField<LocalDateTime> FORECAST_PERIOD_START_DATE

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

FORECAST_PERIOD_TYPE

public static final MaintainYearsPeriodField<String> FORECAST_PERIOD_TYPE

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

PRODUCT_BASE_UNIT

public static final MaintainYearsPeriodField<String> PRODUCT_BASE_UNIT

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

FORECAST_QUANTITY

public static final MaintainYearsPeriodField<BigDecimal> FORECAST_QUANTITY

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

Constructor Detail

MaintainYearsPeriod

public MaintainYearsPeriod()

MaintainYearsPeriod

public MaintainYearsPeriod(@Nullable
                           String material,
                           @Nullable
                           String plant,
                           @Nullable
                           String mRPArea,
                           @Nullable
                           String requirementsType,
                           @Nullable
                           String forecastDemandVersion,
                           @Nullable
                           LocalDateTime forecastPeriodStartDate,
                           @Nullable
                           String forecastPeriodType,
                           @Nullable
                           String productBaseUnit,
                           @Nullable
                           BigDecimal forecastQuantity)

Method Detail

getType

@Nonnull
public Class<MaintainYearsPeriod> getType()

Specified by:

getType in class VdmObject<MaintainYearsPeriod>

Returns:

The class of this object.

setMaterial

public void setMaterial(@Nullable
                        String material)

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

Original property name from the Odata EDM: Material

Parameters:

material - Alphanumeric key uniquely identifying the material.

setPlant

public void setPlant(@Nullable
                     String plant)

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

Original property name from the Odata EDM: Plant

Parameters:

plant - Key uniquely identifying a plant.

setMRPArea

public void setMRPArea(@Nullable
                       String mRPArea)

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

Original property name from the Odata EDM: MRPArea

Parameters:

mRPArea - Number of the MRP area for which material requirements planning should be carried out separately.

setRequirementsType

public void setRequirementsType(@Nullable
                                String requirementsType)

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

Original property name from the Odata EDM: RequirementsType

Parameters:

requirementsType - The requirements type determines the planning strategy to be used for a particular requirement.

setForecastDemandVersion

public void setForecastDemandVersion(@Nullable
                                     String forecastDemandVersion)

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

Original property name from the Odata EDM: ForecastDemandVersion

The version number is used for organizational purposes for the creation and further use of the demand program.Versions can be set to active and inactive. Only active versions are included in the planning run.Using the version compare function, you can compare various versions of a demand program with each other.With the version number various planned independent requirements can be indicated according to their origin. For example, whether the demand program results from SOP or from the material forecast.You can also create versions for long-term planning.

Parameters:

forecastDemandVersion - Alphanumeric description of a demand program, also known as the (demand) version number.

setForecastPeriodStartDate

public void setForecastPeriodStartDate(@Nullable
                                       LocalDateTime forecastPeriodStartDate)

(Key Field) Constraints: Not nullable, Precision: 7

Original property name from the Odata EDM: ForecastPeriodStartDate

Parameters:

forecastPeriodStartDate - Period Start Date

setForecastPeriodType

public void setForecastPeriodType(@Nullable
                                  String forecastPeriodType)

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: ForecastPeriodType

Parameters:

forecastPeriodType - Indicator specifying the periods in which the material's consumption values and forecast values are managed.

setProductBaseUnit

public void setProductBaseUnit(@Nullable
                               String productBaseUnit)

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: ProductBaseUnit

You define the base unit of measure and also alternative units of measure and their conversion factors in the material master record.Since all data is updated in the base unit of measure, your entry is particularly important for the conversion of alternative units of measure. A quantity in the alternative unit of measure can only be shown precisely if its value can be shown with the decimal places available. To ensure this, please note the following:The base unit of measure is the unit satisfying the highest necessary requirement for precision.The conversion of alternative units of measure to the base unit should result in simple decimal fractions (not, for example, 1/3 = 0.333...).Inventory ManagementIn Inventory Management, the base unit of measure is the same as the stockkeeping unit.ServicesServices have units of measure of their own, including the following:Service unitUnit of measure at the higher item level. The precise quantities of the individual services are each at the detailed service line level.BlanketUnit of measure at service line level for services to be provided once only, and for which no precise quantities can or are to be specified.

Parameters:

productBaseUnit - Unit of measure in which stocks of the material are managed. The system converts all the quantities you enter in other units of measure (alternative units of measure) to the base unit of measure.

setForecastQuantity

public void setForecastQuantity(@Nullable
                                BigDecimal forecastQuantity)

Constraints: Not nullable, Precision: 13, Scale: 3

Original property name from the Odata EDM: ForecastQuantity

Parameters:

forecastQuantity - Planned Quantity

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<MaintainYearsPeriod>

getKey

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

Overrides:

getKey in class VdmObject<MaintainYearsPeriod>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<MaintainYearsPeriod>

fromMap

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

Overrides:

fromMap in class VdmObject<MaintainYearsPeriod>

field

@Nonnull
public static <T> MaintainYearsPeriodField<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> MaintainYearsPeriodField<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<MaintainYearsPeriod>

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

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

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()

Overrides:

getDefaultServicePath in class VdmEntity<MaintainYearsPeriod>

builder

public static MaintainYearsPeriod.MaintainYearsPeriodBuilder builder()

getMaterial

@Nullable
public String getMaterial()

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

Original property name from the Odata EDM: Material

Returns:

Alphanumeric key uniquely identifying the material.

getPlant

@Nullable
public String getPlant()

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

Original property name from the Odata EDM: Plant

Returns:

Key uniquely identifying a plant.

getMRPArea

@Nullable
public String getMRPArea()

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

Original property name from the Odata EDM: MRPArea

Returns:

Number of the MRP area for which material requirements planning should be carried out separately.

getRequirementsType

@Nullable
public String getRequirementsType()

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

Original property name from the Odata EDM: RequirementsType

Returns:

The requirements type determines the planning strategy to be used for a particular requirement.

getForecastDemandVersion

@Nullable
public String getForecastDemandVersion()

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

Original property name from the Odata EDM: ForecastDemandVersion

The version number is used for organizational purposes for the creation and further use of the demand program.Versions can be set to active and inactive. Only active versions are included in the planning run.Using the version compare function, you can compare various versions of a demand program with each other.With the version number various planned independent requirements can be indicated according to their origin. For example, whether the demand program results from SOP or from the material forecast.You can also create versions for long-term planning.

Returns:

Alphanumeric description of a demand program, also known as the (demand) version number.

getForecastPeriodStartDate

@Nullable
public LocalDateTime getForecastPeriodStartDate()

(Key Field) Constraints: Not nullable, Precision: 7

Original property name from the Odata EDM: ForecastPeriodStartDate

Returns:

Period Start Date

getForecastPeriodType

@Nullable
public String getForecastPeriodType()

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: ForecastPeriodType

Returns:

Indicator specifying the periods in which the material's consumption values and forecast values are managed.

getProductBaseUnit

@Nullable
public String getProductBaseUnit()

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: ProductBaseUnit

You define the base unit of measure and also alternative units of measure and their conversion factors in the material master record.Since all data is updated in the base unit of measure, your entry is particularly important for the conversion of alternative units of measure. A quantity in the alternative unit of measure can only be shown precisely if its value can be shown with the decimal places available. To ensure this, please note the following:The base unit of measure is the unit satisfying the highest necessary requirement for precision.The conversion of alternative units of measure to the base unit should result in simple decimal fractions (not, for example, 1/3 = 0.333...).Inventory ManagementIn Inventory Management, the base unit of measure is the same as the stockkeeping unit.ServicesServices have units of measure of their own, including the following:Service unitUnit of measure at the higher item level. The precise quantities of the individual services are each at the detailed service line level.BlanketUnit of measure at service line level for services to be provided once only, and for which no precise quantities can or are to be specified.

Returns:

Unit of measure in which stocks of the material are managed. The system converts all the quantities you enter in other units of measure (alternative units of measure) to the base unit of measure.

getForecastQuantity

@Nullable
public BigDecimal getForecastQuantity()

Constraints: Not nullable, Precision: 13, Scale: 3

Original property name from the Odata EDM: ForecastQuantity

Returns:

Planned Quantity

toString

public String toString()

Overrides:

toString in class VdmObject<MaintainYearsPeriod>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<MaintainYearsPeriod>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<MaintainYearsPeriod>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<MaintainYearsPeriod>