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

Class BillingDocumentItemPartner

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPartner

public class BillingDocumentItemPartner
extends VdmEntity<BillingDocumentItemPartner>

Billing Document Item Partners (API)

Original entity name from the Odata EDM: A_BillingDocumentItemPartnerType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static BillingDocumentItemPartnerSelectable	ALL_FIELDS Selector for all available fields of BillingDocumentItemPartner.
static BillingDocumentItemPartnerField<String>	BILLING_DOCUMENT Use with available fluent helpers to apply the BillingDocument field to query operations.
static BillingDocumentItemPartnerField<String>	BILLING_DOCUMENT_ITEM Use with available fluent helpers to apply the BillingDocumentItem field to query operations.
static BillingDocumentItemPartnerField<String>	CONTACT_PERSON Use with available fluent helpers to apply the ContactPerson field to query operations.
static BillingDocumentItemPartnerField<String>	CUSTOMER Use with available fluent helpers to apply the Customer field to query operations.
static BillingDocumentItemPartnerField<String>	PARTNER_FUNCTION Use with available fluent helpers to apply the PartnerFunction field to query operations.
static BillingDocumentItemPartnerField<String>	PERSONNEL Use with available fluent helpers to apply the Personnel field to query operations.
static BillingDocumentItemPartnerField<String>	SUPPLIER Use with available fluent helpers to apply the Supplier field to query operations.
static BillingDocumentItemPartnerOneToOneLink<BillingDocument>	TO_BILLING_DOCUMENT Use with available fluent helpers to apply the to_BillingDocument navigation property to query operations.
static BillingDocumentItemPartnerOneToOneLink<BillingDocumentItem>	TO_BILLING_DOCUMENT_ITEM Use with available fluent helpers to apply the to_BillingDocumentItem 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
BillingDocumentItemPartner()
BillingDocumentItemPartner(String billingDocument, String billingDocumentItem, String partnerFunction, String customer, String supplier, String personnel, String contactPerson, BillingDocument toBillingDocument, BillingDocumentItem toBillingDocumentItem)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static BillingDocumentItemPartner.BillingDocumentItemPartnerBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BillingDocument	fetchBillingDocument() Fetches the BillingDocument entity (one to one) associated with this entity.
BillingDocumentItem	fetchBillingDocumentItem() Fetches the BillingDocumentItem entity (one to one) associated with this entity.
static <T> BillingDocumentItemPartnerField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> BillingDocumentItemPartnerField<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	getBillingDocument() (Key Field) Constraints: Not nullable, Maximum length: 10
Optional<BillingDocument>	getBillingDocumentIfPresent() Retrieval of associated BillingDocument entity (one to one).
String	getBillingDocumentItem() (Key Field) Constraints: Not nullable, Maximum length: 6
Optional<BillingDocumentItem>	getBillingDocumentItemIfPresent() Retrieval of associated BillingDocumentItem entity (one to one).
BillingDocumentItem	getBillingDocumentItemOrFetch() Retrieval of associated BillingDocumentItem entity (one to one).
BillingDocument	getBillingDocumentOrFetch() Retrieval of associated BillingDocument entity (one to one).
String	getContactPerson() Constraints: Not nullable, Maximum length: 10
String	getCustomer() Constraints: Not nullable, Maximum length: 10
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()
String	getPartnerFunction() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getPersonnel() Constraints: Not nullable, Maximum length: 8
String	getSupplier() Constraints: Not nullable, Maximum length: 10
Class<BillingDocumentItemPartner>	getType()
int	hashCode()
void	setBillingDocument(BillingDocument value) Overwrites the associated BillingDocument entity for the loaded navigation property to_BillingDocument.
void	setBillingDocument(String billingDocument) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setBillingDocumentItem(BillingDocumentItem value) Overwrites the associated BillingDocumentItem entity for the loaded navigation property to_BillingDocumentItem.
void	setBillingDocumentItem(String billingDocumentItem) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setContactPerson(String contactPerson) Constraints: Not nullable, Maximum length: 10
void	setCustomer(String customer) Constraints: Not nullable, Maximum length: 10
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
void	setPartnerFunction(String partnerFunction) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setPersonnel(String personnel) Constraints: Not nullable, Maximum length: 8
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setSupplier(String supplier) Constraints: Not nullable, Maximum length: 10
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 BillingDocumentItemPartnerSelectable ALL_FIELDS

