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

Class PaymentReleaseListHeader

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentitem.PaymentReleaseListHeader

public class PaymentReleaseListHeader
extends VdmEntity<PaymentReleaseListHeader>

Payment Header

Original entity name from the Odata EDM: PaymentReleaseListHeader

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static PaymentReleaseListHeaderSelectable	ALL_FIELDS Selector for all available fields of PaymentReleaseListHeader.
static PaymentReleaseListHeaderField<String>	COMPANYCODE Use with available fluent helpers to apply the Companycode field to query operations.
static PaymentReleaseListHeaderField<String>	CREATEDBYUSER Use with available fluent helpers to apply the Createdbyuser field to query operations.
static PaymentReleaseListHeaderField<String>	CREATEDBYUSERFULLNAME Use with available fluent helpers to apply the Createdbyuserfullname field to query operations.
static PaymentReleaseListHeaderField<String>	INCGPAYTFILETOTALNUMBEROFITEMS Use with available fluent helpers to apply the Incgpaytfiletotalnumberofitems field to query operations.
static PaymentReleaseListHeaderField<String>	PAYMENTRELEASELIST Use with available fluent helpers to apply the Paymentreleaselist field to query operations.
static PaymentReleaseListHeaderLink<PaymentReleaseListItem>	TO_PAYMENT_RELEASE_LIST_HEADERTO_ITEM Use with available fluent helpers to apply the PaymentReleaseListHeadertoItem navigation property to query operations.
static PaymentReleaseListHeaderField<BigDecimal>	TOTACTUALAMTINDISPLAYCURRENCY Use with available fluent helpers to apply the Totactualamtindisplaycurrency field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
PaymentReleaseListHeader()
PaymentReleaseListHeader(String paymentreleaselist, BigDecimal totactualamtindisplaycurrency, String createdbyuserfullname, String incgpaytfiletotalnumberofitems, String createdbyuser, String companycode, List<PaymentReleaseListItem> toPaymentReleaseListHeadertoItem)

Method Summary

Modifier and Type	Method and Description
void	addPaymentReleaseListHeadertoItem(PaymentReleaseListItem... entity) Adds elements to the list of associated PaymentReleaseListItem entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static PaymentReleaseListHeader.PaymentReleaseListHeaderBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<PaymentReleaseListItem>	fetchPaymentReleaseListHeadertoItem() Fetches the PaymentReleaseListItem entities (one to many) associated with this entity.
static <T> PaymentReleaseListHeaderField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> PaymentReleaseListHeaderField<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	getCompanycode() Constraints: Not nullable, Maximum length: 4
String	getCreatedbyuser() Constraints: Not nullable, Maximum length: 12
String	getCreatedbyuserfullname() Constraints: Not nullable, Maximum length: 80
protected String	getDefaultServicePath() Used by fluent helpers and navigation property methods to construct OData queries.
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
String	getIncgpaytfiletotalnumberofitems() Constraints: Not nullable, Maximum length: 255
protected Map<String,Object>	getKey()
String	getPaymentreleaselist() (Key Field) Constraints: Not nullable, Maximum length: 10
io.vavr.control.Option<List<PaymentReleaseListItem>>	getPaymentReleaseListHeadertoItemIfPresent() Retrieval of associated PaymentReleaseListItem entities (one to many).
List<PaymentReleaseListItem>	getPaymentReleaseListHeadertoItemOrFetch() Retrieval of associated PaymentReleaseListItem entities (one to many).
BigDecimal	getTotactualamtindisplaycurrency() Constraints: Not nullable, Precision: 24, Scale: 3
Class<PaymentReleaseListHeader>	getType()
int	hashCode()
void	setCompanycode(String companycode) Constraints: Not nullable, Maximum length: 4
void	setCreatedbyuser(String createdbyuser) Constraints: Not nullable, Maximum length: 12
void	setCreatedbyuserfullname(String createdbyuserfullname) Constraints: Not nullable, Maximum length: 80
void	setIncgpaytfiletotalnumberofitems(String incgpaytfiletotalnumberofitems) Constraints: Not nullable, Maximum length: 255
void	setPaymentreleaselist(String paymentreleaselist) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setPaymentReleaseListHeadertoItem(List<PaymentReleaseListItem> value) Overwrites the list of associated PaymentReleaseListItem entities for the loaded navigation property PaymentReleaseListHeadertoItem.
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setTotactualamtindisplaycurrency(BigDecimal totactualamtindisplaycurrency) Constraints: Not nullable, Precision: 24, Scale: 3
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 PaymentReleaseListHeaderSelectable ALL_FIELDS

