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

Class BusinessPartnerContact

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesspartner.BusinessPartnerContact

public class BusinessPartnerContact
extends VdmEntity<BusinessPartnerContact>

Business Partner Contact

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BusinessPartnerContact.BusinessPartnerContactBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static BusinessPartnerContactSelectable	ALL_FIELDS Selector for all available fields of BusinessPartnerContact.
static BusinessPartnerContactField<String>	BUSINESS_PARTNER_COMPANY Use with available fluent helpers to apply the BusinessPartnerCompany field to query operations.
static BusinessPartnerContactField<String>	BUSINESS_PARTNER_PERSON Use with available fluent helpers to apply the BusinessPartnerPerson field to query operations.
static BusinessPartnerContactField<Boolean>	IS_STANDARD_RELATIONSHIP Use with available fluent helpers to apply the IsStandardRelationship field to query operations.
static BusinessPartnerContactField<String>	RELATIONSHIP_CATEGORY Use with available fluent helpers to apply the RelationshipCategory field to query operations.
static BusinessPartnerContactField<String>	RELATIONSHIP_NUMBER Use with available fluent helpers to apply the RelationshipNumber field to query operations.
static BusinessPartnerContactLink<BPContactToAddress>	TO_CONTACT_ADDRESS Use with available fluent helpers to apply the to_ContactAddress navigation property to query operations.
static BusinessPartnerContactLink<BPContactToFuncAndDept>	TO_CONTACT_RELATIONSHIP Use with available fluent helpers to apply the to_ContactRelationship navigation property to query operations.
static BusinessPartnerContactField<Calendar>	VALIDITY_END_DATE Use with available fluent helpers to apply the ValidityEndDate field to query operations.
static BusinessPartnerContactField<Calendar>	VALIDITY_START_DATE Use with available fluent helpers to apply the ValidityStartDate field to query operations.

Constructor Summary

Constructors

Constructor and Description
BusinessPartnerContact()
BusinessPartnerContact(String relationshipNumber, String businessPartnerCompany, String businessPartnerPerson, Calendar validityEndDate, Calendar validityStartDate, Boolean isStandardRelationship, String relationshipCategory, ErpConfigContext erpConfigContext, List<BPContactToAddress> toContactAddress, BPContactToFuncAndDept toContactRelationship)

Method Summary

Modifier and Type	Method and Description
void	addContactAddress(BPContactToAddress... entity) Adds elements to the list of associated BPContactToAddress entities.
static BusinessPartnerContact.BusinessPartnerContactBuilder	builder()
boolean	equals(Object o)
List<BPContactToAddress>	fetchContactAddress() Fetches the BPContactToAddress entities (one to many) associated with this entity.
BPContactToFuncAndDept	fetchContactRelationship() Fetches the BPContactToFuncAndDept entity (one to one) associated with this entity.
static <T> BusinessPartnerContactField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getBusinessPartnerCompany() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getBusinessPartnerPerson() (Key Field) Constraints: Not nullable, Maximum length: 10
List<BPContactToAddress>	getContactAddressOrFetch() Retrieval of associated BPContactToAddress entities (one to many).
com.google.common.base.Optional<List<BPContactToAddress>>	getContactAddressOrNull() Retrieval of associated BPContactToAddress entities (one to many).
BPContactToFuncAndDept	getContactRelationshipOrFetch() Retrieval of associated BPContactToFuncAndDept entity (one to one).
com.google.common.base.Optional<BPContactToFuncAndDept>	getContactRelationshipOrNull() Retrieval of associated BPContactToFuncAndDept entity (one to one).
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
Boolean	getIsStandardRelationship() Constraints: noneIf several relationships of the BP relationship category contact person have been defined for, you can set the indicator standard relationship for one of these relationships.A relationship that is marked as a standard relationship can be used whenA certain scenario automatically selects a contact personThe contact person responsible is not knownYou can give this indicator to only one business partner relationship of a BP relationship category for a particular period.
String	getRelationshipCategory() Constraints: Not nullable, Maximum length: 6 A distinction is made between a one-way and an undirected business partner relationship category.
String	getRelationshipNumber() (Key Field) Constraints: Not nullable, Maximum length: 12
Class<BusinessPartnerContact>	getType()
Calendar	getValidityEndDate() (Key Field) Constraints: Not nullable, Precision: 0
Calendar	getValidityStartDate() Constraints: Not nullable, Precision: 0
int	hashCode()
void	setBusinessPartnerCompany(String businessPartnerCompany) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setBusinessPartnerPerson(String businessPartnerPerson) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setContactAddress(List<BPContactToAddress> value) Overwrites the list of associated BPContactToAddress entities for the loaded navigation property to_ContactAddress.
void	setContactRelationship(BPContactToFuncAndDept value) Overwrites the associated BPContactToFuncAndDept entity for the loaded navigation property to_ContactRelationship.
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
void	setIsStandardRelationship(Boolean isStandardRelationship) Constraints: noneIf several relationships of the BP relationship category contact person have been defined for, you can set the indicator standard relationship for one of these relationships.A relationship that is marked as a standard relationship can be used whenA certain scenario automatically selects a contact personThe contact person responsible is not knownYou can give this indicator to only one business partner relationship of a BP relationship category for a particular period.
void	setRelationshipCategory(String relationshipCategory) Constraints: Not nullable, Maximum length: 6 A distinction is made between a one-way and an undirected business partner relationship category.
void	setRelationshipNumber(String relationshipNumber) (Key Field) Constraints: Not nullable, Maximum length: 12
void	setValidityEndDate(Calendar validityEndDate) (Key Field) Constraints: Not nullable, Precision: 0
void	setValidityStartDate(Calendar validityStartDate) Constraints: Not nullable, Precision: 0
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 BusinessPartnerContactSelectable ALL_FIELDS

