java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<BusinessPartnerContact>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesspartner.BusinessPartnerContact

public class BusinessPartnerContact extends VdmEntity<BusinessPartnerContact>
Contact

Original entity name from the Odata EDM: A_BusinessPartnerContactType

  • Field Details

    • 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<LocalDateTime> VALIDITY_END_DATE
      Use with available fluent helpers to apply the ValidityEndDate field to query operations.
    • VALIDITY_START_DATE

      public static final BusinessPartnerContactField<LocalDateTime> 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 BusinessPartnerContactOneToOneLink<BPContactToFuncAndDept> TO_CONTACT_RELATIONSHIP
      Use with available fluent helpers to apply the to_ContactRelationship navigation property to query operations.
  • Constructor Details

  • Method Details

    • getType

      @Nonnull public Class<BusinessPartnerContact> getType()
      Specified by:
      getType in class VdmObject<BusinessPartnerContact>
    • setRelationshipNumber

      public void setRelationshipNumber(@Nullable String relationshipNumber)
      (Key Field) Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: RelationshipNumber

      Parameters:
      relationshipNumber - BP Relationship Number
    • setBusinessPartnerCompany

      public void setBusinessPartnerCompany(@Nullable String businessPartnerCompany)
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: BusinessPartnerCompany

      Parameters:
      businessPartnerCompany - Business Partner Number
    • setBusinessPartnerPerson

      public void setBusinessPartnerPerson(@Nullable String businessPartnerPerson)
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: BusinessPartnerPerson

      Parameters:
      businessPartnerPerson - Business Partner Number
    • setValidityEndDate

      public void setValidityEndDate(@Nullable LocalDateTime validityEndDate)
      (Key Field) Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ValidityEndDate

      Parameters:
      validityEndDate - Validity Date (Valid To)
    • setValidityStartDate

      public void setValidityStartDate(@Nullable LocalDateTime validityStartDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ValidityStartDate

      Parameters:
      validityStartDate - Validity Date (Valid From)
    • setIsStandardRelationship

      public void setIsStandardRelationship(@Nullable Boolean isStandardRelationship)
      Constraints: none

      Original property name from the Odata EDM: IsStandardRelationship

      Parameters:
      isStandardRelationship - Standard Relationship
    • setRelationshipCategory

      public void setRelationshipCategory(@Nullable String relationshipCategory)
      Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: RelationshipCategory

      Parameters:
      relationshipCategory - Business Partner Relationship Category
    • getEntityCollection

      protected String getEntityCollection()
      Specified by:
      getEntityCollection in class VdmEntity<BusinessPartnerContact>
    • getKey

      @Nonnull protected Map<String,Object> getKey()
      Overrides:
      getKey in class VdmObject<BusinessPartnerContact>
    • toMapOfFields

      @Nonnull protected Map<String,Object> toMapOfFields()
      Overrides:
      toMapOfFields in class VdmObject<BusinessPartnerContact>
    • fromMap

      protected void fromMap(Map<String,Object> inputValues)
      Overrides:
      fromMap in class VdmObject<BusinessPartnerContact>
    • field

      @Nonnull public static <T> BusinessPartnerContactField<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> BusinessPartnerContactField<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<T, DomainT> 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()
      Overrides:
      getDestinationForFetch in class VdmEntity<BusinessPartnerContact>
    • setServicePathForFetch

      protected void setServicePathForFetch(@Nullable String servicePathForFetch)
      Overrides:
      setServicePathForFetch in class VdmEntity<BusinessPartnerContact>
    • attachToService

      public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
      Overrides:
      attachToService in class VdmEntity<BusinessPartnerContact>
    • getDefaultServicePath

      protected String getDefaultServicePath()
      Overrides:
      getDefaultServicePath in class VdmEntity<BusinessPartnerContact>
    • toMapOfNavigationProperties

      @Nonnull protected Map<String,Object> toMapOfNavigationProperties()
      Overrides:
      toMapOfNavigationProperties in class VdmObject<BusinessPartnerContact>
    • fetchContactAddress

      @Nonnull public List<BPContactToAddress> fetchContactAddress()
      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.datamodel.odata.client.exception.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

      @Nonnull public List<BPContactToAddress> getContactAddressOrFetch()
      Retrieval of associated BPContactToAddress entities (one to many). This corresponds to the OData 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.

      Returns:
      List of associated BPContactToAddress entities.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.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.
    • getContactAddressIfPresent

      @Nonnull public io.vavr.control.Option<List<BPContactToAddress>> getContactAddressIfPresent()
      Retrieval of associated BPContactToAddress entities (one to many). This corresponds to the OData navigation property to_ContactAddress.

      If the navigation property for an entity BusinessPartnerContact 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_ContactAddress is already loaded, the result will contain the BPContactToAddress entities. If not, an Option with result state empty 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. This corresponds to the OData 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:
      entity - Array of BPContactToAddress entities.
    • fetchContactRelationship

      @Nullable public BPContactToFuncAndDept fetchContactRelationship()
      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.datamodel.odata.client.exception.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

      @Nullable public BPContactToFuncAndDept getContactRelationshipOrFetch()
      Retrieval of associated BPContactToFuncAndDept entity (one to one). This corresponds to the OData navigation property to_ContactRelationship.

      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.datamodel.odata.client.exception.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.
    • getContactRelationshipIfPresent

      @Nonnull public io.vavr.control.Option<BPContactToFuncAndDept> getContactRelationshipIfPresent()
      Retrieval of associated BPContactToFuncAndDept entity (one to one). This corresponds to the OData navigation property to_ContactRelationship.

      If the navigation property for an entity BusinessPartnerContact 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_ContactRelationship is already loaded, the result will contain the BPContactToFuncAndDept entity. If not, an Option with result state empty 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

      @Nonnull public static BusinessPartnerContact.BusinessPartnerContactBuilder builder()
    • getRelationshipNumber

      @Nullable public String getRelationshipNumber()
      (Key Field) Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: RelationshipNumber

      Returns:
      BP Relationship Number
    • getBusinessPartnerCompany

      @Nullable public String getBusinessPartnerCompany()
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: BusinessPartnerCompany

      Returns:
      Business Partner Number
    • getBusinessPartnerPerson

      @Nullable public String getBusinessPartnerPerson()
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: BusinessPartnerPerson

      Returns:
      Business Partner Number
    • getValidityEndDate

      @Nullable public LocalDateTime getValidityEndDate()
      (Key Field) Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ValidityEndDate

      Returns:
      Validity Date (Valid To)
    • getValidityStartDate

      @Nullable public LocalDateTime getValidityStartDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ValidityStartDate

      Returns:
      Validity Date (Valid From)
    • getIsStandardRelationship

      @Nullable public Boolean getIsStandardRelationship()
      Constraints: none

      Original property name from the Odata EDM: IsStandardRelationship

      Returns:
      Standard Relationship
    • getRelationshipCategory

      @Nullable public String getRelationshipCategory()
      Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: RelationshipCategory

      Returns:
      Business Partner Relationship Category
    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class VdmObject<BusinessPartnerContact>
    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class VdmEntity<BusinessPartnerContact>
    • canEqual

      protected boolean canEqual(@Nullable Object other)
      Overrides:
      canEqual in class VdmEntity<BusinessPartnerContact>
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class VdmEntity<BusinessPartnerContact>