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

Class BillingDocumentPartner

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readbillingdocuments.BillingDocumentPartner

public class BillingDocumentPartner
extends VdmEntity<BillingDocumentPartner>

Billing Document Partners (API)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BillingDocumentPartner.BillingDocumentPartnerBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static EntityFieldAll<BillingDocumentPartner>	ALL_FIELDS Selector for all available fields of BillingDocumentPartner.
static BillingDocumentPartnerField<String>	BILLING_DOCUMENT Use with available fluent helpers to apply the BillingDocument field to query operations.
static BillingDocumentPartnerField<String>	CONTACT_PERSON Use with available fluent helpers to apply the ContactPerson field to query operations.
static BillingDocumentPartnerField<String>	CUSTOMER Use with available fluent helpers to apply the Customer field to query operations.
static BillingDocumentPartnerField<String>	PARTNER_FUNCTION Use with available fluent helpers to apply the PartnerFunction field to query operations.
static BillingDocumentPartnerField<String>	PERSONNEL Use with available fluent helpers to apply the Personnel field to query operations.
static BillingDocumentPartnerField<String>	SUPPLIER Use with available fluent helpers to apply the Supplier field to query operations.
static BillingDocumentPartnerLink<BillingDocument>	TO_BILLING_DOCUMENT Use with available fluent helpers to apply the to_BillingDocument navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
BillingDocumentPartner()
BillingDocumentPartner(String billingDocument, String partnerFunction, String customer, String supplier, String personnel, String contactPerson, ErpConfigContext erpConfigContext, BillingDocument toBillingDocument)

Method Summary

Modifier and Type	Method and Description
static BillingDocumentPartner.BillingDocumentPartnerBuilder	builder()
boolean	equals(Object o)
BillingDocument	fetchBillingDocument() Fetches the BillingDocument entity (one to one) associated with this entity.
static <T> BillingDocumentPartnerField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getBillingDocument() (Key Field) Constraints: Not nullable, Maximum length: 10
BillingDocument	getBillingDocumentOrFetch() Retrieval of associated BillingDocument entity (one to one).
com.google.common.base.Optional<BillingDocument>	getBillingDocumentOrNull() Retrieval of associated BillingDocument entity (one to one).
String	getContactPerson() Constraints: Not nullable, Maximum length: 10
String	getCustomer() Constraints: Not nullable, Maximum length: 10
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
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<BillingDocumentPartner>	getType()
int	hashCode()
void	setBillingDocument(BillingDocument value) Overwrites the associated BillingDocument entity for the loaded navigation property to_BillingDocument.
void	setBillingDocument(String value) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setContactPerson(String contactPerson) Constraints: Not nullable, Maximum length: 10
void	setCustomer(String customer) Constraints: Not nullable, Maximum length: 10
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setPartnerFunction(String partnerFunction) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setPersonnel(String personnel) Constraints: Not nullable, Maximum length: 8
void	setSupplier(String supplier) Constraints: Not nullable, Maximum length: 10
String	toString()

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

getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final EntityFieldAll<BillingDocumentPartner> ALL_FIELDS

Selector for all available fields of BillingDocumentPartner.

BILLING_DOCUMENT

public static final BillingDocumentPartnerField<String> BILLING_DOCUMENT

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

PARTNER_FUNCTION

public static final BillingDocumentPartnerField<String> PARTNER_FUNCTION

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

CUSTOMER

public static final BillingDocumentPartnerField<String> CUSTOMER

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

SUPPLIER

public static final BillingDocumentPartnerField<String> SUPPLIER

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

PERSONNEL

public static final BillingDocumentPartnerField<String> PERSONNEL

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

CONTACT_PERSON

public static final BillingDocumentPartnerField<String> CONTACT_PERSON

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

TO_BILLING_DOCUMENT

public static final BillingDocumentPartnerLink<BillingDocument> TO_BILLING_DOCUMENT

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

Constructor Detail

BillingDocumentPartner

@Generated(value="lombok")
public BillingDocumentPartner()

BillingDocumentPartner

@ConstructorProperties(value={"billingDocument","partnerFunction","customer","supplier","personnel","contactPerson","erpConfigContext","toBillingDocument"})
 @Generated(value="lombok")