Selector for all available fields of BusinessPartnerContact.

RELATIONSHIP_NUMBER

public static final BusinessPartnerContactField<String> RELATIONSHIP_NUMBER

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

BUSINESS_PARTNER_COMPANY

public static final BusinessPartnerContactField<String> BUSINESS_PARTNER_COMPANY

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

BUSINESS_PARTNER_PERSON

public static final BusinessPartnerContactField<String> BUSINESS_PARTNER_PERSON

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

VALIDITY_END_DATE

public static final BusinessPartnerContactField<Calendar> VALIDITY_END_DATE

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

VALIDITY_START_DATE

public static final BusinessPartnerContactField<Calendar> VALIDITY_START_DATE

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

IS_STANDARD_RELATIONSHIP

public static final BusinessPartnerContactField<Boolean> IS_STANDARD_RELATIONSHIP

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

RELATIONSHIP_CATEGORY

public static final BusinessPartnerContactField<String> RELATIONSHIP_CATEGORY

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

TO_CONTACT_ADDRESS

public static final BusinessPartnerContactLink<BPContactToAddress> TO_CONTACT_ADDRESS

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

TO_CONTACT_RELATIONSHIP

public static final BusinessPartnerContactLink<BPContactToFuncAndDept> TO_CONTACT_RELATIONSHIP

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

Constructor Detail

BusinessPartnerContact

public BusinessPartnerContact()

BusinessPartnerContact

public BusinessPartnerContact(@Nullable
                              String relationshipNumber,
                              @Nullable
                              String businessPartnerCompany,
                              @Nullable
                              String businessPartnerPerson,
                              @Nullable
                              Calendar validityEndDate,
                              @Nullable
                              Calendar validityStartDate,
                              @Nullable
                              Boolean isStandardRelationship,
                              @Nullable
                              String relationshipCategory,
                              @Nullable
                              ErpConfigContext erpConfigContext,
                              List<BPContactToAddress> toContactAddress,
                              @Nullable
                              BPContactToFuncAndDept toContactRelationship)

Method Detail

getType

public Class<BusinessPartnerContact> getType()

Specified by:

getType in class VdmObject<BusinessPartnerContact>

Returns:

The class of this object.

field

public static <T> BusinessPartnerContactField<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.

fetchContactAddress

public List<BPContactToAddress> fetchContactAddress()
                                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getContactAddressOrFetch

public List<BPContactToAddress> getContactAddressOrFetch()
                                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated BPContactToAddress entities (one to many).

If the navigation property to_ContactAddress of a queried BusinessPartnerContact 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 BPContactToAddress 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.

getContactAddressOrNull

public com.google.common.base.Optional<List<BPContactToAddress>> getContactAddressOrNull()

Retrieval of associated BPContactToAddress entities (one to many).

If the navigation property to_ContactAddress for an entity BusinessPartnerContact 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_ContactAddress is already loaded, the result will contain the BPContactToAddress entities. If not, a null value state is returned.

setContactAddress

public void setContactAddress(@NonNull
                              List<BPContactToAddress> value)

Overwrites the list of associated BPContactToAddress entities for the loaded navigation property to_ContactAddress.

If the navigation property to_ContactAddress of a queried BusinessPartnerContact 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 BPContactToAddress entities.

addContactAddress

public void addContactAddress(BPContactToAddress... entity)

Adds elements to the list of associated BPContactToAddress entities.

If the navigation property to_ContactAddress of a queried BusinessPartnerContact 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 BPContactToAddress entities.

fetchContactRelationship

public BPContactToFuncAndDept fetchContactRelationship()
                                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getContactRelationshipOrFetch

public BPContactToFuncAndDept getContactRelationshipOrFetch()
                                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated BPContactToFuncAndDept entity (one to one).

