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

Class ChangeMasterAltDate

java.lang.Object

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

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

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

public class ChangeMasterAltDate
extends VdmEntity<ChangeMasterAltDate>

API for Change Number Alternative Date

Original entity name from the Odata EDM: A_ChangeMasterAltDateType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ChangeMasterAltDateSelectable	ALL_FIELDS Selector for all available fields of ChangeMasterAltDate.
static ChangeMasterAltDateField<String>	CHANGE_NUMBER Use with available fluent helpers to apply the ChangeNumber field to query operations.
static ChangeMasterAltDateField<LocalDateTime>	CHG_NMBR_ALTERNATIVE_DATE Use with available fluent helpers to apply the ChgNmbrAlternativeDate field to query operations.
static ChangeMasterAltDateField<String>	CHG_NMBR_ALTERNATIVE_DATE_COUNTER Use with available fluent helpers to apply the ChgNmbrAlternativeDateCounter field to query operations.
static ChangeMasterAltDateField<String>	CHG_NMBR_ALTERNATIVE_DATE_TEXT Use with available fluent helpers to apply the ChgNmbrAlternativeDateText field to query operations.
static ChangeMasterAltDateField<Boolean>	CHG_NMBR_ALTV_DATE_IS_ASSIGNED_TO_OBJ Use with available fluent helpers to apply the ChgNmbrAltvDateIsAssignedToObj field to query operations.
static ChangeMasterAltDateOneToOneLink<ChangeMaster>	TO_CHANGE_MASTER Use with available fluent helpers to apply the to_ChangeMaster navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
ChangeMasterAltDate()
ChangeMasterAltDate(String changeNumber, String chgNmbrAlternativeDateCounter, LocalDateTime chgNmbrAlternativeDate, String chgNmbrAlternativeDateText, Boolean chgNmbrAltvDateIsAssignedToObj, ChangeMaster toChangeMaster)

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 ChangeMasterAltDate.ChangeMasterAltDateBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ChangeMaster	fetchChangeMaster() Fetches the ChangeMaster entity (one to one) associated with this entity.
static <T> ChangeMasterAltDateField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ChangeMasterAltDateField<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)
io.vavr.control.Option<ChangeMaster>	getChangeMasterIfPresent() Retrieval of associated ChangeMaster entity (one to one).
ChangeMaster	getChangeMasterOrFetch() Retrieval of associated ChangeMaster entity (one to one).
String	getChangeNumber() (Key Field) Constraints: Not nullable, Maximum length: 12
LocalDateTime	getChgNmbrAlternativeDate() Constraints: Not nullable, Precision: 0
String	getChgNmbrAlternativeDateCounter() (Key Field) Constraints: Not nullable, Maximum length: 3
String	getChgNmbrAlternativeDateText() Constraints: Not nullable, Maximum length: 18
Boolean	getChgNmbrAltvDateIsAssignedToObj() Constraints: none
protected String	getDefaultServicePath()
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection()
protected Map<String,Object>	getKey()
Class<ChangeMasterAltDate>	getType()
int	hashCode()
void	setChangeMaster(ChangeMaster value) Overwrites the associated ChangeMaster entity for the loaded navigation property to_ChangeMaster.
void	setChangeNumber(String changeNumber) (Key Field) Constraints: Not nullable, Maximum length: 12
void	setChgNmbrAlternativeDate(LocalDateTime chgNmbrAlternativeDate) Constraints: Not nullable, Precision: 0
void	setChgNmbrAlternativeDateCounter(String chgNmbrAlternativeDateCounter) (Key Field) Constraints: Not nullable, Maximum length: 3
void	setChgNmbrAlternativeDateText(String chgNmbrAlternativeDateText) Constraints: Not nullable, Maximum length: 18
void	setChgNmbrAltvDateIsAssignedToObj(Boolean chgNmbrAltvDateIsAssignedToObj) Constraints: none
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.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 ChangeMasterAltDateSelectable ALL_FIELDS

Selector for all available fields of ChangeMasterAltDate.

CHANGE_NUMBER

public static final ChangeMasterAltDateField<String> CHANGE_NUMBER

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

CHG_NMBR_ALTERNATIVE_DATE_COUNTER

public static final ChangeMasterAltDateField<String> CHG_NMBR_ALTERNATIVE_DATE_COUNTER

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

CHG_NMBR_ALTERNATIVE_DATE

public static final ChangeMasterAltDateField<LocalDateTime> CHG_NMBR_ALTERNATIVE_DATE

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

CHG_NMBR_ALTERNATIVE_DATE_TEXT

public static final ChangeMasterAltDateField<String> CHG_NMBR_ALTERNATIVE_DATE_TEXT

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

CHG_NMBR_ALTV_DATE_IS_ASSIGNED_TO_OBJ

public static final ChangeMasterAltDateField<Boolean> CHG_NMBR_ALTV_DATE_IS_ASSIGNED_TO_OBJ

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

TO_CHANGE_MASTER

public static final ChangeMasterAltDateOneToOneLink<ChangeMaster> TO_CHANGE_MASTER

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

Constructor Detail

ChangeMasterAltDate

public ChangeMasterAltDate()

ChangeMasterAltDate

public ChangeMasterAltDate(@Nullable
                           String changeNumber,
                           @Nullable
                           String chgNmbrAlternativeDateCounter,
                           @Nullable
                           LocalDateTime chgNmbrAlternativeDate,
                           @Nullable
                           String chgNmbrAlternativeDateText,
                           @Nullable
                           Boolean chgNmbrAltvDateIsAssignedToObj,
                           @Nullable
                           ChangeMaster toChangeMaster)