Selector for all available fields of PaymentReleaseListHeader.

PAYMENTRELEASELIST

public static final PaymentReleaseListHeaderField<String> PAYMENTRELEASELIST

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

TOTACTUALAMTINDISPLAYCURRENCY

public static final PaymentReleaseListHeaderField<BigDecimal> TOTACTUALAMTINDISPLAYCURRENCY

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

CREATEDBYUSERFULLNAME

public static final PaymentReleaseListHeaderField<String> CREATEDBYUSERFULLNAME

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

INCGPAYTFILETOTALNUMBEROFITEMS

public static final PaymentReleaseListHeaderField<String> INCGPAYTFILETOTALNUMBEROFITEMS

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

CREATEDBYUSER

public static final PaymentReleaseListHeaderField<String> CREATEDBYUSER

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

COMPANYCODE

public static final PaymentReleaseListHeaderField<String> COMPANYCODE

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

TO_PAYMENT_RELEASE_LIST_HEADERTO_ITEM

public static final PaymentReleaseListHeaderLink<PaymentReleaseListItem> TO_PAYMENT_RELEASE_LIST_HEADERTO_ITEM

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

Constructor Detail

PaymentReleaseListHeader

public PaymentReleaseListHeader()

PaymentReleaseListHeader

public PaymentReleaseListHeader(@Nullable
                                String paymentreleaselist,
                                @Nullable
                                BigDecimal totactualamtindisplaycurrency,
                                @Nullable
                                String createdbyuserfullname,
                                @Nullable
                                String incgpaytfiletotalnumberofitems,
                                @Nullable
                                String createdbyuser,
                                @Nullable
                                String companycode,
                                List<PaymentReleaseListItem> toPaymentReleaseListHeadertoItem)

Method Detail

getType

@Nonnull
public Class<PaymentReleaseListHeader> getType()

Specified by:

getType in class VdmObject<PaymentReleaseListHeader>

Returns:

The class of this object.

setPaymentreleaselist

public void setPaymentreleaselist(@Nullable
                                  String paymentreleaselist)

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

Original property name from the Odata EDM: Paymentreleaselist

Parameters:

paymentreleaselist - Uniquely identifies a list created in the Payment Release List application and is generated by the application.

setTotactualamtindisplaycurrency

public void setTotactualamtindisplaycurrency(@Nullable
                                             BigDecimal totactualamtindisplaycurrency)

Constraints: Not nullable, Precision: 24, Scale: 3

Original property name from the Odata EDM: Totactualamtindisplaycurrency

Parameters:

totactualamtindisplaycurrency - TOTACTUALAMTINDISPLAYCURRENCY

setCreatedbyuserfullname

public void setCreatedbyuserfullname(@Nullable
                                     String createdbyuserfullname)

Constraints: Not nullable, Maximum length: 80

Original property name from the Odata EDM: Createdbyuserfullname

Parameters:

createdbyuserfullname - User Description

setIncgpaytfiletotalnumberofitems

public void setIncgpaytfiletotalnumberofitems(@Nullable
                                              String incgpaytfiletotalnumberofitems)

Constraints: Not nullable, Maximum length: 255

Original property name from the Odata EDM: Incgpaytfiletotalnumberofitems

Parameters:

incgpaytfiletotalnumberofitems - INCGPAYTFILETOTALNUMBEROFITEMS

