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

Class ProductClass

java.lang.Object

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

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

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

public class ProductClass
extends VdmEntity<ProductClass>

API for Product Classes

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProductClass.ProductClassBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static ProductClassSelectable	ALL_FIELDS Selector for all available fields of ProductClass.
static ProductClassField<String>	CHANGE_NUMBER Use with available fluent helpers to apply the ChangeNumber field to query operations.
static ProductClassField<String>	CLASS_INTERNAL_ID Use with available fluent helpers to apply the ClassInternalID field to query operations.
static ProductClassField<String>	CLASS_TYPE Use with available fluent helpers to apply the ClassType field to query operations.
static ProductClassField<Calendar>	KEY_DATE Use with available fluent helpers to apply the KeyDate field to query operations.
static ProductClassField<String>	PRODUCT Use with available fluent helpers to apply the Product field to query operations.
static ProductClassLink<ProductClassCharc>	TO_CHARACTERISTICS Use with available fluent helpers to apply the to_Characteristics navigation property to query operations.
static ProductClassLink<ClfnClassForKeyDate>	TO_CLASS_DETAILS Use with available fluent helpers to apply the to_ClassDetails navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
ProductClass()
ProductClass(String product, String classInternalID, Calendar keyDate, String changeNumber, String classType, ErpConfigContext erpConfigContext, List<ProductClassCharc> toCharacteristics, ClfnClassForKeyDate toClassDetails)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCharacteristics(ProductClassCharc... entity) Adds elements to the list of associated ProductClassCharc entities.
static ProductClass.ProductClassBuilder	builder()
boolean	equals(Object o)
List<ProductClassCharc>	fetchCharacteristics() Fetches the ProductClassCharc entities (one to many) associated with this entity.
ClfnClassForKeyDate	fetchClassDetails() Fetches the ClfnClassForKeyDate entity (one to one) associated with this entity.
static <T> ProductClassField<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
List<ProductClassCharc>	getCharacteristicsOrFetch() Retrieval of associated ProductClassCharc entities (one to many).
com.google.common.base.Optional<List<ProductClassCharc>>	getCharacteristicsOrNull() Retrieval of associated ProductClassCharc entities (one to many).
ClfnClassForKeyDate	getClassDetailsOrFetch() Retrieval of associated ClfnClassForKeyDate entity (one to one).
com.google.common.base.Optional<ClfnClassForKeyDate>	getClassDetailsOrNull() Retrieval of associated ClfnClassForKeyDate entity (one to one).
String	getClassInternalID() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getClassType() 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<ProductClass>	getType()
int	hashCode()
void	setChangeNumber(String changeNumber) Constraints: Not nullable, Maximum length: 12
void	setCharacteristics(List<ProductClassCharc> value) Overwrites the list of associated ProductClassCharc entities for the loaded navigation property to_Characteristics.
void	setClassDetails(ClfnClassForKeyDate value) Overwrites the associated ClfnClassForKeyDate entity for the loaded navigation property to_ClassDetails.
void	setClassInternalID(String classInternalID) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setClassType(String classType) 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
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 ProductClassSelectable ALL_FIELDS

Selector for all available fields of ProductClass.

PRODUCT

public static final ProductClassField<String> PRODUCT

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

CLASS_INTERNAL_ID

public static final ProductClassField<String> CLASS_INTERNAL_ID

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

KEY_DATE

public static final ProductClassField<Calendar> KEY_DATE

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

CHANGE_NUMBER

public static final ProductClassField<String> CHANGE_NUMBER

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

CLASS_TYPE

public static final ProductClassField<String> CLASS_TYPE

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

TO_CHARACTERISTICS

public static final ProductClassLink<ProductClassCharc> TO_CHARACTERISTICS

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

TO_CLASS_DETAILS

public static final ProductClassLink<ClfnClassForKeyDate> TO_CLASS_DETAILS

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

Constructor Detail

