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

Class ChangeMasterStatus

java.lang.Object

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

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

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

public class ChangeMasterStatus
extends VdmEntity<ChangeMasterStatus>

API for Change Number Status

Original entity name from the Odata EDM: A_ChangeMasterStatusType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ChangeMasterStatusSelectable	ALL_FIELDS Selector for all available fields of ChangeMasterStatus.
static ChangeMasterStatusField<Boolean>	CHANGE_IS_ALLOWED Use with available fluent helpers to apply the ChangeIsAllowed field to query operations.
static ChangeMasterStatusField<String>	CHANGE_NUMBER_STATUS Use with available fluent helpers to apply the ChangeNumberStatus field to query operations.
static ChangeMasterStatusField<Boolean>	DATE_CHANGE_IS_ALLOWED Use with available fluent helpers to apply the DateChangeIsAllowed field to query operations.
static ChangeMasterStatusField<Boolean>	DISTRIBUTION_IS_LOCKED Use with available fluent helpers to apply the DistributionIsLocked field to query operations.
static ChangeMasterStatusLink<ChangeMasterStatusText>	TO_TEXT Use with available fluent helpers to apply the to_Text navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
ChangeMasterStatus()
ChangeMasterStatus(String changeNumberStatus, Boolean changeIsAllowed, Boolean dateChangeIsAllowed, Boolean distributionIsLocked, List<ChangeMasterStatusText> toText)

Method Summary

Modifier and Type	Method and Description
void	addText(ChangeMasterStatusText... entity) Adds elements to the list of associated ChangeMasterStatusText entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static ChangeMasterStatus.ChangeMasterStatusBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<ChangeMasterStatusText>	fetchText() Fetches the ChangeMasterStatusText entities (one to many) associated with this entity.
static <T> ChangeMasterStatusField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ChangeMasterStatusField<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)
Boolean	getChangeIsAllowed() Constraints: none
String	getChangeNumberStatus() (Key Field) Constraints: Not nullable, Maximum length: 2
Boolean	getDateChangeIsAllowed() Constraints: none
protected String	getDefaultServicePath()
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
Boolean	getDistributionIsLocked() Constraints: none
protected String	getEntityCollection()
protected Map<String,Object>	getKey()
io.vavr.control.Option<List<ChangeMasterStatusText>>	getTextIfPresent() Retrieval of associated ChangeMasterStatusText entities (one to many).
List<ChangeMasterStatusText>	getTextOrFetch() Retrieval of associated ChangeMasterStatusText entities (one to many).
Class<ChangeMasterStatus>	getType()
int	hashCode()
void	setChangeIsAllowed(Boolean changeIsAllowed) Constraints: none
void	setChangeNumberStatus(String changeNumberStatus) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setDateChangeIsAllowed(Boolean dateChangeIsAllowed) Constraints: none
void	setDistributionIsLocked(Boolean distributionIsLocked) Constraints: none
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setText(List<ChangeMasterStatusText> value) Overwrites the list of associated ChangeMasterStatusText entities for the loaded navigation property to_Text.
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 ChangeMasterStatusSelectable ALL_FIELDS

Selector for all available fields of ChangeMasterStatus.

CHANGE_NUMBER_STATUS

public static final ChangeMasterStatusField<String> CHANGE_NUMBER_STATUS

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

CHANGE_IS_ALLOWED

public static final ChangeMasterStatusField<Boolean> CHANGE_IS_ALLOWED

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

DATE_CHANGE_IS_ALLOWED

public static final ChangeMasterStatusField<Boolean> DATE_CHANGE_IS_ALLOWED

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

DISTRIBUTION_IS_LOCKED

public static final ChangeMasterStatusField<Boolean> DISTRIBUTION_IS_LOCKED

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

TO_TEXT

public static final ChangeMasterStatusLink<ChangeMasterStatusText> TO_TEXT

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

Constructor Detail

ChangeMasterStatus

public ChangeMasterStatus()