setCreatedbyuser

public void setCreatedbyuser(@Nullable
                             String createdbyuser)

Constraints: Not nullable, Maximum length: 12

Original property name from the Odata EDM: Createdbyuser

Parameters:

createdbyuser - Created By

setCompanycode

public void setCompanycode(@Nullable
                           String companycode)

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: Companycode

Parameters:

companycode - The company code is an organizational unit within financial accounting.

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<PaymentReleaseListHeader>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<PaymentReleaseListHeader>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<PaymentReleaseListHeader>

fromMap

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

Overrides:

fromMap in class VdmObject<PaymentReleaseListHeader>

field

@Nonnull
public static <T> PaymentReleaseListHeaderField<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> PaymentReleaseListHeaderField<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<PaymentReleaseListHeader>

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

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

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()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<PaymentReleaseListHeader>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<PaymentReleaseListHeader>

fetchPaymentReleaseListHeadertoItem

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

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

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

Returns:

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

getPaymentReleaseListHeadertoItemOrFetch

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

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

If the navigation property PaymentReleaseListHeadertoItem of a queried PaymentReleaseListHeader 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 PaymentReleaseListItem 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.

getPaymentReleaseListHeadertoItemIfPresent

@Nonnull
public io.vavr.control.Option<List<PaymentReleaseListItem>> getPaymentReleaseListHeadertoItemIfPresent()

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

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

setPaymentReleaseListHeadertoItem

public void setPaymentReleaseListHeadertoItem(@Nonnull
                                              List<PaymentReleaseListItem> value)

Overwrites the list of associated PaymentReleaseListItem entities for the loaded navigation property PaymentReleaseListHeadertoItem.

If the navigation property PaymentReleaseListHeadertoItem of a queried PaymentReleaseListHeader 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 PaymentReleaseListItem entities.

addPaymentReleaseListHeadertoItem

public void addPaymentReleaseListHeadertoItem(PaymentReleaseListItem... entity)

Adds elements to the list of associated PaymentReleaseListItem entities. This corresponds to the OData navigation property PaymentReleaseListHeadertoItem.

If the navigation property PaymentReleaseListHeadertoItem of a queried PaymentReleaseListHeader 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 PaymentReleaseListItem entities.

builder

@Nonnull
public static PaymentReleaseListHeader.PaymentReleaseListHeaderBuilder builder()

getPaymentreleaselist

@Nullable
public String getPaymentreleaselist()

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

Original property name from the Odata EDM: Paymentreleaselist

Returns:

Uniquely identifies a list created in the Payment Release List application and is generated by the application.

getTotactualamtindisplaycurrency

@Nullable
public BigDecimal getTotactualamtindisplaycurrency()

Constraints: Not nullable, Precision: 24, Scale: 3

Original property name from the Odata EDM: Totactualamtindisplaycurrency

Returns:

TOTACTUALAMTINDISPLAYCURRENCY

getCreatedbyuserfullname

@Nullable
public String getCreatedbyuserfullname()

Constraints: Not nullable, Maximum length: 80

Original property name from the Odata EDM: Createdbyuserfullname

Returns:

User Description

getIncgpaytfiletotalnumberofitems

@Nullable
public String getIncgpaytfiletotalnumberofitems()

Constraints: Not nullable, Maximum length: 255

Original property name from the Odata EDM: Incgpaytfiletotalnumberofitems

Returns:

INCGPAYTFILETOTALNUMBEROFITEMS

getCreatedbyuser

@Nullable
public String getCreatedbyuser()

Constraints: Not nullable, Maximum length: 12

Original property name from the Odata EDM: Createdbyuser

Returns:

Created By

getCompanycode

@Nullable
public String getCompanycode()

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: Companycode

Returns:

The company code is an organizational unit within financial accounting.

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<PaymentReleaseListHeader>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<PaymentReleaseListHeader>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<PaymentReleaseListHeader>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<PaymentReleaseListHeader>