public BillingDocumentPartner(@Nullable
                                                                                                                                                                                                                       String billingDocument,
                                                                                                                                                                                                                       @Nullable
                                                                                                                                                                                                                       String partnerFunction,
                                                                                                                                                                                                                       @Nullable
                                                                                                                                                                                                                       String customer,
                                                                                                                                                                                                                       @Nullable
                                                                                                                                                                                                                       String supplier,
                                                                                                                                                                                                                       @Nullable
                                                                                                                                                                                                                       String personnel,
                                                                                                                                                                                                                       @Nullable
                                                                                                                                                                                                                       String contactPerson,
                                                                                                                                                                                                                       @Nullable
                                                                                                                                                                                                                       ErpConfigContext erpConfigContext,
                                                                                                                                                                                                                       @Nullable
                                                                                                                                                                                                                       BillingDocument toBillingDocument)

Method Detail

getType

public Class<BillingDocumentPartner> getType()

Specified by:

getType in class VdmObject<BillingDocumentPartner>

Returns:

The class of this object.

field

public static <T> BillingDocumentPartnerField<T> field(String fieldName,
                                                       Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

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.

fetchBillingDocument

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

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

Retrieval of associated BillingDocument entity (one to one).

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

getBillingDocumentOrNull

public com.google.common.base.Optional<BillingDocument> getBillingDocumentOrNull()

Retrieval of associated BillingDocument entity (one to one).

If the navigation property to_BillingDocument for an entity BillingDocumentPartner has not been resolved yet, this method will not query further information. Instead its Optional result state will be null.

Returns:

If the information for navigation property to_BillingDocument is already loaded, the result will contain the BillingDocument entity. If not, a null value state 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.

setBillingDocument

public void setBillingDocument(String value)

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

Parameters:

value - billingDocument

builder

@Generated(value="lombok")
public static BillingDocumentPartner.BillingDocumentPartnerBuilder builder()

getBillingDocument

@Nullable
 @Generated(value="lombok")
public String getBillingDocument()

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

Returns:

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

getPartnerFunction

@Nullable
 @Generated(value="lombok")
public String getPartnerFunction()

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

The ship-to party in your system could be abbreviated, for example, to "SH".

Returns:

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

getCustomer

@Nullable
 @Generated(value="lombok")
public String getCustomer()

Constraints: Not nullable, Maximum length: 10

Returns:

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

getSupplier

@Nullable
 @Generated(value="lombok")
public String getSupplier()

Constraints: Not nullable, Maximum length: 10

Returns:

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

getPersonnel

@Nullable
 @Generated(value="lombok")
public String getPersonnel()

Constraints: Not nullable, Maximum length: 8

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
 @Generated(value="lombok")
public String getContactPerson()

Constraints: Not nullable, Maximum length: 10

Returns:

The number that uniquely identifies the contact person.

getErpConfigContext

@Nullable
 @Generated(value="lombok")
public ErpConfigContext getErpConfigContext()

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setPartnerFunction

@Generated(value="lombok")
public void setPartnerFunction(@Nullable
                                                          String partnerFunction)

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

The ship-to party in your system could be abbreviated, for example, to "SH".

Parameters:

partnerFunction -

setCustomer

@Generated(value="lombok")
public void setCustomer(@Nullable
                                                   String customer)

Constraints: Not nullable, Maximum length: 10

Parameters:

customer -

setSupplier

@Generated(value="lombok")
public void setSupplier(@Nullable
                                                   String supplier)

Constraints: Not nullable, Maximum length: 10

Parameters:

supplier -

setPersonnel

@Generated(value="lombok")
public void setPersonnel(@Nullable
                                                    String personnel)

Constraints: Not nullable, Maximum length: 8

Parameters:

personnel -

setContactPerson

@Generated(value="lombok")
public void setContactPerson(@Nullable
                                                        String contactPerson)

Constraints: Not nullable, Maximum length: 10

Parameters:

contactPerson -

setErpConfigContext

@Generated(value="lombok")
public void setErpConfigContext(@Nullable
                                                           ErpConfigContext erpConfigContext)

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Parameters:

erpConfigContext -

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class VdmObject<BillingDocumentPartner>

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class VdmObject<BillingDocumentPartner>

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class VdmObject<BillingDocumentPartner>