Selector for all available fields of BillingDocumentItemPartner.

BILLING_DOCUMENT

public static final BillingDocumentItemPartnerField<String> BILLING_DOCUMENT

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

BILLING_DOCUMENT_ITEM

public static final BillingDocumentItemPartnerField<String> BILLING_DOCUMENT_ITEM

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

PARTNER_FUNCTION

public static final BillingDocumentItemPartnerField<String> PARTNER_FUNCTION

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

CUSTOMER

public static final BillingDocumentItemPartnerField<String> CUSTOMER

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

SUPPLIER

public static final BillingDocumentItemPartnerField<String> SUPPLIER

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

PERSONNEL

public static final BillingDocumentItemPartnerField<String> PERSONNEL

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

CONTACT_PERSON

public static final BillingDocumentItemPartnerField<String> CONTACT_PERSON

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

TO_BILLING_DOCUMENT

public static final BillingDocumentItemPartnerOneToOneLink<BillingDocument> TO_BILLING_DOCUMENT

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

TO_BILLING_DOCUMENT_ITEM

public static final BillingDocumentItemPartnerOneToOneLink<BillingDocumentItem> TO_BILLING_DOCUMENT_ITEM

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

Constructor Detail

BillingDocumentItemPartner

public BillingDocumentItemPartner()

BillingDocumentItemPartner

public BillingDocumentItemPartner(@Nullable
                                  String billingDocument,
                                  @Nullable
                                  String billingDocumentItem,
                                  @Nullable
                                  String partnerFunction,
                                  @Nullable
                                  String customer,
                                  @Nullable
                                  String supplier,
                                  @Nullable
                                  String personnel,
                                  @Nullable
                                  String contactPerson,
                                  @Nullable
                                  BillingDocument toBillingDocument,
                                  @Nullable
                                  BillingDocumentItem toBillingDocumentItem)

Method Detail

getType

@Nonnull
public Class<BillingDocumentItemPartner> getType()

Specified by:

getType in class VdmObject<BillingDocumentItemPartner>

Returns:

The class of this object.

setBillingDocument

public void setBillingDocument(@Nullable
                               String billingDocument)

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

Original property name from the Odata EDM: BillingDocument

Parameters:

billingDocument - The number that uniquely identifies the billing document (the invoice, for example).

setBillingDocumentItem

public void setBillingDocumentItem(@Nullable
                                   String billingDocumentItem)

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

Original property name from the Odata EDM: BillingDocumentItem

Parameters:

billingDocumentItem - The number that uniquely identifies the item in the billing document.

setPartnerFunction

public void setPartnerFunction(@Nullable
                               String partnerFunction)

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

Original property name from the Odata EDM: PartnerFunction

Parameters:

partnerFunction - The abbreviated form of the name that identifies the partner function.

setCustomer

public void setCustomer(@Nullable
                        String customer)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: Customer

Parameters:

customer - Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system.

setSupplier

public void setSupplier(@Nullable
                        String supplier)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: Supplier

Parameters:

supplier - Specifies an alphanumeric key that uniquely identifies the supplier in the SAP system.

setPersonnel

public void setPersonnel(@Nullable
                         String personnel)

Constraints: Not nullable, Maximum length: 8

Original property name from the Odata EDM: Personnel

Parameters:

personnel - The personnel number is the only feature within a client which is unique to an employee. You have to enter a personnel number before you can display and maintain an employee's master data and time data.

setContactPerson

public void setContactPerson(@Nullable
                             String contactPerson)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: ContactPerson

Parameters:

contactPerson - The number that uniquely identifies the contact person.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<BillingDocumentItemPartner>

getKey

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

Overrides:

getKey in class VdmObject<BillingDocumentItemPartner>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<BillingDocumentItemPartner>

fromMap

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

Overrides:

