public class BusinessPartnerAddress extends VdmEntity<BusinessPartnerAddress>
Original entity name from the Odata EDM: A_BusinessPartnerAddressType
Modifier and Type | Class and Description |
---|---|
static class |
BusinessPartnerAddress.BusinessPartnerAddressBuilder |
Modifier and Type | Field and Description |
---|---|
static BusinessPartnerAddressField<String> |
ADDITIONAL_STREET_PREFIX_NAME
Use with available fluent helpers to apply the AdditionalStreetPrefixName field to query operations.
|
static BusinessPartnerAddressField<String> |
ADDITIONAL_STREET_SUFFIX_NAME
Use with available fluent helpers to apply the AdditionalStreetSuffixName field to query operations.
|
static BusinessPartnerAddressField<String> |
ADDRESS_ID
Use with available fluent helpers to apply the AddressID field to query operations.
|
static BusinessPartnerAddressField<String> |
ADDRESS_ID_BY_EXTERNAL_SYSTEM
Use with available fluent helpers to apply the AddressIDByExternalSystem field to query operations.
|
static BusinessPartnerAddressField<String> |
ADDRESS_TIME_ZONE
Use with available fluent helpers to apply the AddressTimeZone field to query operations.
|
static BusinessPartnerAddressField<UUID> |
ADDRESS_UUID
Use with available fluent helpers to apply the AddressUUID field to query operations.
|
static BusinessPartnerAddressSelectable |
ALL_FIELDS
Selector for all available fields of BusinessPartnerAddress.
|
static BusinessPartnerAddressField<String> |
AUTHORIZATION_GROUP
Use with available fluent helpers to apply the AuthorizationGroup field to query operations.
|
static BusinessPartnerAddressField<String> |
BUSINESS_PARTNER
Use with available fluent helpers to apply the BusinessPartner field to query operations.
|
static BusinessPartnerAddressField<String> |
CARE_OF_NAME
Use with available fluent helpers to apply the CareOfName field to query operations.
|
static BusinessPartnerAddressField<String> |
CITY_CODE
Use with available fluent helpers to apply the CityCode field to query operations.
|
static BusinessPartnerAddressField<String> |
CITY_NAME
Use with available fluent helpers to apply the CityName field to query operations.
|
static BusinessPartnerAddressField<String> |
COMPANY_POSTAL_CODE
Use with available fluent helpers to apply the CompanyPostalCode field to query operations.
|
static BusinessPartnerAddressField<String> |
COUNTRY
Use with available fluent helpers to apply the Country field to query operations.
|
static BusinessPartnerAddressField<String> |
COUNTY
Use with available fluent helpers to apply the County field to query operations.
|
static BusinessPartnerAddressField<String> |
DELIVERY_SERVICE_NUMBER
Use with available fluent helpers to apply the DeliveryServiceNumber field to query operations.
|
static BusinessPartnerAddressField<String> |
DELIVERY_SERVICE_TYPE_CODE
Use with available fluent helpers to apply the DeliveryServiceTypeCode field to query operations.
|
static BusinessPartnerAddressField<String> |
DISTRICT
Use with available fluent helpers to apply the District field to query operations.
|
static BusinessPartnerAddressField<String> |
FORM_OF_ADDRESS
Use with available fluent helpers to apply the FormOfAddress field to query operations.
|
static BusinessPartnerAddressField<String> |
FULL_NAME
Use with available fluent helpers to apply the FullName field to query operations.
|
static BusinessPartnerAddressField<String> |
HOME_CITY_NAME
Use with available fluent helpers to apply the HomeCityName field to query operations.
|
static BusinessPartnerAddressField<String> |
HOUSE_NUMBER
Use with available fluent helpers to apply the HouseNumber field to query operations.
|
static BusinessPartnerAddressField<String> |
HOUSE_NUMBER_SUPPLEMENT_TEXT
Use with available fluent helpers to apply the HouseNumberSupplementText field to query operations.
|
static BusinessPartnerAddressField<String> |
LANGUAGE
Use with available fluent helpers to apply the Language field to query operations.
|
static BusinessPartnerAddressField<String> |
PERSON
Use with available fluent helpers to apply the Person field to query operations.
|
static BusinessPartnerAddressField<String> |
PO_BOX
Use with available fluent helpers to apply the POBox field to query operations.
|
static BusinessPartnerAddressField<String> |
PO_BOX_DEVIATING_CITY_NAME
Use with available fluent helpers to apply the POBoxDeviatingCityName field to query operations.
|
static BusinessPartnerAddressField<String> |
PO_BOX_DEVIATING_COUNTRY
Use with available fluent helpers to apply the POBoxDeviatingCountry field to query operations.
|
static BusinessPartnerAddressField<String> |
PO_BOX_DEVIATING_REGION
Use with available fluent helpers to apply the POBoxDeviatingRegion field to query operations.
|
static BusinessPartnerAddressField<Boolean> |
PO_BOX_IS_WITHOUT_NUMBER
Use with available fluent helpers to apply the POBoxIsWithoutNumber field to query operations.
|
static BusinessPartnerAddressField<String> |
PO_BOX_LOBBY_NAME
Use with available fluent helpers to apply the POBoxLobbyName field to query operations.
|
static BusinessPartnerAddressField<String> |
PO_BOX_POSTAL_CODE
Use with available fluent helpers to apply the POBoxPostalCode field to query operations.
|
static BusinessPartnerAddressField<String> |
POSTAL_CODE
Use with available fluent helpers to apply the PostalCode field to query operations.
|
static BusinessPartnerAddressField<String> |
PRFRD_COMM_MEDIUM_TYPE
Use with available fluent helpers to apply the PrfrdCommMediumType field to query operations.
|
static BusinessPartnerAddressField<String> |
REGION
Use with available fluent helpers to apply the Region field to query operations.
|
static BusinessPartnerAddressField<String> |
STREET_NAME
Use with available fluent helpers to apply the StreetName field to query operations.
|
static BusinessPartnerAddressField<String> |
STREET_PREFIX_NAME
Use with available fluent helpers to apply the StreetPrefixName field to query operations.
|
static BusinessPartnerAddressField<String> |
STREET_SUFFIX_NAME
Use with available fluent helpers to apply the StreetSuffixName field to query operations.
|
static BusinessPartnerAddressField<String> |
TAX_JURISDICTION
Use with available fluent helpers to apply the TaxJurisdiction field to query operations.
|
static BusinessPartnerAddressLink<BuPaAddressUsage> |
TO_ADDRESS_USAGE
Use with available fluent helpers to apply the to_AddressUsage navigation property to query operations.
|
static BusinessPartnerAddressLink<AddressEmailAddress> |
TO_EMAIL_ADDRESS
Use with available fluent helpers to apply the to_EmailAddress navigation property to query operations.
|
static BusinessPartnerAddressLink<AddressFaxNumber> |
TO_FAX_NUMBER
Use with available fluent helpers to apply the to_FaxNumber navigation property to query operations.
|
static BusinessPartnerAddressLink<AddressPhoneNumber> |
TO_MOBILE_PHONE_NUMBER
Use with available fluent helpers to apply the to_MobilePhoneNumber navigation property to query operations.
|
static BusinessPartnerAddressLink<AddressPhoneNumber> |
TO_PHONE_NUMBER
Use with available fluent helpers to apply the to_PhoneNumber navigation property to query operations.
|
static BusinessPartnerAddressLink<AddressHomePageURL> |
TO_URL_ADDRESS
Use with available fluent helpers to apply the to_URLAddress navigation property to query operations.
|
static BusinessPartnerAddressField<String> |
TRANSPORT_ZONE
Use with available fluent helpers to apply the TransportZone field to query operations.
|
static BusinessPartnerAddressField<ZonedDateTime> |
VALIDITY_END_DATE
Use with available fluent helpers to apply the ValidityEndDate field to query operations.
|
static BusinessPartnerAddressField<ZonedDateTime> |
VALIDITY_START_DATE
Use with available fluent helpers to apply the ValidityStartDate field to query operations.
|
changedOriginalFields
Constructor and Description |
---|
BusinessPartnerAddress() |
BusinessPartnerAddress(String businessPartner,
String addressID,
ZonedDateTime validityStartDate,
ZonedDateTime validityEndDate,
String authorizationGroup,
UUID addressUUID,
String additionalStreetPrefixName,
String additionalStreetSuffixName,
String addressTimeZone,
String careOfName,
String cityCode,
String cityName,
String companyPostalCode,
String country,
String county,
String deliveryServiceNumber,
String deliveryServiceTypeCode,
String district,
String formOfAddress,
String fullName,
String homeCityName,
String houseNumber,
String houseNumberSupplementText,
String language,
String pOBox,
String pOBoxDeviatingCityName,
String pOBoxDeviatingCountry,
String pOBoxDeviatingRegion,
Boolean pOBoxIsWithoutNumber,
String pOBoxLobbyName,
String pOBoxPostalCode,
String person,
String postalCode,
String prfrdCommMediumType,
String region,
String streetName,
String streetPrefixName,
String streetSuffixName,
String taxJurisdiction,
String transportZone,
String addressIDByExternalSystem,
ErpConfigContext erpConfigContext,
List<BuPaAddressUsage> toAddressUsage,
List<AddressEmailAddress> toEmailAddress,
List<AddressFaxNumber> toFaxNumber,
List<AddressPhoneNumber> toMobilePhoneNumber,
List<AddressPhoneNumber> toPhoneNumber,
List<AddressHomePageURL> toURLAddress) |
Modifier and Type | Method and Description |
---|---|
void |
addAddressUsage(BuPaAddressUsage... entity)
Adds elements to the list of associated BuPaAddressUsage entities.
|
void |
addEmailAddress(AddressEmailAddress... entity)
Adds elements to the list of associated AddressEmailAddress entities.
|
void |
addFaxNumber(AddressFaxNumber... entity)
Adds elements to the list of associated AddressFaxNumber entities.
|
void |
addMobilePhoneNumber(AddressPhoneNumber... entity)
Adds elements to the list of associated AddressPhoneNumber entities.
|
void |
addPhoneNumber(AddressPhoneNumber... entity)
Adds elements to the list of associated AddressPhoneNumber entities.
|
void |
addURLAddress(AddressHomePageURL... entity)
Adds elements to the list of associated AddressHomePageURL entities.
|
static BusinessPartnerAddress.BusinessPartnerAddressBuilder |
builder() |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
List<BuPaAddressUsage> |
fetchAddressUsage()
Fetches the BuPaAddressUsage entities (one to many) associated with this entity.
|
List<AddressEmailAddress> |
fetchEmailAddress()
Fetches the AddressEmailAddress entities (one to many) associated with this entity.
|
List<AddressFaxNumber> |
fetchFaxNumber()
Fetches the AddressFaxNumber entities (one to many) associated with this entity.
|
List<AddressPhoneNumber> |
fetchMobilePhoneNumber()
Fetches the AddressPhoneNumber entities (one to many) associated with this entity.
|
List<AddressPhoneNumber> |
fetchPhoneNumber()
Fetches the AddressPhoneNumber entities (one to many) associated with this entity.
|
List<AddressHomePageURL> |
fetchURLAddress()
Fetches the AddressHomePageURL entities (one to many) associated with this entity.
|
static <T> BusinessPartnerAddressField<T> |
field(String fieldName,
Class<T> fieldType)
Use with available fluent helpers to apply an extension field to query operations.
|
protected void |
fromMap(Map<String,Object> inputValues) |
String |
getAdditionalStreetPrefixName()
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: AdditionalStreetPrefixNameThe Street address contains two lines above the street and two lines below the street.See Print the Street address.
|
String |
getAdditionalStreetSuffixName()
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: AdditionalStreetSuffixNameThe Street address has two lines above the street and two lines below the steet.See Print the Street address.
|
String |
getAddressID()
(Key Field) Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: AddressIDFor more information about the meaning and use of the address number and the Business Address Services concepts, see the function group SZA0 documentation.
|
String |
getAddressIDByExternalSystem()
Constraints: Not nullable, Maximum length: 20 Original property name from the Odata EDM: AddressIDByExternalSystemIf the current address has a different number in an external system, you can save this number here for information purposes.In direct input you are able to maintain an address for a business partner by stating the external address number.
|
String |
getAddressTimeZone()
Constraints: Not nullable, Maximum length: 6 Original property name from the Odata EDM: AddressTimeZoneThe time zone is automatically determined by the system in address maintenance if time zone Customizing is maintained.It depends on the country and the region.
|
Optional<List<BuPaAddressUsage>> |
getAddressUsageIfPresent()
Retrieval of associated BuPaAddressUsage entities (one to many).
|
List<BuPaAddressUsage> |
getAddressUsageOrFetch()
Retrieval of associated BuPaAddressUsage entities (one to many).
|
UUID |
getAddressUUID()
Constraints: noneOriginal property name from the Odata EDM: AddressUUID
|
String |
getAuthorizationGroup()
Constraints: Not nullable, Maximum length: 4 Original property name from the Odata EDM: AuthorizationGroupUse the following authorization object:'Business partners: authorization groups' (B_BUPA_GRP).The system only checks this authorization if you made an entry in the "Authorization group" field for the business partner.
|
String |
getBusinessPartner()
(Key Field) Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: BusinessPartner
|
String |
getCareOfName()
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: CareOfNamePut the country-specific code (e.g. c/o) in front of the name of the occupant.
|
String |
getCityCode()
Constraints: Not nullable, Maximum length: 12 Original property name from the Odata EDM: CityCode
|
String |
getCityName()
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: CityNameThe city name is saved redundantly in another database field in upper- case letters, for search help.If the Postal regional structure ('city file') is active, the city name is checked against the Cities defined in the regional structure.
|
String |
getCompanyPostalCode()
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: CompanyPostalCodeThis field is used for countries where major companies are assigned their own postal code by the national post office.This postal code has to be entered in the field "Company Postal Code".
|
String |
getCountry()
Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: CountryThe two-character ISO code in accordance with ISO 3166, which is delivered by SAP as a default, is usually used.It could also be the vehicle license plate country-code or a typical country key, for example, in Germany the Federal statistics office key.The country keys are determined at system installation in the global settings.The definition of the country key in the SAP system does not have to match political or government entities.Since the country key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country key cannot query the country key T005-LAND1, but have to program based on the ISO code T005 INTCA.
|
String |
getCounty()
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: CountyThis field is used to store the county’s name.
|
String |
getDeliveryServiceNumber()
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: DeliveryServiceNumberSome countries offer different services in addition to regular postal delivery and PO boxes, for example the Private Bag or Response Bag.
|
String |
getDeliveryServiceTypeCode()
Constraints: Not nullable, Maximum length: 4 Original property name from the Odata EDM: DeliveryServiceTypeCodeSome countries offer different services in addition to regular postal delivery and PO boxes, for example the Private Bag or Response Bag.
|
String |
getDistrict()
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: DistrictIn some countries, this entry is appended with a hyphen to the city name by the automatic address formatting, other countries, it is output on a line of its own or (e.g. in the USA) not printed.See the examples in the Address Layout Key documentation.
|
Optional<List<AddressEmailAddress>> |
getEmailAddressIfPresent()
Retrieval of associated AddressEmailAddress entities (one to many).
|
List<AddressEmailAddress> |
getEmailAddressOrFetch()
Retrieval of associated AddressEmailAddress entities (one to many).
|
protected String |
getEndpointUrl() |
protected String |
getEntityCollection() |
ErpConfigContext |
getErpConfigContext()
Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
|
Optional<List<AddressFaxNumber>> |
getFaxNumberIfPresent()
Retrieval of associated AddressFaxNumber entities (one to many).
|
List<AddressFaxNumber> |
getFaxNumberOrFetch()
Retrieval of associated AddressFaxNumber entities (one to many).
|
String |
getFormOfAddress()
Constraints: Not nullable, Maximum length: 4 Original property name from the Odata EDM: FormOfAddressYou can also define a form of address text in Customizing.The form of address text can be maintained in different languages.
|
String |
getFullName()
Constraints: Not nullable, Maximum length: 80 Original property name from the Odata EDM: FullNameFor organizations or document addresses, typically the fields Name1 and Name2 are concatenated.For persons the field contains the formatted name according to country specific rules.
|
String |
getHomeCityName()
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: HomeCityNameIn some countries, the residential city is required if it differs from the postal city.In the USA, the official street indexes, against which data can be checked, are based on the residential city, not the postal city, which may be different.It is the same in France, where a postally correct address must contain the residential city in a separate line above the postal city, if it differs from the postal city.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
|
String |
getHouseNumber()
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: HouseNumberIt is printed in the Street line.Other supplementary street information can be entered in the House number supplement or one of the Street2, Street3, Street4 or Street5 fields.
|
String |
getHouseNumberSupplementText()
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: HouseNumberSupplementTextApp. 17 orSuite 600.It is printed in the Street line.Further Street supplements can be put in one of the fields Street2, Street3, Street4 or Street5.See Print the Street address.
|
protected Map<String,Object> |
getKey() |
String |
getLanguage()
Constraints: Not nullable, Maximum length: 2 Original property name from the Odata EDM: Language- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.
|
Optional<List<AddressPhoneNumber>> |
getMobilePhoneNumberIfPresent()
Retrieval of associated AddressPhoneNumber entities (one to many).
|
List<AddressPhoneNumber> |
getMobilePhoneNumberOrFetch()
Retrieval of associated AddressPhoneNumber entities (one to many).
|
String |
getPerson()
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: PersonFor more information about the meaning and use of the person number and Business Address Services concepts, see the function group SZA0 documentation.
|
Optional<List<AddressPhoneNumber>> |
getPhoneNumberIfPresent()
Retrieval of associated AddressPhoneNumber entities (one to many).
|
List<AddressPhoneNumber> |
getPhoneNumberOrFetch()
Retrieval of associated AddressPhoneNumber entities (one to many).
|
String |
getPOBox()
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: POBoxOnly enter the PO Box number in this field.
|
String |
getPOBoxDeviatingCityName()
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: POBoxDeviatingCityNameThe PO Box city can be entered here if it is different from the address city.If the address is only a PO Box address, enter the city in the normal city field.If the address contains two different city names for the address and the PO Box address, use this field.
|
String |
getPOBoxDeviatingCountry()
Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: POBoxDeviatingCountryThe PO Box country can be entered here, if it is different from the street address country.If the address only has a PO Box address, the country is in the normal country field.Use this field if the address has two different country values for the street address and the PO Box address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
|
String |
getPOBoxDeviatingRegion()
Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: POBoxDeviatingRegionEnter the PO Box Region here, if it differs from the street address region.If the address only has a PO Box address, the Region in in the normal Region field.Use this field if the address has two different Region values for the street address and the PO Box address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
|
Boolean |
getPOBoxIsWithoutNumber()
Constraints: noneOriginal property name from the Odata EDM: POBoxIsWithoutNumberOnly the word 'PO Box' is output in PO Box addresses without PO Box number.Set this flag for a PO Box address without PO Box number.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
|
String |
getPOBoxLobbyName()
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: POBoxLobbyNameIn some countries, entering a PO box, postal code and city is not sufficient to uniquely identify a PO box, because the same PO box number is assigned multiple times in some cities.Therefore, additional information might be required to determine the post office of the PO box in question.
|
String |
getPOBoxPostalCode()
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: POBoxPostalCodeThis field is used for countries where a different postal code applies to mail that is sent to the PO box rather than to the street address of a particular business partner.Postal codes for group major customers also have to be entered in the field for the PO box postal code since individual customers with a shared postal code for group major customers are differentiated by means of the PO box.
|
String |
getPostalCode()
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: PostalCodeIf different postal codes are maintained for the PO Box and Street address of an address, this field contains the Street address postal code.
|
String |
getPrfrdCommMediumType()
Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: PrfrdCommMediumTypeIn Business Address Services, you can specify a standard communication method that can be used by programs to determine the means of communication for sending messages.One business partner wants all messages by fax, another by e-mail.The application context can restrict the possible methods of communication.
|
String |
getRegion()
Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: RegionThe automatic address formatting function prints the region in addresses in the USA, Canada, Italy, Brazil or Australia, and the county in Great Britain.For more information, see the examples in the documentation on the Address Layout Key.Meaning of the regional code in ...Australia -> ProvinceBrazil -> StateCanada -> ProvinceGermany -> StateGreat Britain -> CountyItaly -> ProvinceJapan -> PrefectureSwitzerland -> CantonUSA -> State
|
String |
getStreetName()
Constraints: Not nullable, Maximum length: 60 Original property name from the Odata EDM: StreetNameThe street name is saved, redundantly in upper case in another database field, for search help purposes.There are other fields for address parts which can be printed above or below the street.
|
String |
getStreetPrefixName()
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: StreetPrefixNameThe Street address contains two lines above the street and two lines below the street.See Print the Street address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
|
String |
getStreetSuffixName()
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: StreetSuffixNameThe Street address contains two lines above the street and two lines below the street.See Print the Street address.
|
String |
getTaxJurisdiction()
Constraints: Not nullable, Maximum length: 15 Original property name from the Odata EDM: TaxJurisdiction
|
String |
getTransportZone()
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: TransportZoneRegional zone of Goods recipient.Purchasing:Regional zone of supplier.You can define regional zones to suit the requirements of your own business and country.Sales and distributionthe system automatically proposes a suitable route by using the transportation zone of the goods recipient in combination with other information about the delivery, such as theCountries of origin and destinationShipping conditionsTransportation groupIn the USA, for example, you can define regional zones to correspond to the US postal zip codes.
|
Class<BusinessPartnerAddress> |
getType() |
Optional<List<AddressHomePageURL>> |
getURLAddressIfPresent()
Retrieval of associated AddressHomePageURL entities (one to many).
|
List<AddressHomePageURL> |
getURLAddressOrFetch()
Retrieval of associated AddressHomePageURL entities (one to many).
|
ZonedDateTime |
getValidityEndDate()
Constraints: Not nullable, Precision: 0 Original property name from the Odata EDM: ValidityEndDate
|
ZonedDateTime |
getValidityStartDate()
Constraints: Not nullable, Precision: 0 Original property name from the Odata EDM: ValidityStartDate
|
int |
hashCode() |
void |
setAdditionalStreetPrefixName(String additionalStreetPrefixName)
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: AdditionalStreetPrefixNameThe Street address contains two lines above the street and two lines below the street.See Print the Street address.
|
void |
setAdditionalStreetSuffixName(String additionalStreetSuffixName)
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: AdditionalStreetSuffixNameThe Street address has two lines above the street and two lines below the steet.See Print the Street address.
|
void |
setAddressID(String addressID)
(Key Field) Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: AddressIDFor more information about the meaning and use of the address number and the Business Address Services concepts, see the function group SZA0 documentation.
|
void |
setAddressIDByExternalSystem(String addressIDByExternalSystem)
Constraints: Not nullable, Maximum length: 20 Original property name from the Odata EDM: AddressIDByExternalSystemIf the current address has a different number in an external system, you can save this number here for information purposes.In direct input you are able to maintain an address for a business partner by stating the external address number.
|
void |
setAddressTimeZone(String addressTimeZone)
Constraints: Not nullable, Maximum length: 6 Original property name from the Odata EDM: AddressTimeZoneThe time zone is automatically determined by the system in address maintenance if time zone Customizing is maintained.It depends on the country and the region.
|
void |
setAddressUsage(List<BuPaAddressUsage> value)
Overwrites the list of associated BuPaAddressUsage entities for the loaded navigation property to_AddressUsage.
|
void |
setAddressUUID(UUID addressUUID)
Constraints: noneOriginal property name from the Odata EDM: AddressUUID
|
void |
setAuthorizationGroup(String authorizationGroup)
Constraints: Not nullable, Maximum length: 4 Original property name from the Odata EDM: AuthorizationGroupUse the following authorization object:'Business partners: authorization groups' (B_BUPA_GRP).The system only checks this authorization if you made an entry in the "Authorization group" field for the business partner.
|
void |
setBusinessPartner(String businessPartner)
(Key Field) Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: BusinessPartner
|
void |
setCareOfName(String careOfName)
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: CareOfNamePut the country-specific code (e.g. c/o) in front of the name of the occupant.
|
void |
setCityCode(String cityCode)
Constraints: Not nullable, Maximum length: 12 Original property name from the Odata EDM: CityCode
|
void |
setCityName(String cityName)
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: CityNameThe city name is saved redundantly in another database field in upper- case letters, for search help.If the Postal regional structure ('city file') is active, the city name is checked against the Cities defined in the regional structure.
|
void |
setCompanyPostalCode(String companyPostalCode)
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: CompanyPostalCodeThis field is used for countries where major companies are assigned their own postal code by the national post office.This postal code has to be entered in the field "Company Postal Code".
|
void |
setCountry(String country)
Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: CountryThe two-character ISO code in accordance with ISO 3166, which is delivered by SAP as a default, is usually used.It could also be the vehicle license plate country-code or a typical country key, for example, in Germany the Federal statistics office key.The country keys are determined at system installation in the global settings.The definition of the country key in the SAP system does not have to match political or government entities.Since the country key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country key cannot query the country key T005-LAND1, but have to program based on the ISO code T005 INTCA.
|
void |
setCounty(String county)
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: CountyThis field is used to store the county’s name.
|
void |
setDeliveryServiceNumber(String deliveryServiceNumber)
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: DeliveryServiceNumberSome countries offer different services in addition to regular postal delivery and PO boxes, for example the Private Bag or Response Bag.
|
void |
setDeliveryServiceTypeCode(String deliveryServiceTypeCode)
Constraints: Not nullable, Maximum length: 4 Original property name from the Odata EDM: DeliveryServiceTypeCodeSome countries offer different services in addition to regular postal delivery and PO boxes, for example the Private Bag or Response Bag.
|
void |
setDistrict(String district)
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: DistrictIn some countries, this entry is appended with a hyphen to the city name by the automatic address formatting, other countries, it is output on a line of its own or (e.g. in the USA) not printed.See the examples in the Address Layout Key documentation.
|
void |
setEmailAddress(List<AddressEmailAddress> value)
Overwrites the list of associated AddressEmailAddress entities for the loaded navigation property to_EmailAddress.
|
void |
setErpConfigContext(ErpConfigContext erpConfigContext)
Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
|
void |
setFaxNumber(List<AddressFaxNumber> value)
Overwrites the list of associated AddressFaxNumber entities for the loaded navigation property to_FaxNumber.
|
void |
setFormOfAddress(String formOfAddress)
Constraints: Not nullable, Maximum length: 4 Original property name from the Odata EDM: FormOfAddressYou can also define a form of address text in Customizing.The form of address text can be maintained in different languages.
|
void |
setFullName(String fullName)
Constraints: Not nullable, Maximum length: 80 Original property name from the Odata EDM: FullNameFor organizations or document addresses, typically the fields Name1 and Name2 are concatenated.For persons the field contains the formatted name according to country specific rules.
|
void |
setHomeCityName(String homeCityName)
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: HomeCityNameIn some countries, the residential city is required if it differs from the postal city.In the USA, the official street indexes, against which data can be checked, are based on the residential city, not the postal city, which may be different.It is the same in France, where a postally correct address must contain the residential city in a separate line above the postal city, if it differs from the postal city.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
|
void |
setHouseNumber(String houseNumber)
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: HouseNumberIt is printed in the Street line.Other supplementary street information can be entered in the House number supplement or one of the Street2, Street3, Street4 or Street5 fields.
|
void |
setHouseNumberSupplementText(String houseNumberSupplementText)
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: HouseNumberSupplementTextApp. 17 orSuite 600.It is printed in the Street line.Further Street supplements can be put in one of the fields Street2, Street3, Street4 or Street5.See Print the Street address.
|
void |
setLanguage(String language)
Constraints: Not nullable, Maximum length: 2 Original property name from the Odata EDM: Language- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.
|
void |
setMobilePhoneNumber(List<AddressPhoneNumber> value)
Overwrites the list of associated AddressPhoneNumber entities for the loaded navigation property to_MobilePhoneNumber.
|
void |
setPerson(String person)
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: PersonFor more information about the meaning and use of the person number and Business Address Services concepts, see the function group SZA0 documentation.
|
void |
setPhoneNumber(List<AddressPhoneNumber> value)
Overwrites the list of associated AddressPhoneNumber entities for the loaded navigation property to_PhoneNumber.
|
void |
setPOBox(String pOBox)
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: POBoxOnly enter the PO Box number in this field.
|
void |
setPOBoxDeviatingCityName(String pOBoxDeviatingCityName)
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: POBoxDeviatingCityNameThe PO Box city can be entered here if it is different from the address city.If the address is only a PO Box address, enter the city in the normal city field.If the address contains two different city names for the address and the PO Box address, use this field.
|
void |
setPOBoxDeviatingCountry(String pOBoxDeviatingCountry)
Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: POBoxDeviatingCountryThe PO Box country can be entered here, if it is different from the street address country.If the address only has a PO Box address, the country is in the normal country field.Use this field if the address has two different country values for the street address and the PO Box address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
|
void |
setPOBoxDeviatingRegion(String pOBoxDeviatingRegion)
Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: POBoxDeviatingRegionEnter the PO Box Region here, if it differs from the street address region.If the address only has a PO Box address, the Region in in the normal Region field.Use this field if the address has two different Region values for the street address and the PO Box address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
|
void |
setPOBoxIsWithoutNumber(Boolean pOBoxIsWithoutNumber)
Constraints: noneOriginal property name from the Odata EDM: POBoxIsWithoutNumberOnly the word 'PO Box' is output in PO Box addresses without PO Box number.Set this flag for a PO Box address without PO Box number.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
|
void |
setPOBoxLobbyName(String pOBoxLobbyName)
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: POBoxLobbyNameIn some countries, entering a PO box, postal code and city is not sufficient to uniquely identify a PO box, because the same PO box number is assigned multiple times in some cities.Therefore, additional information might be required to determine the post office of the PO box in question.
|
void |
setPOBoxPostalCode(String pOBoxPostalCode)
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: POBoxPostalCodeThis field is used for countries where a different postal code applies to mail that is sent to the PO box rather than to the street address of a particular business partner.Postal codes for group major customers also have to be entered in the field for the PO box postal code since individual customers with a shared postal code for group major customers are differentiated by means of the PO box.
|
void |
setPostalCode(String postalCode)
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: PostalCodeIf different postal codes are maintained for the PO Box and Street address of an address, this field contains the Street address postal code.
|
void |
setPrfrdCommMediumType(String prfrdCommMediumType)
Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: PrfrdCommMediumTypeIn Business Address Services, you can specify a standard communication method that can be used by programs to determine the means of communication for sending messages.One business partner wants all messages by fax, another by e-mail.The application context can restrict the possible methods of communication.
|
void |
setRegion(String region)
Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: RegionThe automatic address formatting function prints the region in addresses in the USA, Canada, Italy, Brazil or Australia, and the county in Great Britain.For more information, see the examples in the documentation on the Address Layout Key.Meaning of the regional code in ...Australia -> ProvinceBrazil -> StateCanada -> ProvinceGermany -> StateGreat Britain -> CountyItaly -> ProvinceJapan -> PrefectureSwitzerland -> CantonUSA -> State
|
void |
setStreetName(String streetName)
Constraints: Not nullable, Maximum length: 60 Original property name from the Odata EDM: StreetNameThe street name is saved, redundantly in upper case in another database field, for search help purposes.There are other fields for address parts which can be printed above or below the street.
|
void |
setStreetPrefixName(String streetPrefixName)
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: StreetPrefixNameThe Street address contains two lines above the street and two lines below the street.See Print the Street address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
|
void |
setStreetSuffixName(String streetSuffixName)
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: StreetSuffixNameThe Street address contains two lines above the street and two lines below the street.See Print the Street address.
|
void |
setTaxJurisdiction(String taxJurisdiction)
Constraints: Not nullable, Maximum length: 15 Original property name from the Odata EDM: TaxJurisdiction
|
void |
setTransportZone(String transportZone)
Constraints: Not nullable, Maximum length: 10 Original property name from the Odata EDM: TransportZoneRegional zone of Goods recipient.Purchasing:Regional zone of supplier.You can define regional zones to suit the requirements of your own business and country.Sales and distributionthe system automatically proposes a suitable route by using the transportation zone of the goods recipient in combination with other information about the delivery, such as theCountries of origin and destinationShipping conditionsTransportation groupIn the USA, for example, you can define regional zones to correspond to the US postal zip codes.
|
void |
setURLAddress(List<AddressHomePageURL> value)
Overwrites the list of associated AddressHomePageURL entities for the loaded navigation property to_URLAddress.
|
void |
setValidityEndDate(ZonedDateTime validityEndDate)
Constraints: Not nullable, Precision: 0 Original property name from the Odata EDM: ValidityEndDate
|
void |
setValidityStartDate(ZonedDateTime validityStartDate)
Constraints: Not nullable, Precision: 0 Original property name from the Odata EDM: ValidityStartDate
|
protected Map<String,Object> |
toMapOfFields() |
protected Map<String,Object> |
toMapOfNavigationProperties() |
String |
toString() |
getVersionIdentifier, setVersionIdentifier
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields
public static final BusinessPartnerAddressSelectable ALL_FIELDS
public static final BusinessPartnerAddressField<String> BUSINESS_PARTNER
public static final BusinessPartnerAddressField<String> ADDRESS_ID
public static final BusinessPartnerAddressField<ZonedDateTime> VALIDITY_START_DATE
public static final BusinessPartnerAddressField<ZonedDateTime> VALIDITY_END_DATE
public static final BusinessPartnerAddressField<String> AUTHORIZATION_GROUP
public static final BusinessPartnerAddressField<UUID> ADDRESS_UUID
public static final BusinessPartnerAddressField<String> ADDITIONAL_STREET_PREFIX_NAME
public static final BusinessPartnerAddressField<String> ADDITIONAL_STREET_SUFFIX_NAME
public static final BusinessPartnerAddressField<String> ADDRESS_TIME_ZONE
public static final BusinessPartnerAddressField<String> CARE_OF_NAME
public static final BusinessPartnerAddressField<String> CITY_CODE
public static final BusinessPartnerAddressField<String> CITY_NAME
public static final BusinessPartnerAddressField<String> COMPANY_POSTAL_CODE
public static final BusinessPartnerAddressField<String> COUNTRY
public static final BusinessPartnerAddressField<String> COUNTY
public static final BusinessPartnerAddressField<String> DELIVERY_SERVICE_NUMBER
public static final BusinessPartnerAddressField<String> DELIVERY_SERVICE_TYPE_CODE
public static final BusinessPartnerAddressField<String> DISTRICT
public static final BusinessPartnerAddressField<String> FORM_OF_ADDRESS
public static final BusinessPartnerAddressField<String> FULL_NAME
public static final BusinessPartnerAddressField<String> HOME_CITY_NAME
public static final BusinessPartnerAddressField<String> HOUSE_NUMBER
public static final BusinessPartnerAddressField<String> HOUSE_NUMBER_SUPPLEMENT_TEXT
public static final BusinessPartnerAddressField<String> LANGUAGE
public static final BusinessPartnerAddressField<String> PO_BOX
public static final BusinessPartnerAddressField<String> PO_BOX_DEVIATING_CITY_NAME
public static final BusinessPartnerAddressField<String> PO_BOX_DEVIATING_COUNTRY
public static final BusinessPartnerAddressField<String> PO_BOX_DEVIATING_REGION
public static final BusinessPartnerAddressField<Boolean> PO_BOX_IS_WITHOUT_NUMBER
public static final BusinessPartnerAddressField<String> PO_BOX_LOBBY_NAME
public static final BusinessPartnerAddressField<String> PO_BOX_POSTAL_CODE
public static final BusinessPartnerAddressField<String> PERSON
public static final BusinessPartnerAddressField<String> POSTAL_CODE
public static final BusinessPartnerAddressField<String> PRFRD_COMM_MEDIUM_TYPE
public static final BusinessPartnerAddressField<String> REGION
public static final BusinessPartnerAddressField<String> STREET_NAME
public static final BusinessPartnerAddressField<String> STREET_PREFIX_NAME
public static final BusinessPartnerAddressField<String> STREET_SUFFIX_NAME
public static final BusinessPartnerAddressField<String> TAX_JURISDICTION
public static final BusinessPartnerAddressField<String> TRANSPORT_ZONE
public static final BusinessPartnerAddressField<String> ADDRESS_ID_BY_EXTERNAL_SYSTEM
public static final BusinessPartnerAddressLink<BuPaAddressUsage> TO_ADDRESS_USAGE
public static final BusinessPartnerAddressLink<AddressEmailAddress> TO_EMAIL_ADDRESS
public static final BusinessPartnerAddressLink<AddressFaxNumber> TO_FAX_NUMBER
public static final BusinessPartnerAddressLink<AddressPhoneNumber> TO_MOBILE_PHONE_NUMBER
public static final BusinessPartnerAddressLink<AddressPhoneNumber> TO_PHONE_NUMBER
public static final BusinessPartnerAddressLink<AddressHomePageURL> TO_URL_ADDRESS
public BusinessPartnerAddress()
public BusinessPartnerAddress(@Nullable String businessPartner, @Nullable String addressID, @Nullable ZonedDateTime validityStartDate, @Nullable ZonedDateTime validityEndDate, @Nullable String authorizationGroup, @Nullable UUID addressUUID, @Nullable String additionalStreetPrefixName, @Nullable String additionalStreetSuffixName, @Nullable String addressTimeZone, @Nullable String careOfName, @Nullable String cityCode, @Nullable String cityName, @Nullable String companyPostalCode, @Nullable String country, @Nullable String county, @Nullable String deliveryServiceNumber, @Nullable String deliveryServiceTypeCode, @Nullable String district, @Nullable String formOfAddress, @Nullable String fullName, @Nullable String homeCityName, @Nullable String houseNumber, @Nullable String houseNumberSupplementText, @Nullable String language, @Nullable String pOBox, @Nullable String pOBoxDeviatingCityName, @Nullable String pOBoxDeviatingCountry, @Nullable String pOBoxDeviatingRegion, @Nullable Boolean pOBoxIsWithoutNumber, @Nullable String pOBoxLobbyName, @Nullable String pOBoxPostalCode, @Nullable String person, @Nullable String postalCode, @Nullable String prfrdCommMediumType, @Nullable String region, @Nullable String streetName, @Nullable String streetPrefixName, @Nullable String streetSuffixName, @Nullable String taxJurisdiction, @Nullable String transportZone, @Nullable String addressIDByExternalSystem, @Nullable ErpConfigContext erpConfigContext, List<BuPaAddressUsage> toAddressUsage, List<AddressEmailAddress> toEmailAddress, List<AddressFaxNumber> toFaxNumber, List<AddressPhoneNumber> toMobilePhoneNumber, List<AddressPhoneNumber> toPhoneNumber, List<AddressHomePageURL> toURLAddress)
public Class<BusinessPartnerAddress> getType()
getType
in class VdmObject<BusinessPartnerAddress>
public void setBusinessPartner(@Nullable String businessPartner)
Original property name from the Odata EDM: BusinessPartner
businessPartner
- Key identifying a business partner in the SAP system. The key is unique within a client.public void setAddressID(@Nullable String addressID)
Original property name from the Odata EDM: AddressID
For more information about the meaning and use of the address number and the Business Address Services concepts, see the function group SZA0 documentation.
addressID
- Internal key for identifying a Business Address Services address.public void setValidityStartDate(@Nullable ZonedDateTime validityStartDate)
Original property name from the Odata EDM: ValidityStartDate
validityStartDate
- Validity Start of a Business Partner Addresspublic void setValidityEndDate(@Nullable ZonedDateTime validityEndDate)
Original property name from the Odata EDM: ValidityEndDate
validityEndDate
- Validity End of a Business Partner Addresspublic void setAuthorizationGroup(@Nullable String authorizationGroup)
Original property name from the Odata EDM: AuthorizationGroup
Use the following authorization object:'Business partners: authorization groups' (B_BUPA_GRP).The system only checks this authorization if you made an entry in the "Authorization group" field for the business partner. Otherwise, any user may process the business partner.
authorizationGroup
- You can use authorization groups to stipulate which business partners a user is allowed to process.public void setAddressUUID(@Nullable UUID addressUUID)
Original property name from the Odata EDM: AddressUUID
addressUUID
- GUID of a Business Partner Addresspublic void setAdditionalStreetPrefixName(@Nullable String additionalStreetPrefixName)
Original property name from the Odata EDM: AdditionalStreetPrefixName
The Street address contains two lines above the street and two lines below the street.See Print the Street address.
additionalStreetPrefixName
- Additional address field which is printed above the Street line.public void setAdditionalStreetSuffixName(@Nullable String additionalStreetSuffixName)
Original property name from the Odata EDM: AdditionalStreetSuffixName
The Street address has two lines above the street and two lines below the steet.See Print the Street address.
additionalStreetSuffixName
- Additional address field which is printed under the Street line.public void setAddressTimeZone(@Nullable String addressTimeZone)
Original property name from the Odata EDM: AddressTimeZone
The time zone is automatically determined by the system in address maintenance if time zone Customizing is maintained.It depends on the country and the region. (Region means state, province or county, depending on the country)The automatic determination is only made if there is no value in the time zone field.
addressTimeZone
- Time zone as part of an address.public void setCareOfName(@Nullable String careOfName)
Original property name from the Odata EDM: CareOfName
Put the country-specific code (e.g. c/o) in front of the name of the occupant. This is not automatically done in the print format, like the language-specific word "PO Box".John Smithc/o David BrownThis field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
careOfName
- Part of the address (c/o = care of) if the recipient is different from the occupant and the names are not similar (e.g. subtenants).public void setCityCode(@Nullable String cityCode)
Original property name from the Odata EDM: CityCode
cityCode
- City code for city/street filepublic void setCityName(@Nullable String cityName)
Original property name from the Odata EDM: CityName
The city name is saved redundantly in another database field in upper- case letters, for search help.If the Postal regional structure ('city file') is active, the city name is checked against the Cities defined in the regional structure.
cityName
- City name as part of the address.public void setCompanyPostalCode(@Nullable String companyPostalCode)
Original property name from the Odata EDM: CompanyPostalCode
This field is used for countries where major companies are assigned their own postal code by the national post office.This postal code has to be entered in the field "Company Postal Code". Postal codes for group major customers, however, have to be entered in the field "PO Box Postal Code", since individual customers with a shared postal code for group major customers are differentiated by means of their PO box.
companyPostalCode
- Postal code that is assigned directly to one company (= company postal code = major customer postal code).public void setCountry(@Nullable String country)
Original property name from the Odata EDM: Country
The two-character ISO code in accordance with ISO 3166, which is delivered by SAP as a default, is usually used.It could also be the vehicle license plate country-code or a typical country key, for example, in Germany the Federal statistics office key.The country keys are determined at system installation in the global settings.The definition of the country key in the SAP system does not have to match political or government entities.Since the country key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country key cannot query the country key T005-LAND1, but have to program based on the ISO code T005 INTCA.
country
- The country key contains information which the system uses to check entries such as the length of the postal code or bank account number.public void setCounty(@Nullable String county)
Original property name from the Odata EDM: County
This field is used to store the county’s name. You can enter the name of the county in this field.
county
- Specifies the county’s namepublic void setDeliveryServiceNumber(@Nullable String deliveryServiceNumber)
Original property name from the Odata EDM: DeliveryServiceNumber
Some countries offer different services in addition to regular postal delivery and PO boxes, for example the Private Bag or Response Bag. If an address is related to one of these delivery services, the information about this particular delivery service has to be entered in the corresponding fields.In the field "Number of Delivery Service," the number of the Private Bag, Response Bag, or other relevant service has to be entered. Entering a number is not mandatory for each delivery service.For each address, either the information about the PO box or the information about the delivery service can be entered, but not both types of information at the same time.Mr PickeringPrivate Bag 106999Timaru 7942Delivery services will only be taken into account for address formatting in countries in which they are commonly used in addition to regular postal delivery and PO boxes, for example, in Australia, New Zealand, and the USA. In all other countries, these fields will not be taken into account for address formatting.
deliveryServiceNumber
- The delivery service is part of the PO box address.public void setDeliveryServiceTypeCode(@Nullable String deliveryServiceTypeCode)
Original property name from the Odata EDM: DeliveryServiceTypeCode
Some countries offer different services in addition to regular postal delivery and PO boxes, for example the Private Bag or Response Bag. If an address is related to one of these delivery services, the information about this particular delivery service has to be entered in the corresponding fields.In the field "Type of Delivery Service," the type of the delivery service has to be entered.For each address, either the information about the PO box or the information about the delivery service can be entered, but not both types of information at the same time.Mr PickeringPrivate Bag 106999Timaru 7942Delivery services will only be taken into account for address formatting in countries in which they are commonly used in addition to regular postal delivery and PO boxes, for example, in Australia, New Zealand, and the USA. In all other countries, these fields will not be taken into account for address formatting.
deliveryServiceTypeCode
- The delivery service is part of the PO box address.public void setDistrict(@Nullable String district)
Original property name from the Odata EDM: District
In some countries, this entry is appended with a hyphen to the city name by the automatic address formatting, other countries, it is output on a line of its own or (e.g. in the USA) not printed.See the examples in the Address Layout Key documentation.
district
- City or District supplementpublic void setFormOfAddress(@Nullable String formOfAddress)
Original property name from the Odata EDM: FormOfAddress
You can also define a form of address text in Customizing.The form of address text can be maintained in different languages.
formOfAddress
- Key for form of address text.public void setFullName(@Nullable String fullName)
Original property name from the Odata EDM: FullName
For organizations or document addresses, typically the fields Name1 and Name2 are concatenated.For persons the field contains the formatted name according to country specific rules. It corresponds e.g. to the content of the fields BUT000-NAME1_TEXT or ADRP-NAME_TEXT.
fullName
- This field contains the full name or formatted name of a party.public void setHomeCityName(@Nullable String homeCityName)
Original property name from the Odata EDM: HomeCityName
In some countries, the residential city is required if it differs from the postal city.In the USA, the official street indexes, against which data can be checked, are based on the residential city, not the postal city, which may be different.It is the same in France, where a postally correct address must contain the residential city in a separate line above the postal city, if it differs from the postal city.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
homeCityName
- City of residence which is different from the postal citypublic void setHouseNumber(@Nullable String houseNumber)
Original property name from the Odata EDM: HouseNumber
It is printed in the Street line.Other supplementary street information can be entered in the House number supplement or one of the Street2, Street3, Street4 or Street5 fields. See Print the Street address.A house number (e.g. 117) or a house number with supplement (e.g. 117a), or a house number range (e.g. 16-20), can be maintained in this field.
houseNumber
- House number as part of an address.public void setHouseNumberSupplementText(@Nullable String houseNumberSupplementText)
Original property name from the Odata EDM: HouseNumberSupplementText
App. 17 orSuite 600.It is printed in the Street line.Further Street supplements can be put in one of the fields Street2, Street3, Street4 or Street5.See Print the Street address.
houseNumberSupplementText
- House number supplement as part of an address, e.g.public void setLanguage(@Nullable String language)
Original property name from the Odata EDM: Language
- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.
language
- The language key indicatespublic void setPOBox(@Nullable String pOBox)
Original property name from the Odata EDM: POBox
Only enter the PO Box number in this field. The text "PO Box" is provided in the recipient language by the system when you print the address.When you print an address, the "Street address" and the "PO Box address" are distinguished. The print program determines which of them has priority if both are maintained in an address record.Besides the PO Box number, the PO Box address uses the following fields:PO Box postal code, if specified (otherwise the normal postal code)PO Box city, if specified (otherwise the normal city)PO Box region, if specified (otherwise the normal region)PO Box country, if specified (otherwise the normal country)If the address is a "PO Box" (without a number), do not fill the "PO Box" field. Select the "PO Box w/o Number" indicator instead.You can also enter a company postal code for organizational addresses, instead of a PO Box. A separate field is predefined for this entry.For general information and examples about address formatting, see the documentation on the Address Structure Key.
pOBox
- PO Box number as part of an address.public void setPOBoxDeviatingCityName(@Nullable String pOBoxDeviatingCityName)
Original property name from the Odata EDM: POBoxDeviatingCityName
The PO Box city can be entered here if it is different from the address city.If the address is only a PO Box address, enter the city in the normal city field.If the address contains two different city names for the address and the PO Box address, use this field.
pOBoxDeviatingCityName
- Different city for the PO Box as an address component.public void setPOBoxDeviatingCountry(@Nullable String pOBoxDeviatingCountry)
Original property name from the Odata EDM: POBoxDeviatingCountry
The PO Box country can be entered here, if it is different from the street address country.If the address only has a PO Box address, the country is in the normal country field.Use this field if the address has two different country values for the street address and the PO Box address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
pOBoxDeviatingCountry
- Different PO Box country in address.public void setPOBoxDeviatingRegion(@Nullable String pOBoxDeviatingRegion)
Original property name from the Odata EDM: POBoxDeviatingRegion
Enter the PO Box Region here, if it differs from the street address region.If the address only has a PO Box address, the Region in in the normal Region field.Use this field if the address has two different Region values for the street address and the PO Box address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
pOBoxDeviatingRegion
- Different Region for PO Box in an address.public void setPOBoxIsWithoutNumber(@Nullable Boolean pOBoxIsWithoutNumber)
Original property name from the Odata EDM: POBoxIsWithoutNumber
Only the word 'PO Box' is output in PO Box addresses without PO Box number.Set this flag for a PO Box address without PO Box number.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
pOBoxIsWithoutNumber
- PO Box address without PO Box number flag.public void setPOBoxLobbyName(@Nullable String pOBoxLobbyName)
Original property name from the Odata EDM: POBoxLobbyName
In some countries, entering a PO box, postal code and city is not sufficient to uniquely identify a PO box, because the same PO box number is assigned multiple times in some cities.Therefore, additional information might be required to determine the post office of the PO box in question. This information can be entered in the field "PO Box Lobby."Mr NellingPO Box 4099HighfieldTimaru 7942The PO box lobby will only be taken into account for address formatting in countries in which it is commonly used in addition to regular postal delivery and PO boxes, for example, in Canada or New Zealand. In all other countries, this field will not be taken into account for address formatting.
pOBoxLobbyName
- The PO box lobby is part of the PO box address.public void setPOBoxPostalCode(@Nullable String pOBoxPostalCode)
Original property name from the Odata EDM: POBoxPostalCode
This field is used for countries where a different postal code applies to mail that is sent to the PO box rather than to the street address of a particular business partner.Postal codes for group major customers also have to be entered in the field for the PO box postal code since individual customers with a shared postal code for group major customers are differentiated by means of the PO box. Postal codes for major customers (= company postal codes), however, are assigned to one customer only and have to be entered in the field 'Company Postal Code'.
pOBoxPostalCode
- Postal code that is required for a unique assignment of the PO box.public void setPerson(@Nullable String person)
Original property name from the Odata EDM: Person
For more information about the meaning and use of the person number and Business Address Services concepts, see the function group SZA0 documentation.
person
- Internal key for identifying a person in Business Address Services.public void setPostalCode(@Nullable String postalCode)
Original property name from the Odata EDM: PostalCode
If different postal codes are maintained for the PO Box and Street address of an address, this field contains the Street address postal code.
postalCode
- Postal code as part of the addresspublic void setPrfrdCommMediumType(@Nullable String prfrdCommMediumType)
Original property name from the Odata EDM: PrfrdCommMediumType
In Business Address Services, you can specify a standard communication method that can be used by programs to determine the means of communication for sending messages.One business partner wants all messages by fax, another by e-mail.The application context can restrict the possible methods of communication. For example, invitations should perhaps only be sent by post because of enclosures, whereas minutes can be sent by post, fax or e-mail.Communication strategies can be defined for this purpose and applied in application contexts.
prfrdCommMediumType
- Communication method with which you can exchange documents and messages with a business partner.public void setRegion(@Nullable String region)
Original property name from the Odata EDM: Region
The automatic address formatting function prints the region in addresses in the USA, Canada, Italy, Brazil or Australia, and the county in Great Britain.For more information, see the examples in the documentation on the Address Layout Key.Meaning of the regional code in ...Australia -> ProvinceBrazil -> StateCanada -> ProvinceGermany -> StateGreat Britain -> CountyItaly -> ProvinceJapan -> PrefectureSwitzerland -> CantonUSA -> State
region
- In some countries, the region forms part of the address. The meaning depends on the country.public void setStreetName(@Nullable String streetName)
Original property name from the Odata EDM: StreetName
The street name is saved, redundantly in upper case in another database field, for search help purposes.There are other fields for address parts which can be printed above or below the street. See Print the Street address.The house number and other supplements are usually maintained in their own fields. See Formatting the Street line.
streetName
- Street name as part of the address.public void setStreetPrefixName(@Nullable String streetPrefixName)
Original property name from the Odata EDM: StreetPrefixName
The Street address contains two lines above the street and two lines below the street.See Print the Street address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
streetPrefixName
- Additional address field which is printed above the Street line.public void setStreetSuffixName(@Nullable String streetSuffixName)
Original property name from the Odata EDM: StreetSuffixName
The Street address contains two lines above the street and two lines below the street.See Print the Street address.
streetSuffixName
- Additional address field which is printed below the Street line.public void setTaxJurisdiction(@Nullable String taxJurisdiction)
Original property name from the Odata EDM: TaxJurisdiction
taxJurisdiction
- Specifies the tax jurisdiction.public void setTransportZone(@Nullable String transportZone)
Original property name from the Odata EDM: TransportZone
Regional zone of Goods recipient.Purchasing:Regional zone of supplier.You can define regional zones to suit the requirements of your own business and country.Sales and distributionthe system automatically proposes a suitable route by using the transportation zone of the goods recipient in combination with other information about the delivery, such as theCountries of origin and destinationShipping conditionsTransportation groupIn the USA, for example, you can define regional zones to correspond to the US postal zip codes.
transportZone
- Sales and distribution:public void setAddressIDByExternalSystem(@Nullable String addressIDByExternalSystem)
Original property name from the Odata EDM: AddressIDByExternalSystem
If the current address has a different number in an external system, you can save this number here for information purposes.In direct input you are able to maintain an address for a business partner by stating the external address number. If your business partner data is maintained in a legacy system, you can thus transmit changes to a BP address to the SAP system without having to know the SAP address number in the legacy system.
addressIDByExternalSystem
- Address number from an external system or a legacy systemprotected String getEndpointUrl()
getEndpointUrl
in class VdmEntity<BusinessPartnerAddress>
protected String getEntityCollection()
getEntityCollection
in class VdmEntity<BusinessPartnerAddress>
protected Map<String,Object> getKey()
getKey
in class VdmObject<BusinessPartnerAddress>
protected Map<String,Object> toMapOfFields()
toMapOfFields
in class VdmObject<BusinessPartnerAddress>
protected void fromMap(Map<String,Object> inputValues)
fromMap
in class VdmObject<BusinessPartnerAddress>
public static <T> BusinessPartnerAddressField<T> field(String fieldName, Class<T> fieldType)
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.protected Map<String,Object> toMapOfNavigationProperties()
toMapOfNavigationProperties
in class VdmObject<BusinessPartnerAddress>
public List<BuPaAddressUsage> fetchAddressUsage() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
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.public List<BuPaAddressUsage> getAddressUsageOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property to_AddressUsage of a queried BusinessPartnerAddress 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.
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.public Optional<List<BuPaAddressUsage>> getAddressUsageIfPresent()
If the navigation property for an entity BusinessPartnerAddress has not been resolved yet, this method will not query further information. Instead its Optional
result state will be empty
.
Optional
with result state empty
is returned.public void setAddressUsage(@NonNull List<BuPaAddressUsage> value)
If the navigation property to_AddressUsage of a queried BusinessPartnerAddress 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.
value
- List of BuPaAddressUsage entities.public void addAddressUsage(BuPaAddressUsage... entity)
If the navigation property to_AddressUsage of a queried BusinessPartnerAddress 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.
entity
- Array of BuPaAddressUsage entities.public List<AddressEmailAddress> fetchEmailAddress() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
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.public List<AddressEmailAddress> getEmailAddressOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property to_EmailAddress of a queried BusinessPartnerAddress 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.
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.public Optional<List<AddressEmailAddress>> getEmailAddressIfPresent()
If the navigation property for an entity BusinessPartnerAddress has not been resolved yet, this method will not query further information. Instead its Optional
result state will be empty
.
Optional
with result state empty
is returned.public void setEmailAddress(@NonNull List<AddressEmailAddress> value)
If the navigation property to_EmailAddress of a queried BusinessPartnerAddress 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.
value
- List of AddressEmailAddress entities.public void addEmailAddress(AddressEmailAddress... entity)
If the navigation property to_EmailAddress of a queried BusinessPartnerAddress 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.
entity
- Array of AddressEmailAddress entities.public List<AddressFaxNumber> fetchFaxNumber() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
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.public List<AddressFaxNumber> getFaxNumberOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property to_FaxNumber of a queried BusinessPartnerAddress 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.
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.public Optional<List<AddressFaxNumber>> getFaxNumberIfPresent()
If the navigation property for an entity BusinessPartnerAddress has not been resolved yet, this method will not query further information. Instead its Optional
result state will be empty
.
Optional
with result state empty
is returned.public void setFaxNumber(@NonNull List<AddressFaxNumber> value)
If the navigation property to_FaxNumber of a queried BusinessPartnerAddress 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.
value
- List of AddressFaxNumber entities.public void addFaxNumber(AddressFaxNumber... entity)
If the navigation property to_FaxNumber of a queried BusinessPartnerAddress 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.
entity
- Array of AddressFaxNumber entities.public List<AddressPhoneNumber> fetchMobilePhoneNumber() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
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.public List<AddressPhoneNumber> getMobilePhoneNumberOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property to_MobilePhoneNumber of a queried BusinessPartnerAddress 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.
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.public Optional<List<AddressPhoneNumber>> getMobilePhoneNumberIfPresent()
If the navigation property for an entity BusinessPartnerAddress has not been resolved yet, this method will not query further information. Instead its Optional
result state will be empty
.
Optional
with result state empty
is returned.public void setMobilePhoneNumber(@NonNull List<AddressPhoneNumber> value)
If the navigation property to_MobilePhoneNumber of a queried BusinessPartnerAddress 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.
value
- List of AddressPhoneNumber entities.public void addMobilePhoneNumber(AddressPhoneNumber... entity)
If the navigation property to_MobilePhoneNumber of a queried BusinessPartnerAddress 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.
entity
- Array of AddressPhoneNumber entities.public List<AddressPhoneNumber> fetchPhoneNumber() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
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.public List<AddressPhoneNumber> getPhoneNumberOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property to_PhoneNumber of a queried BusinessPartnerAddress 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.
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.public Optional<List<AddressPhoneNumber>> getPhoneNumberIfPresent()
If the navigation property for an entity BusinessPartnerAddress has not been resolved yet, this method will not query further information. Instead its Optional
result state will be empty
.
Optional
with result state empty
is returned.public void setPhoneNumber(@NonNull List<AddressPhoneNumber> value)
If the navigation property to_PhoneNumber of a queried BusinessPartnerAddress 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.
value
- List of AddressPhoneNumber entities.public void addPhoneNumber(AddressPhoneNumber... entity)
If the navigation property to_PhoneNumber of a queried BusinessPartnerAddress 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.
entity
- Array of AddressPhoneNumber entities.public List<AddressHomePageURL> fetchURLAddress() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
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.public List<AddressHomePageURL> getURLAddressOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property to_URLAddress of a queried BusinessPartnerAddress 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.
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.public Optional<List<AddressHomePageURL>> getURLAddressIfPresent()
If the navigation property for an entity BusinessPartnerAddress has not been resolved yet, this method will not query further information. Instead its Optional
result state will be empty
.
Optional
with result state empty
is returned.public void setURLAddress(@NonNull List<AddressHomePageURL> value)
If the navigation property to_URLAddress of a queried BusinessPartnerAddress 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.
value
- List of AddressHomePageURL entities.public void addURLAddress(AddressHomePageURL... entity)
If the navigation property to_URLAddress of a queried BusinessPartnerAddress 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.
entity
- Array of AddressHomePageURL entities.public static BusinessPartnerAddress.BusinessPartnerAddressBuilder builder()
@Nullable public String getBusinessPartner()
Original property name from the Odata EDM: BusinessPartner
@Nullable public String getAddressID()
Original property name from the Odata EDM: AddressID
For more information about the meaning and use of the address number and the Business Address Services concepts, see the function group SZA0 documentation.
@Nullable public ZonedDateTime getValidityStartDate()
Original property name from the Odata EDM: ValidityStartDate
@Nullable public ZonedDateTime getValidityEndDate()
Original property name from the Odata EDM: ValidityEndDate
@Nullable public String getAuthorizationGroup()
Original property name from the Odata EDM: AuthorizationGroup
Use the following authorization object:'Business partners: authorization groups' (B_BUPA_GRP).The system only checks this authorization if you made an entry in the "Authorization group" field for the business partner. Otherwise, any user may process the business partner.
@Nullable public UUID getAddressUUID()
Original property name from the Odata EDM: AddressUUID
@Nullable public String getAdditionalStreetPrefixName()
Original property name from the Odata EDM: AdditionalStreetPrefixName
The Street address contains two lines above the street and two lines below the street.See Print the Street address.
@Nullable public String getAdditionalStreetSuffixName()
Original property name from the Odata EDM: AdditionalStreetSuffixName
The Street address has two lines above the street and two lines below the steet.See Print the Street address.
@Nullable public String getAddressTimeZone()
Original property name from the Odata EDM: AddressTimeZone
The time zone is automatically determined by the system in address maintenance if time zone Customizing is maintained.It depends on the country and the region. (Region means state, province or county, depending on the country)The automatic determination is only made if there is no value in the time zone field.
@Nullable public String getCareOfName()
Original property name from the Odata EDM: CareOfName
Put the country-specific code (e.g. c/o) in front of the name of the occupant. This is not automatically done in the print format, like the language-specific word "PO Box".John Smithc/o David BrownThis field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
@Nullable public String getCityCode()
Original property name from the Odata EDM: CityCode
@Nullable public String getCityName()
Original property name from the Odata EDM: CityName
The city name is saved redundantly in another database field in upper- case letters, for search help.If the Postal regional structure ('city file') is active, the city name is checked against the Cities defined in the regional structure.
@Nullable public String getCompanyPostalCode()
Original property name from the Odata EDM: CompanyPostalCode
This field is used for countries where major companies are assigned their own postal code by the national post office.This postal code has to be entered in the field "Company Postal Code". Postal codes for group major customers, however, have to be entered in the field "PO Box Postal Code", since individual customers with a shared postal code for group major customers are differentiated by means of their PO box.
@Nullable public String getCountry()
Original property name from the Odata EDM: Country
The two-character ISO code in accordance with ISO 3166, which is delivered by SAP as a default, is usually used.It could also be the vehicle license plate country-code or a typical country key, for example, in Germany the Federal statistics office key.The country keys are determined at system installation in the global settings.The definition of the country key in the SAP system does not have to match political or government entities.Since the country key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country key cannot query the country key T005-LAND1, but have to program based on the ISO code T005 INTCA.
@Nullable public String getCounty()
Original property name from the Odata EDM: County
This field is used to store the county’s name. You can enter the name of the county in this field.
@Nullable public String getDeliveryServiceNumber()
Original property name from the Odata EDM: DeliveryServiceNumber
Some countries offer different services in addition to regular postal delivery and PO boxes, for example the Private Bag or Response Bag. If an address is related to one of these delivery services, the information about this particular delivery service has to be entered in the corresponding fields.In the field "Number of Delivery Service," the number of the Private Bag, Response Bag, or other relevant service has to be entered. Entering a number is not mandatory for each delivery service.For each address, either the information about the PO box or the information about the delivery service can be entered, but not both types of information at the same time.Mr PickeringPrivate Bag 106999Timaru 7942Delivery services will only be taken into account for address formatting in countries in which they are commonly used in addition to regular postal delivery and PO boxes, for example, in Australia, New Zealand, and the USA. In all other countries, these fields will not be taken into account for address formatting.
@Nullable public String getDeliveryServiceTypeCode()
Original property name from the Odata EDM: DeliveryServiceTypeCode
Some countries offer different services in addition to regular postal delivery and PO boxes, for example the Private Bag or Response Bag. If an address is related to one of these delivery services, the information about this particular delivery service has to be entered in the corresponding fields.In the field "Type of Delivery Service," the type of the delivery service has to be entered.For each address, either the information about the PO box or the information about the delivery service can be entered, but not both types of information at the same time.Mr PickeringPrivate Bag 106999Timaru 7942Delivery services will only be taken into account for address formatting in countries in which they are commonly used in addition to regular postal delivery and PO boxes, for example, in Australia, New Zealand, and the USA. In all other countries, these fields will not be taken into account for address formatting.
@Nullable public String getDistrict()
Original property name from the Odata EDM: District
In some countries, this entry is appended with a hyphen to the city name by the automatic address formatting, other countries, it is output on a line of its own or (e.g. in the USA) not printed.See the examples in the Address Layout Key documentation.
@Nullable public String getFormOfAddress()
Original property name from the Odata EDM: FormOfAddress
You can also define a form of address text in Customizing.The form of address text can be maintained in different languages.
@Nullable public String getFullName()
Original property name from the Odata EDM: FullName
For organizations or document addresses, typically the fields Name1 and Name2 are concatenated.For persons the field contains the formatted name according to country specific rules. It corresponds e.g. to the content of the fields BUT000-NAME1_TEXT or ADRP-NAME_TEXT.
@Nullable public String getHomeCityName()
Original property name from the Odata EDM: HomeCityName
In some countries, the residential city is required if it differs from the postal city.In the USA, the official street indexes, against which data can be checked, are based on the residential city, not the postal city, which may be different.It is the same in France, where a postally correct address must contain the residential city in a separate line above the postal city, if it differs from the postal city.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
@Nullable public String getHouseNumber()
Original property name from the Odata EDM: HouseNumber
It is printed in the Street line.Other supplementary street information can be entered in the House number supplement or one of the Street2, Street3, Street4 or Street5 fields. See Print the Street address.A house number (e.g. 117) or a house number with supplement (e.g. 117a), or a house number range (e.g. 16-20), can be maintained in this field.
@Nullable public String getHouseNumberSupplementText()
Original property name from the Odata EDM: HouseNumberSupplementText
App. 17 orSuite 600.It is printed in the Street line.Further Street supplements can be put in one of the fields Street2, Street3, Street4 or Street5.See Print the Street address.
@Nullable public String getLanguage()
Original property name from the Odata EDM: Language
- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.
@Nullable public String getPOBox()
Original property name from the Odata EDM: POBox
Only enter the PO Box number in this field. The text "PO Box" is provided in the recipient language by the system when you print the address.When you print an address, the "Street address" and the "PO Box address" are distinguished. The print program determines which of them has priority if both are maintained in an address record.Besides the PO Box number, the PO Box address uses the following fields:PO Box postal code, if specified (otherwise the normal postal code)PO Box city, if specified (otherwise the normal city)PO Box region, if specified (otherwise the normal region)PO Box country, if specified (otherwise the normal country)If the address is a "PO Box" (without a number), do not fill the "PO Box" field. Select the "PO Box w/o Number" indicator instead.You can also enter a company postal code for organizational addresses, instead of a PO Box. A separate field is predefined for this entry.For general information and examples about address formatting, see the documentation on the Address Structure Key.
@Nullable public String getPOBoxDeviatingCityName()
Original property name from the Odata EDM: POBoxDeviatingCityName
The PO Box city can be entered here if it is different from the address city.If the address is only a PO Box address, enter the city in the normal city field.If the address contains two different city names for the address and the PO Box address, use this field.
@Nullable public String getPOBoxDeviatingCountry()
Original property name from the Odata EDM: POBoxDeviatingCountry
The PO Box country can be entered here, if it is different from the street address country.If the address only has a PO Box address, the country is in the normal country field.Use this field if the address has two different country values for the street address and the PO Box address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
@Nullable public String getPOBoxDeviatingRegion()
Original property name from the Odata EDM: POBoxDeviatingRegion
Enter the PO Box Region here, if it differs from the street address region.If the address only has a PO Box address, the Region in in the normal Region field.Use this field if the address has two different Region values for the street address and the PO Box address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
@Nullable public Boolean getPOBoxIsWithoutNumber()
Original property name from the Odata EDM: POBoxIsWithoutNumber
Only the word 'PO Box' is output in PO Box addresses without PO Box number.Set this flag for a PO Box address without PO Box number.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
@Nullable public String getPOBoxLobbyName()
Original property name from the Odata EDM: POBoxLobbyName
In some countries, entering a PO box, postal code and city is not sufficient to uniquely identify a PO box, because the same PO box number is assigned multiple times in some cities.Therefore, additional information might be required to determine the post office of the PO box in question. This information can be entered in the field "PO Box Lobby."Mr NellingPO Box 4099HighfieldTimaru 7942The PO box lobby will only be taken into account for address formatting in countries in which it is commonly used in addition to regular postal delivery and PO boxes, for example, in Canada or New Zealand. In all other countries, this field will not be taken into account for address formatting.
@Nullable public String getPOBoxPostalCode()
Original property name from the Odata EDM: POBoxPostalCode
This field is used for countries where a different postal code applies to mail that is sent to the PO box rather than to the street address of a particular business partner.Postal codes for group major customers also have to be entered in the field for the PO box postal code since individual customers with a shared postal code for group major customers are differentiated by means of the PO box. Postal codes for major customers (= company postal codes), however, are assigned to one customer only and have to be entered in the field 'Company Postal Code'.
@Nullable public String getPerson()
Original property name from the Odata EDM: Person
For more information about the meaning and use of the person number and Business Address Services concepts, see the function group SZA0 documentation.
@Nullable public String getPostalCode()
Original property name from the Odata EDM: PostalCode
If different postal codes are maintained for the PO Box and Street address of an address, this field contains the Street address postal code.
@Nullable public String getPrfrdCommMediumType()
Original property name from the Odata EDM: PrfrdCommMediumType
In Business Address Services, you can specify a standard communication method that can be used by programs to determine the means of communication for sending messages.One business partner wants all messages by fax, another by e-mail.The application context can restrict the possible methods of communication. For example, invitations should perhaps only be sent by post because of enclosures, whereas minutes can be sent by post, fax or e-mail.Communication strategies can be defined for this purpose and applied in application contexts.
@Nullable public String getRegion()
Original property name from the Odata EDM: Region
The automatic address formatting function prints the region in addresses in the USA, Canada, Italy, Brazil or Australia, and the county in Great Britain.For more information, see the examples in the documentation on the Address Layout Key.Meaning of the regional code in ...Australia -> ProvinceBrazil -> StateCanada -> ProvinceGermany -> StateGreat Britain -> CountyItaly -> ProvinceJapan -> PrefectureSwitzerland -> CantonUSA -> State
@Nullable public String getStreetName()
Original property name from the Odata EDM: StreetName
The street name is saved, redundantly in upper case in another database field, for search help purposes.There are other fields for address parts which can be printed above or below the street. See Print the Street address.The house number and other supplements are usually maintained in their own fields. See Formatting the Street line.
@Nullable public String getStreetPrefixName()
Original property name from the Odata EDM: StreetPrefixName
The Street address contains two lines above the street and two lines below the street.See Print the Street address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.
@Nullable public String getStreetSuffixName()
Original property name from the Odata EDM: StreetSuffixName
The Street address contains two lines above the street and two lines below the street.See Print the Street address.
@Nullable public String getTaxJurisdiction()
Original property name from the Odata EDM: TaxJurisdiction
@Nullable public String getTransportZone()
Original property name from the Odata EDM: TransportZone
Regional zone of Goods recipient.Purchasing:Regional zone of supplier.You can define regional zones to suit the requirements of your own business and country.Sales and distributionthe system automatically proposes a suitable route by using the transportation zone of the goods recipient in combination with other information about the delivery, such as theCountries of origin and destinationShipping conditionsTransportation groupIn the USA, for example, you can define regional zones to correspond to the US postal zip codes.
@Nullable public String getAddressIDByExternalSystem()
Original property name from the Odata EDM: AddressIDByExternalSystem
If the current address has a different number in an external system, you can save this number here for information purposes.In direct input you are able to maintain an address for a business partner by stating the external address number. If your business partner data is maintained in a legacy system, you can thus transmit changes to a BP address to the SAP system without having to know the SAP address number in the legacy system.
@Nullable public ErpConfigContext getErpConfigContext()
public void setErpConfigContext(@Nullable ErpConfigContext erpConfigContext)
setErpConfigContext
in class VdmEntity<BusinessPartnerAddress>
erpConfigContext
- public String toString()
toString
in class VdmObject<BusinessPartnerAddress>
public boolean equals(Object o)
equals
in class VdmObject<BusinessPartnerAddress>
protected boolean canEqual(Object other)
canEqual
in class VdmObject<BusinessPartnerAddress>
public int hashCode()
hashCode
in class VdmObject<BusinessPartnerAddress>
Copyright © 2018 SAP SE. All rights reserved.