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

Class ProductCharc

java.lang.Object

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

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity<ProductCharc>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readproductmasterdataincludingclassification.ProductCharc

public class ProductCharc
extends VdmEntity<ProductCharc>

API for Product Characteristics

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProductCharc.ProductCharcBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static ProductCharcSelectable	ALL_FIELDS Selector for all available fields of ProductCharc.
static ProductCharcField<String>	CHANGE_NUMBER Use with available fluent helpers to apply the ChangeNumber field to query operations.
static ProductCharcField<String>	CHARC_INTERNAL_ID Use with available fluent helpers to apply the CharcInternalID field to query operations.
static ProductCharcField<String>	CLASS_TYPE Use with available fluent helpers to apply the ClassType field to query operations.
static ProductCharcField<Calendar>	KEY_DATE Use with available fluent helpers to apply the KeyDate field to query operations.
static ProductCharcField<String>	PRODUCT Use with available fluent helpers to apply the Product field to query operations.
static ProductCharcLink<ProductCharcValue>	TO_VALUATION Use with available fluent helpers to apply the to_Valuation navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
ProductCharc()
ProductCharc(String product, String charcInternalID, String classType, Calendar keyDate, String changeNumber, ErpConfigContext erpConfigContext, List<ProductCharcValue> toValuation)

Method Summary

Modifier and Type	Method and Description
void	addValuation(ProductCharcValue... entity) Adds elements to the list of associated ProductCharcValue entities.
static ProductCharc.ProductCharcBuilder	builder()
boolean	equals(Object o)
List<ProductCharcValue>	fetchValuation() Fetches the ProductCharcValue entities (one to many) associated with this entity.
static <T> ProductCharcField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getChangeNumber() Constraints: Not nullable, Maximum length: 12
String	getCharcInternalID() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getClassType() (Key Field) Constraints: Not nullable, Maximum length: 3
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
Calendar	getKeyDate() Constraints: Not nullable, Precision: 0
String	getProduct() (Key Field) Constraints: Not nullable, Maximum length: 90
Class<ProductCharc>	getType()
List<ProductCharcValue>	getValuationOrFetch() Retrieval of associated ProductCharcValue entities (one to many).
com.google.common.base.Optional<List<ProductCharcValue>>	getValuationOrNull() Retrieval of associated ProductCharcValue entities (one to many).
int	hashCode()
void	setChangeNumber(String changeNumber) Constraints: Not nullable, Maximum length: 12
void	setCharcInternalID(String charcInternalID) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setClassType(String classType) (Key Field) Constraints: Not nullable, Maximum length: 3
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setKeyDate(Calendar keyDate) Constraints: Not nullable, Precision: 0
void	setProduct(String product) (Key Field) Constraints: Not nullable, Maximum length: 90
void	setValuation(List<ProductCharcValue> value) Overwrites the list of associated ProductCharcValue entities for the loaded navigation property to_Valuation.
String	toString()

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

getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final ProductCharcSelectable ALL_FIELDS

Selector for all available fields of ProductCharc.

PRODUCT

public static final ProductCharcField<String> PRODUCT

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

CHARC_INTERNAL_ID

public static final ProductCharcField<String> CHARC_INTERNAL_ID

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

CLASS_TYPE

public static final ProductCharcField<String> CLASS_TYPE

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

KEY_DATE

public static final ProductCharcField<Calendar> KEY_DATE

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

CHANGE_NUMBER

public static final ProductCharcField<String> CHANGE_NUMBER

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

TO_VALUATION

public static final ProductCharcLink<ProductCharcValue> TO_VALUATION

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

Constructor Detail

ProductCharc

@Generated(value="lombok")
public ProductCharc()

ProductCharc

@ConstructorProperties(value={"product","charcInternalID","classType","keyDate","changeNumber","erpConfigContext","toValuation"})
 @Generated(value="lombok")
public ProductCharc(@Nullable
                                                                                                                                                                                  String product,
                                                                                                                                                                                  @Nullable
                                                                                                                                                                                  String charcInternalID,
                                                                                                                                                                                  @Nullable
                                                                                                                                                                                  String classType,
                                                                                                                                                                                  @Nullable
                                                                                                                                                                                  Calendar keyDate,
                                                                                                                                                                                  @Nullable
                                                                                                                                                                                  String changeNumber,
                                                                                                                                                                                  @Nullable
                                                                                                                                                                                  ErpConfigContext erpConfigContext,
                                                                                                                                                                                  List<ProductCharcValue> toValuation)