ChangeMasterStatus

public ChangeMasterStatus(@Nullable
                          String changeNumberStatus,
                          @Nullable
                          Boolean changeIsAllowed,
                          @Nullable
                          Boolean dateChangeIsAllowed,
                          @Nullable
                          Boolean distributionIsLocked,
                          List<ChangeMasterStatusText> toText)

Method Detail

getType

@Nonnull
public Class<ChangeMasterStatus> getType()

Specified by:

getType in class VdmObject<ChangeMasterStatus>

Returns:

The class of this object.

setChangeNumberStatus

public void setChangeNumberStatus(@Nullable
                                  String changeNumberStatus)

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

Original property name from the Odata EDM: ChangeNumberStatus

Parameters:

changeNumberStatus - Status of Change Number

setChangeIsAllowed

public void setChangeIsAllowed(@Nullable
                               Boolean changeIsAllowed)

Constraints: none

Original property name from the Odata EDM: ChangeIsAllowed

Parameters:

changeIsAllowed - Status allows changes

setDateChangeIsAllowed

public void setDateChangeIsAllowed(@Nullable
                                   Boolean dateChangeIsAllowed)

Constraints: none

Original property name from the Odata EDM: DateChangeIsAllowed

Parameters:

dateChangeIsAllowed - Valid-from date can be changed

setDistributionIsLocked

public void setDistributionIsLocked(@Nullable
                                    Boolean distributionIsLocked)

Constraints: none

Original property name from the Odata EDM: DistributionIsLocked

Parameters:

distributionIsLocked - Indicator: Distribution lock

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<ChangeMasterStatus>

getKey

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

Overrides:

getKey in class VdmObject<ChangeMasterStatus>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ChangeMasterStatus>

fromMap

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

Overrides:

fromMap in class VdmObject<ChangeMasterStatus>

field

@Nonnull
public static <T> ChangeMasterStatusField<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> ChangeMasterStatusField<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<ChangeMasterStatus>

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

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

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

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<ChangeMasterStatus>

fetchText

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

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

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

Returns:

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

getTextOrFetch

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

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

If the navigation property to_Text of a queried ChangeMasterStatus 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 ChangeMasterStatusText 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.

getTextIfPresent

@Nonnull
public io.vavr.control.Option<List<ChangeMasterStatusText>> getTextIfPresent()

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

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

setText

public void setText(@Nonnull
                    List<ChangeMasterStatusText> value)

Overwrites the list of associated ChangeMasterStatusText entities for the loaded navigation property to_Text.

If the navigation property to_Text of a queried ChangeMasterStatus 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 ChangeMasterStatusText entities.

addText

public void addText(ChangeMasterStatusText... entity)

Adds elements to the list of associated ChangeMasterStatusText entities. This corresponds to the OData navigation property to_Text.

If the navigation property to_Text of a queried ChangeMasterStatus 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 ChangeMasterStatusText entities.

builder

public static ChangeMasterStatus.ChangeMasterStatusBuilder builder()

getChangeNumberStatus

@Nullable
public String getChangeNumberStatus()

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

Original property name from the Odata EDM: ChangeNumberStatus

Returns:

Status of Change Number

getChangeIsAllowed

@Nullable
public Boolean getChangeIsAllowed()

Constraints: none

Original property name from the Odata EDM: ChangeIsAllowed

Returns:

Status allows changes

getDateChangeIsAllowed

@Nullable
public Boolean getDateChangeIsAllowed()

Constraints: none

Original property name from the Odata EDM: DateChangeIsAllowed

Returns:

Valid-from date can be changed

getDistributionIsLocked

@Nullable
public Boolean getDistributionIsLocked()

Constraints: none

Original property name from the Odata EDM: DistributionIsLocked

Returns:

Indicator: Distribution lock

toString

public String toString()

Overrides:

toString in class VdmObject<ChangeMasterStatus>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<ChangeMasterStatus>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<ChangeMasterStatus>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ChangeMasterStatus>