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

Class ChangeMasterClass

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterClass

public class ChangeMasterClass
extends VdmEntity<ChangeMasterClass>

API for Change Master Class

Original entity name from the Odata EDM: A_ChangeMasterClassType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ChangeMasterClassSelectable	ALL_FIELDS Selector for all available fields of ChangeMasterClass.
static ChangeMasterClassField<String>	CHANGE_NUMBER Use with available fluent helpers to apply the ChangeNumber field to query operations.
static ChangeMasterClassField<String>	CLASS_INTERNAL_ID Use with available fluent helpers to apply the ClassInternalID field to query operations.
static ChangeMasterClassField<String>	CLASS_TYPE Use with available fluent helpers to apply the ClassType field to query operations.
static ChangeMasterClassField<LocalDateTime>	KEY_DATE Use with available fluent helpers to apply the KeyDate field to query operations.
static ChangeMasterClassLink<ChangeMasterClassCharc>	TO_CHARACTERISTICS Use with available fluent helpers to apply the to_Characteristics navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
ChangeMasterClass()
ChangeMasterClass(String changeNumber, String classInternalID, LocalDateTime keyDate, String classType, List<ChangeMasterClassCharc> toCharacteristics)

Method Summary

Modifier and Type	Method and Description
void	addCharacteristics(ChangeMasterClassCharc... entity) Adds elements to the list of associated ChangeMasterClassCharc entities.
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static ChangeMasterClass.ChangeMasterClassBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<ChangeMasterClassCharc>	fetchCharacteristics() Fetches the ChangeMasterClassCharc entities (one to many) associated with this entity.
static <T> ChangeMasterClassField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ChangeMasterClassField<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	getChangeNumber() (Key Field) Constraints: Not nullable, Maximum length: 90
Optional<List<ChangeMasterClassCharc>>	getCharacteristicsIfPresent() Retrieval of associated ChangeMasterClassCharc entities (one to many).
List<ChangeMasterClassCharc>	getCharacteristicsOrFetch() Retrieval of associated ChangeMasterClassCharc entities (one to many).
String	getClassInternalID() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getClassType() Constraints: Not nullable, Maximum length: 3
protected String	getDefaultServicePath()
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
protected Map<String,Object>	getKey()
LocalDateTime	getKeyDate() Constraints: Not nullable, Precision: 0
Class<ChangeMasterClass>	getType()
int	hashCode()
void	setChangeNumber(String changeNumber) (Key Field) Constraints: Not nullable, Maximum length: 90
void	setCharacteristics(List<ChangeMasterClassCharc> value) Overwrites the list of associated ChangeMasterClassCharc entities for the loaded navigation property to_Characteristics.
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) Deprecated. Use attachToService(String, ErpConfigContext) instead.
void	setKeyDate(LocalDateTime keyDate) Constraints: Not nullable, Precision: 0
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

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

getEndpointUrl, getServicePathForFetch, getVersionIdentifier, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.s4hana.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 ChangeMasterClassSelectable ALL_FIELDS

Selector for all available fields of ChangeMasterClass.

CHANGE_NUMBER

public static final ChangeMasterClassField<String> CHANGE_NUMBER

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

CLASS_INTERNAL_ID

public static final ChangeMasterClassField<String> CLASS_INTERNAL_ID

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

KEY_DATE

public static final ChangeMasterClassField<LocalDateTime> KEY_DATE

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

CLASS_TYPE

public static final ChangeMasterClassField<String> CLASS_TYPE

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

TO_CHARACTERISTICS

public static final ChangeMasterClassLink<ChangeMasterClassCharc> TO_CHARACTERISTICS

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

Constructor Detail

ChangeMasterClass

public ChangeMasterClass()

ChangeMasterClass

public ChangeMasterClass(@Nullable
                         String changeNumber,
                         @Nullable
                         String classInternalID,
                         @Nullable
                         LocalDateTime keyDate,
                         @Nullable
                         String classType,
                         List<ChangeMasterClassCharc> toCharacteristics)