ProductClass

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

ProductClass

@ConstructorProperties(value={"product","classInternalID","keyDate","changeNumber","classType","erpConfigContext","toCharacteristics","toClassDetails"})
@Generated(value="lombok")
public ProductClass(@Nullable
                                                      String product,
                                                      @Nullable
                                                      String classInternalID,
                                                      @Nullable
                                                      Calendar keyDate,
                                                      @Nullable
                                                      String changeNumber,
                                                      @Nullable
                                                      String classType,
                                                      @Nullable
                                                      ErpConfigContext erpConfigContext,
                                                      List<ProductClassCharc> toCharacteristics,
                                                      @Nullable
                                                      ClfnClassForKeyDate toClassDetails)

Method Detail

getType

public Class<ProductClass> getType()

Specified by:

getType in class VdmObject<ProductClass>

Returns:

The class of this object.

field

public static <T> ProductClassField<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.

fetchCharacteristics

public List<ProductClassCharc> fetchCharacteristics()
                                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getCharacteristicsOrFetch

public List<ProductClassCharc> getCharacteristicsOrFetch()
                                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated ProductClassCharc entities (one to many).

If the navigation property to_Characteristics of a queried ProductClass 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 ProductClassCharc 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.

getCharacteristicsOrNull

public com.google.common.base.Optional<List<ProductClassCharc>> getCharacteristicsOrNull()

Retrieval of associated ProductClassCharc entities (one to many).

If the navigation property to_Characteristics for an entity ProductClass 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_Characteristics is already loaded, the result will contain the ProductClassCharc entities. If not, a null value state is returned.

setCharacteristics

public void setCharacteristics(@NonNull
                      List<ProductClassCharc> value)

Overwrites the list of associated ProductClassCharc entities for the loaded navigation property to_Characteristics.

If the navigation property to_Characteristics of a queried ProductClass 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 ProductClassCharc entities.

addCharacteristics

public void addCharacteristics(ProductClassCharc... entity)

Adds elements to the list of associated ProductClassCharc entities.

If the navigation property to_Characteristics of a queried ProductClass 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 ProductClassCharc entities.

fetchClassDetails

public ClfnClassForKeyDate fetchClassDetails()
                                      throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getClassDetailsOrFetch

public ClfnClassForKeyDate getClassDetailsOrFetch()
                                           throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated ClfnClassForKeyDate entity (one to one).

If the navigation property to_ClassDetails of a queried ProductClass 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 ClfnClassForKeyDate 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.

getClassDetailsOrNull

public com.google.common.base.Optional<ClfnClassForKeyDate> getClassDetailsOrNull()

Retrieval of associated ClfnClassForKeyDate entity (one to one).

If the navigation property to_ClassDetails for an entity ProductClass 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_ClassDetails is already loaded, the result will contain the ClfnClassForKeyDate entity. If not, a null value state is returned.

setClassDetails

public void setClassDetails(ClfnClassForKeyDate value)

Overwrites the associated ClfnClassForKeyDate entity for the loaded navigation property to_ClassDetails.

Parameters:

value - New ClfnClassForKeyDate entity.

builder

@Generated(value="lombok")
public static ProductClass.ProductClassBuilder builder()

getProduct

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

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

Returns:

Key of Object to be Classified

getClassInternalID

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

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

Returns:

Internal Class Number

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.

getClassType

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

Constraints: Not nullable, Maximum length: 3

Returns:

Uniquely identifies the class type

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 -

setClassInternalID

@Generated(value="lombok")
public void setClassInternalID(@Nullable
                                     String classInternalID)

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

Parameters:

classInternalID -

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 -

setClassType

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

Constraints: Not nullable, Maximum length: 3

Parameters:

classType -

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

equals

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

Overrides:

equals in class VdmObject<ProductClass>

hashCode

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

Overrides:

hashCode in class VdmObject<ProductClass>