Method Detail

getType

@Nonnull
public Class<ChangeMasterAltDate> getType()

Specified by:

getType in class VdmObject<ChangeMasterAltDate>

Returns:

The class of this object.

setChangeNumber

public void setChangeNumber(@Nullable
                            String changeNumber)

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

Original property name from the Odata EDM: ChangeNumber

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 conditionsThe 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 madeDocumentation of the changesAssignment of a revision level to a change state of a material or documentRelease of changes for the different areas in the company

Parameters:

changeNumber - Number used to uniquely identify a change master record.

setChgNmbrAlternativeDateCounter

public void setChgNmbrAlternativeDateCounter(@Nullable
                                             String chgNmbrAlternativeDateCounter)

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

Original property name from the Odata EDM: ChgNmbrAlternativeDateCounter

Parameters:

chgNmbrAlternativeDateCounter - Engineering change management: alternative date counter

setChgNmbrAlternativeDate

public void setChgNmbrAlternativeDate(@Nullable
                                      LocalDateTime chgNmbrAlternativeDate)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: ChgNmbrAlternativeDate

The system determines the date from the corresponding change master record. If the change object is not assigned to an alternative date, the date is then the valid-from date in the change header.

Parameters:

chgNmbrAlternativeDate - Date, from which the change object (for example, document) change is effective with the corresponding change number.

setChgNmbrAlternativeDateText

public void setChgNmbrAlternativeDateText(@Nullable
                                          String chgNmbrAlternativeDateText)

Constraints: Not nullable, Maximum length: 18

Original property name from the Odata EDM: ChgNmbrAlternativeDateText

Parameters:

chgNmbrAlternativeDateText - Key that uniquely identifies a valid-from date that differs from the valid-from date (change header).

setChgNmbrAltvDateIsAssignedToObj

public void setChgNmbrAltvDateIsAssignedToObj(@Nullable
                                              Boolean chgNmbrAltvDateIsAssignedToObj)

Constraints: none

Original property name from the Odata EDM: ChgNmbrAltvDateIsAssignedToObj

Parameters:

chgNmbrAltvDateIsAssignedToObj - Objects Allocated

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<ChangeMasterAltDate>

getKey

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

Overrides:

getKey in class VdmObject<ChangeMasterAltDate>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ChangeMasterAltDate>

fromMap

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

Overrides:

fromMap in class VdmObject<ChangeMasterAltDate>

field

@Nonnull
public static <T> ChangeMasterAltDateField<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> ChangeMasterAltDateField<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<ChangeMasterAltDate>

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

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

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

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<ChangeMasterAltDate>

fetchChangeMaster

@Nullable
public ChangeMaster fetchChangeMaster()
                                         throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getChangeMasterOrFetch

@Nullable
public ChangeMaster getChangeMasterOrFetch()
                                              throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated ChangeMaster entity (one to one). This corresponds to the OData navigation property to_ChangeMaster.

If the navigation property to_ChangeMaster of a queried ChangeMasterAltDate 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 ChangeMaster 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.

getChangeMasterIfPresent

@Nonnull
public io.vavr.control.Option<ChangeMaster> getChangeMasterIfPresent()

Retrieval of associated ChangeMaster entity (one to one). This corresponds to the OData navigation property to_ChangeMaster.

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

setChangeMaster

public void setChangeMaster(ChangeMaster value)

Overwrites the associated ChangeMaster entity for the loaded navigation property to_ChangeMaster.

Parameters:

value - New ChangeMaster entity.

builder

public static ChangeMasterAltDate.ChangeMasterAltDateBuilder builder()

getChangeNumber

@Nullable
public String getChangeNumber()

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

Original property name from the Odata EDM: ChangeNumber

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 conditionsThe 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 madeDocumentation of the changesAssignment of a revision level to a change state of a material or documentRelease of changes for the different areas in the company

Returns:

Number used to uniquely identify a change master record.

getChgNmbrAlternativeDateCounter

@Nullable
public String getChgNmbrAlternativeDateCounter()

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

Original property name from the Odata EDM: ChgNmbrAlternativeDateCounter

Returns:

Engineering change management: alternative date counter

getChgNmbrAlternativeDate

@Nullable
public LocalDateTime getChgNmbrAlternativeDate()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: ChgNmbrAlternativeDate

The system determines the date from the corresponding change master record. If the change object is not assigned to an alternative date, the date is then the valid-from date in the change header.

Returns:

Date, from which the change object (for example, document) change is effective with the corresponding change number.

getChgNmbrAlternativeDateText

@Nullable
public String getChgNmbrAlternativeDateText()

Constraints: Not nullable, Maximum length: 18

Original property name from the Odata EDM: ChgNmbrAlternativeDateText

Returns:

Key that uniquely identifies a valid-from date that differs from the valid-from date (change header).

getChgNmbrAltvDateIsAssignedToObj

@Nullable
public Boolean getChgNmbrAltvDateIsAssignedToObj()

Constraints: none

Original property name from the Odata EDM: ChgNmbrAltvDateIsAssignedToObj

Returns:

Objects Allocated

toString

public String toString()

Overrides:

toString in class VdmObject<ChangeMasterAltDate>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<ChangeMasterAltDate>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<ChangeMasterAltDate>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ChangeMasterAltDate>