Method Detail

getType

@Nonnull
public Class<ChangeMasterClass> getType()

Specified by:

getType in class VdmObject<ChangeMasterClass>

Returns:

The class of this object.

setChangeNumber

public void setChangeNumber(@Nullable
                            String changeNumber)

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

Original property name from the Odata EDM: ChangeNumber

Parameters:

changeNumber - Key of Object to be Classified

setClassInternalID

public void setClassInternalID(@Nullable
                               String classInternalID)

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

Original property name from the Odata EDM: ClassInternalID

Parameters:

classInternalID - Internal Class Number

setKeyDate

public void setKeyDate(@Nullable
                       LocalDateTime keyDate)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: KeyDate

Parameters:

keyDate - The keyDate to set.

setClassType

public void setClassType(@Nullable
                         String classType)

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: ClassType

Parameters:

classType - Uniquely identifies the class type

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<ChangeMasterClass>

getKey

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

Overrides:

getKey in class VdmObject<ChangeMasterClass>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ChangeMasterClass>

fromMap

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

Overrides:

fromMap in class VdmObject<ChangeMasterClass>

field

@Nonnull
public static <T> ChangeMasterClassField<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> ChangeMasterClassField<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.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities). New ERP configuration context to apply to this entity

Overrides:

getErpConfigContext in class VdmEntity<ChangeMasterClass>

Returns:

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

setErpConfigContext

@Deprecated
public void setErpConfigContext(@Nullable
                                            ErpConfigContext erpConfigContext)

Deprecated. Use attachToService(String, ErpConfigContext) instead.

Description copied from class: VdmEntity

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

Overrides:

setErpConfigContext in class VdmEntity<ChangeMasterClass>

Parameters:

erpConfigContext - New ERP configuration context to apply to this entity

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

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nullable
                            ErpConfigContext configContext)

Description copied from class: VdmEntity

Sets the service path and ERP configuration context for the fetch commands of this entity. Ensures that both are set to some value by using defaults if null values are provided in the arguments. Existing values are preserved if null values are provided in the arguments. 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<ChangeMasterClass>

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.

configContext - Optional parameter. New ERP configuration context to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the ERP configuration context has never been set, then the ERP configuration context will be set to a new instance of ErpConfigContext.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<ChangeMasterClass>

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<ChangeMasterClass>

fetchCharacteristics

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

Fetches the ChangeMasterClassCharc 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 ChangeMasterClassCharc 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

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

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

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

getCharacteristicsIfPresent

@Nonnull
public Optional<List<ChangeMasterClassCharc>> getCharacteristicsIfPresent()

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

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

Returns:

If the information for navigation property to_Characteristics is already loaded, the result will contain the ChangeMasterClassCharc entities. If not, an Optional with result state empty is returned.

setCharacteristics

public void setCharacteristics(@Nonnull
                               List<ChangeMasterClassCharc> value)

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

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

addCharacteristics

public void addCharacteristics(ChangeMasterClassCharc... entity)

Adds elements to the list of associated ChangeMasterClassCharc entities. This corresponds to the OData navigation property to_Characteristics.

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

builder

public static ChangeMasterClass.ChangeMasterClassBuilder builder()

getChangeNumber

@Nullable
public String getChangeNumber()

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

Original property name from the Odata EDM: ChangeNumber

Returns:

Key of Object to be Classified

getClassInternalID

@Nullable
public String getClassInternalID()

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

Original property name from the Odata EDM: ClassInternalID

Returns:

Internal Class Number

getKeyDate

@Nullable
public LocalDateTime getKeyDate()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: KeyDate

Returns:

The keyDate contained in this entity.

getClassType

@Nullable
public String getClassType()

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: ClassType

Returns:

Uniquely identifies the class type

toString

public String toString()

Overrides:

toString in class VdmObject<ChangeMasterClass>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<ChangeMasterClass>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<ChangeMasterClass>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ChangeMasterClass>