fromMap in class VdmObject<BillingDocumentItemPartner>

field

@Nonnull
public static <T> BillingDocumentItemPartnerField<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> BillingDocumentItemPartnerField<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<BillingDocumentItemPartner>

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

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

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

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

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<BillingDocumentItemPartner>

fetchBillingDocument

@Nullable
public BillingDocument fetchBillingDocument()
                                               throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getBillingDocumentOrFetch

@Nullable
public BillingDocument getBillingDocumentOrFetch()
                                                    throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated BillingDocument entity (one to one). This corresponds to the OData navigation property to_BillingDocument.

If the navigation property to_BillingDocument of a queried BillingDocumentItemPartner 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 BillingDocument 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.

getBillingDocumentIfPresent

@Nonnull
public Optional<BillingDocument> getBillingDocumentIfPresent()

Retrieval of associated BillingDocument entity (one to one). This corresponds to the OData navigation property to_BillingDocument.

If the navigation property for an entity BillingDocumentItemPartner 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_BillingDocument is already loaded, the result will contain the BillingDocument entity. If not, an Optional with result state empty is returned.

setBillingDocument

public void setBillingDocument(BillingDocument value)

Overwrites the associated BillingDocument entity for the loaded navigation property to_BillingDocument.

Parameters:

value - New BillingDocument entity.

fetchBillingDocumentItem

@Nullable
public BillingDocumentItem fetchBillingDocumentItem()
                                                       throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getBillingDocumentItemOrFetch

@Nullable
public BillingDocumentItem getBillingDocumentItemOrFetch()
                                                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated BillingDocumentItem entity (one to one). This corresponds to the OData navigation property to_BillingDocumentItem.

If the navigation property to_BillingDocumentItem of a queried BillingDocumentItemPartner 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 BillingDocumentItem 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.

getBillingDocumentItemIfPresent

@Nonnull
public Optional<BillingDocumentItem> getBillingDocumentItemIfPresent()

Retrieval of associated BillingDocumentItem entity (one to one). This corresponds to the OData navigation property to_BillingDocumentItem.

If the navigation property for an entity BillingDocumentItemPartner 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_BillingDocumentItem is already loaded, the result will contain the BillingDocumentItem entity. If not, an Optional with result state empty is returned.

setBillingDocumentItem

public void setBillingDocumentItem(BillingDocumentItem value)

Overwrites the associated BillingDocumentItem entity for the loaded navigation property to_BillingDocumentItem.

Parameters:

value - New BillingDocumentItem entity.

builder

public static BillingDocumentItemPartner.BillingDocumentItemPartnerBuilder builder()

getBillingDocument

@Nullable
public String getBillingDocument()

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

Original property name from the Odata EDM: BillingDocument

Returns:

The number that uniquely identifies the billing document (the invoice, for example).

getBillingDocumentItem

@Nullable
public String getBillingDocumentItem()

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

Original property name from the Odata EDM: BillingDocumentItem

Returns:

The number that uniquely identifies the item in the billing document.

getPartnerFunction

@Nullable
public String getPartnerFunction()

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

Original property name from the Odata EDM: PartnerFunction

Returns:

The abbreviated form of the name that identifies the partner function.

getCustomer

@Nullable
public String getCustomer()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: Customer

Returns:

Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system.

getSupplier

@Nullable
public String getSupplier()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: Supplier

Returns:

Specifies an alphanumeric key that uniquely identifies the supplier in the SAP system.

getPersonnel

@Nullable
public String getPersonnel()

Constraints: Not nullable, Maximum length: 8

Original property name from the Odata EDM: Personnel

Returns:

The personnel number is the only feature within a client which is unique to an employee. You have to enter a personnel number before you can display and maintain an employee's master data and time data.

getContactPerson

@Nullable
public String getContactPerson()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: ContactPerson

Returns:

The number that uniquely identifies the contact person.

toString

public String toString()

Overrides:

toString in class VdmObject<BillingDocumentItemPartner>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<BillingDocumentItemPartner>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<BillingDocumentItemPartner>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BillingDocumentItemPartner>