Method Detail

getType

public Class<ProductCharc> getType()

Specified by:

getType in class VdmObject<ProductCharc>

Returns:

The class of this object.

field

public static <T> ProductCharcField<T> field(String fieldName,
                                             Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

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.

fetchValuation

public List<ProductCharcValue> fetchValuation()
                                       throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getValuationOrFetch

public List<ProductCharcValue> getValuationOrFetch()
                                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated ProductCharcValue entities (one to many).

If the navigation property to_Valuation of a queried ProductCharc 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 ProductCharcValue 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.

getValuationOrNull

public com.google.common.base.Optional<List<ProductCharcValue>> getValuationOrNull()

Retrieval of associated ProductCharcValue entities (one to many).

If the navigation property to_Valuation for an entity ProductCharc has not been resolved yet, this method will not query further information. Instead its Optional result state will be null.

Returns:

If the information for navigation property to_Valuation is already loaded, the result will contain the ProductCharcValue entities. If not, a null value state is returned.

setValuation

public void setValuation(@NonNull
                         List<ProductCharcValue> value)

Overwrites the list of associated ProductCharcValue entities for the loaded navigation property to_Valuation.

If the navigation property to_Valuation of a queried ProductCharc 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 ProductCharcValue entities.

addValuation

public void addValuation(ProductCharcValue... entity)

Adds elements to the list of associated ProductCharcValue entities.

If the navigation property to_Valuation of a queried ProductCharc 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 ProductCharcValue entities.

builder

@Generated(value="lombok")
public static ProductCharc.ProductCharcBuilder builder()

getProduct

@Nullable
 @Generated(value="lombok")
public String getProduct()

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

Returns:

Key of Object to be Classified

getCharcInternalID

@Nullable
 @Generated(value="lombok")
public String getCharcInternalID()

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

Returns:

Internal characteristic number without conversion routine

getClassType

@Nullable
 @Generated(value="lombok")
public String getClassType()

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

Returns:

Uniquely identifies the class type

getKeyDate

@Nullable
 @Generated(value="lombok")
public Calendar getKeyDate()

Constraints: Not nullable, Precision: 0

getChangeNumber

@Nullable
 @Generated(value="lombok")
public String getChangeNumber()

Constraints: Not nullable, Maximum length: 12

If you make a change with reference to a change number, or create an object with a change number, the following functions are at your disposal: The system determines the validity conditions The conditions that the change is effective under can be defined in the change master record as follows: Changes with a date validity (valid-from date) Changes with parameter effectivity (for example: serial no. effectivity) Log of the changes made Documentation of the changes Assignment of a revision level to a change state of a material or document Release of changes for the different areas in the company

Returns:

Number used to uniquely identify a change master record.

getErpConfigContext

@Nullable
 @Generated(value="lombok")
public ErpConfigContext getErpConfigContext()

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setProduct

@Generated(value="lombok")
public void setProduct(@Nullable
                                                  String product)

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

Parameters:

product -

setCharcInternalID

@Generated(value="lombok")
public void setCharcInternalID(@Nullable
                                                          String charcInternalID)

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

Parameters:

charcInternalID -

setClassType

@Generated(value="lombok")
public void setClassType(@Nullable
                                                    String classType)

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

Parameters:

classType -

setKeyDate

@Generated(value="lombok")
public void setKeyDate(@Nullable
                                                  Calendar keyDate)

Constraints: Not nullable, Precision: 0

Parameters:

keyDate -

setChangeNumber

@Generated(value="lombok")
public void setChangeNumber(@Nullable
                                                       String changeNumber)

Constraints: Not nullable, Maximum length: 12

If you make a change with reference to a change number, or create an object with a change number, the following functions are at your disposal: The system determines the validity conditions The conditions that the change is effective under can be defined in the change master record as follows: Changes with a date validity (valid-from date) Changes with parameter effectivity (for example: serial no. effectivity) Log of the changes made Documentation of the changes Assignment of a revision level to a change state of a material or document Release of changes for the different areas in the company

Parameters:

changeNumber -

setErpConfigContext

@Generated(value="lombok")
public void setErpConfigContext(@Nullable
                                                           ErpConfigContext erpConfigContext)

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Parameters:

erpConfigContext -

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class VdmObject<ProductCharc>

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class VdmObject<ProductCharc>

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class VdmObject<ProductCharc>