If the navigation property to_ContactRelationship of a queried BusinessPartnerContact 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 BPContactToFuncAndDept 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.

getContactRelationshipOrNull

public com.google.common.base.Optional<BPContactToFuncAndDept> getContactRelationshipOrNull()

Retrieval of associated BPContactToFuncAndDept entity (one to one).

If the navigation property to_ContactRelationship for an entity BusinessPartnerContact 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_ContactRelationship is already loaded, the result will contain the BPContactToFuncAndDept entity. If not, a null value state is returned.

setContactRelationship

public void setContactRelationship(BPContactToFuncAndDept value)

Overwrites the associated BPContactToFuncAndDept entity for the loaded navigation property to_ContactRelationship.

Parameters:

value - New BPContactToFuncAndDept entity.

builder

public static BusinessPartnerContact.BusinessPartnerContactBuilder builder()

getRelationshipNumber

@Nullable
public String getRelationshipNumber()

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

Returns:

The business partner relationship number is an internal number that identifies the business partner relationship set.

getBusinessPartnerCompany

@Nullable
public String getBusinessPartnerCompany()

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

Returns:

Key identifying a business partner in the SAP system. The key is unique within a client.

getBusinessPartnerPerson

@Nullable
public String getBusinessPartnerPerson()

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

Returns:

Key identifying a business partner in the SAP system. The key is unique within a client.

getValidityEndDate

@Nullable
public Calendar getValidityEndDate()

(Key Field) Constraints: Not nullable, Precision: 0

Returns:

Validity Date (Valid To)

getValidityStartDate

@Nullable
public Calendar getValidityStartDate()

Constraints: Not nullable, Precision: 0

Returns:

Validity Date (Valid From)

getIsStandardRelationship

@Nullable
public Boolean getIsStandardRelationship()

Constraints: none

If several relationships of the BP relationship category contact person have been defined for, you can set the indicator standard relationship for one of these relationships.A relationship that is marked as a standard relationship can be used whenA certain scenario automatically selects a contact personThe contact person responsible is not knownYou can give this indicator to only one business partner relationship of a BP relationship category for a particular period. Another relationship of the same relationship category can be indicated as the standard relationship only if the periods for the relationship do not overlap or coincide.

Returns:

States whether the relationship is a standard relationship.

getRelationshipCategory

@Nullable
public String getRelationshipCategory()

Constraints: Not nullable, Maximum length: 6

A distinction is made between a one-way and an undirected business partner relationship category. In a one-way relationship category, the relationship extends from one partner to another, but not vice versa.Marriage (undirected)Employee (one-way)Contact person (one-way)

Returns:

A relationship may exist between two business partners. The business partner relationship category characterizes the features of the relationship.

getErpConfigContext

@Nullable
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.

setRelationshipNumber

public void setRelationshipNumber(@Nullable
                                  String relationshipNumber)

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

Parameters:

relationshipNumber -

setBusinessPartnerCompany

public void setBusinessPartnerCompany(@Nullable
                                      String businessPartnerCompany)

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

Parameters:

businessPartnerCompany -

setBusinessPartnerPerson

public void setBusinessPartnerPerson(@Nullable
                                     String businessPartnerPerson)

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

Parameters:

businessPartnerPerson -

setValidityEndDate

public void setValidityEndDate(@Nullable
                               Calendar validityEndDate)

(Key Field) Constraints: Not nullable, Precision: 0

Parameters:

validityEndDate -

setValidityStartDate

public void setValidityStartDate(@Nullable
                                 Calendar validityStartDate)

Constraints: Not nullable, Precision: 0

Parameters:

validityStartDate -

setIsStandardRelationship

public void setIsStandardRelationship(@Nullable
                                      Boolean isStandardRelationship)

Constraints: none

If several relationships of the BP relationship category contact person have been defined for, you can set the indicator standard relationship for one of these relationships.A relationship that is marked as a standard relationship can be used whenA certain scenario automatically selects a contact personThe contact person responsible is not knownYou can give this indicator to only one business partner relationship of a BP relationship category for a particular period. Another relationship of the same relationship category can be indicated as the standard relationship only if the periods for the relationship do not overlap or coincide.

Parameters:

isStandardRelationship -

setRelationshipCategory

public void setRelationshipCategory(@Nullable
                                    String relationshipCategory)

Constraints: Not nullable, Maximum length: 6

A distinction is made between a one-way and an undirected business partner relationship category. In a one-way relationship category, the relationship extends from one partner to another, but not vice versa.Marriage (undirected)Employee (one-way)Contact person (one-way)

Parameters:

relationshipCategory -

setErpConfigContext

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

public String toString()

Overrides:

toString in class VdmObject<BusinessPartnerContact>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<BusinessPartnerContact>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BusinessPartnerContact>