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

Class BillingDocumentType

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.masterdataforgroupreporting.BillingDocumentType

public class BillingDocumentType
extends VdmEntity<BillingDocumentType>

Combined Billing Type

Original entity name from the Odata EDM: BillingDocumentTypeType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static BillingDocumentTypeField<String>	ADDITIONAL_MASTER_DATA_SOURCE Use with available fluent helpers to apply the AdditionalMasterDataSource field to query operations.
static BillingDocumentTypeSelectable	ALL_FIELDS Selector for all available fields of BillingDocumentType.
static BillingDocumentTypeField<String>	BILLING_DOCUMENT_TYPE Use with available fluent helpers to apply the BillingDocumentType field to query operations.
static BillingDocumentTypeField<String>	BILLING_DOCUMENT_TYPE_TEXT Use with available fluent helpers to apply the BillingDocumentType_Text field to query operations.
static BillingDocumentTypeLink<BillingDocumentTypeText>	TO_CNSLDTN_BILLING_TYPE_T Use with available fluent helpers to apply the to_CnsldtnBillingTypeT navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
BillingDocumentType()
BillingDocumentType(String billingDocumentType, String billingDocumentType_Text, String additionalMasterDataSource, List<BillingDocumentTypeText> toCnsldtnBillingTypeT)

Method Summary

Modifier and Type	Method and Description
void	addCnsldtnBillingTypeT(BillingDocumentTypeText... entity) Adds elements to the list of associated BillingDocumentTypeText entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static BillingDocumentType.BillingDocumentTypeBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<BillingDocumentTypeText>	fetchCnsldtnBillingTypeT() Fetches the BillingDocumentTypeText entities (one to many) associated with this entity.
static <T> BillingDocumentTypeField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> BillingDocumentTypeField<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	getAdditionalMasterDataSource() Constraints: Not nullable, Maximum length: 10
String	getBillingDocumentType_Text() Constraints: Not nullable, Maximum length: 40
String	getBillingDocumentType() (Key Field) Constraints: Not nullable, Maximum length: 4
io.vavr.control.Option<List<BillingDocumentTypeText>>	getCnsldtnBillingTypeTIfPresent() Retrieval of associated BillingDocumentTypeText entities (one to many).
List<BillingDocumentTypeText>	getCnsldtnBillingTypeTOrFetch() Retrieval of associated BillingDocumentTypeText entities (one to many).
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.
protected Map<String,Object>	getKey()
Class<BillingDocumentType>	getType()
int	hashCode()
void	setAdditionalMasterDataSource(String additionalMasterDataSource) Constraints: Not nullable, Maximum length: 10
void	setBillingDocumentType_Text(String billingDocumentType_Text) Constraints: Not nullable, Maximum length: 40
void	setBillingDocumentType(String billingDocumentType) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setCnsldtnBillingTypeT(List<BillingDocumentTypeText> value) Overwrites the list of associated BillingDocumentTypeText entities for the loaded navigation property to_CnsldtnBillingTypeT.
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 BillingDocumentTypeSelectable ALL_FIELDS

Selector for all available fields of BillingDocumentType.

BILLING_DOCUMENT_TYPE

public static final BillingDocumentTypeField<String> BILLING_DOCUMENT_TYPE

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

BILLING_DOCUMENT_TYPE_TEXT

public static final BillingDocumentTypeField<String> BILLING_DOCUMENT_TYPE_TEXT

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

ADDITIONAL_MASTER_DATA_SOURCE

public static final BillingDocumentTypeField<String> ADDITIONAL_MASTER_DATA_SOURCE

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

TO_CNSLDTN_BILLING_TYPE_T

public static final BillingDocumentTypeLink<BillingDocumentTypeText> TO_CNSLDTN_BILLING_TYPE_T

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

Constructor Detail

BillingDocumentType

public BillingDocumentType()

BillingDocumentType

public BillingDocumentType(@Nullable
                           String billingDocumentType,
                           @Nullable
                           String billingDocumentType_Text,
                           @Nullable
                           String additionalMasterDataSource,
                           List<BillingDocumentTypeText> toCnsldtnBillingTypeT)

Method Detail

getType

@Nonnull
public Class<BillingDocumentType> getType()

Specified by:

getType in class VdmObject<BillingDocumentType>

Returns:

The class of this object.

setBillingDocumentType

public void setBillingDocumentType(@Nullable
                                   String billingDocumentType)

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

Original property name from the Odata EDM: BillingDocumentType

When you process billing documents collectively, you can use the billing type as one of the selection criteria.

Parameters:

billingDocumentType - Classifies types of billing document that require different processing by the system.

setBillingDocumentType_Text

public void setBillingDocumentType_Text(@Nullable
                                        String billingDocumentType_Text)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: BillingDocumentType_Text

Parameters:

billingDocumentType_Text - Billing Document Type Description

setAdditionalMasterDataSource

public void setAdditionalMasterDataSource(@Nullable
                                          String additionalMasterDataSource)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: AdditionalMasterDataSource

Parameters:

additionalMasterDataSource - Master Data Source

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<BillingDocumentType>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<BillingDocumentType>

fromMap

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

Overrides:

fromMap in class VdmObject<BillingDocumentType>

field

@Nonnull
public static <T> BillingDocumentTypeField<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> BillingDocumentTypeField<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<BillingDocumentType>

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

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

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

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

fetchCnsldtnBillingTypeT

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

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

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

Returns:

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

getCnsldtnBillingTypeTOrFetch

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

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

If the navigation property to_CnsldtnBillingTypeT of a queried BillingDocumentType 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 BillingDocumentTypeText 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.

getCnsldtnBillingTypeTIfPresent

@Nonnull
public io.vavr.control.Option<List<BillingDocumentTypeText>> getCnsldtnBillingTypeTIfPresent()

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

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

setCnsldtnBillingTypeT

public void setCnsldtnBillingTypeT(@Nonnull
                                   List<BillingDocumentTypeText> value)

Overwrites the list of associated BillingDocumentTypeText entities for the loaded navigation property to_CnsldtnBillingTypeT.

If the navigation property to_CnsldtnBillingTypeT of a queried BillingDocumentType 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 BillingDocumentTypeText entities.

addCnsldtnBillingTypeT

public void addCnsldtnBillingTypeT(BillingDocumentTypeText... entity)

Adds elements to the list of associated BillingDocumentTypeText entities. This corresponds to the OData navigation property to_CnsldtnBillingTypeT.

If the navigation property to_CnsldtnBillingTypeT of a queried BillingDocumentType 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 BillingDocumentTypeText entities.

builder

public static BillingDocumentType.BillingDocumentTypeBuilder builder()

getBillingDocumentType

@Nullable
public String getBillingDocumentType()

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

Original property name from the Odata EDM: BillingDocumentType

When you process billing documents collectively, you can use the billing type as one of the selection criteria.

Returns:

Classifies types of billing document that require different processing by the system.

getBillingDocumentType_Text

@Nullable
public String getBillingDocumentType_Text()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: BillingDocumentType_Text

Returns:

Billing Document Type Description

getAdditionalMasterDataSource

@Nullable
public String getAdditionalMasterDataSource()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: AdditionalMasterDataSource

Returns:

Master Data Source

toString

public String toString()

Overrides:

toString in class VdmObject<BillingDocumentType>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<BillingDocumentType>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<BillingDocumentType>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BillingDocumentType>