public class AddressPhoneNumber extends VdmEntity<AddressPhoneNumber>
Original entity name from the Odata EDM: A_AddressPhoneNumberType
Modifier and Type | Class and Description |
---|---|
static class |
AddressPhoneNumber.AddressPhoneNumberBuilder |
Modifier and Type | Field and Description |
---|---|
static AddressPhoneNumberField<String> |
ADDRESS_ID
Use with available fluent helpers to apply the AddressID field to query operations.
|
static AddressPhoneNumberSelectable |
ALL_FIELDS
Selector for all available fields of AddressPhoneNumber.
|
static AddressPhoneNumberField<String> |
DESTINATION_LOCATION_COUNTRY
Use with available fluent helpers to apply the DestinationLocationCountry field to query operations.
|
static AddressPhoneNumberField<String> |
INTERNATIONAL_PHONE_NUMBER
Use with available fluent helpers to apply the InternationalPhoneNumber field to query operations.
|
static AddressPhoneNumberField<Boolean> |
IS_DEFAULT_PHONE_NUMBER
Use with available fluent helpers to apply the IsDefaultPhoneNumber field to query operations.
|
static AddressPhoneNumberField<String> |
ORDINAL_NUMBER
Use with available fluent helpers to apply the OrdinalNumber field to query operations.
|
static AddressPhoneNumberField<String> |
PERSON
Use with available fluent helpers to apply the Person field to query operations.
|
static AddressPhoneNumberField<String> |
PHONE_NUMBER
Use with available fluent helpers to apply the PhoneNumber field to query operations.
|
static AddressPhoneNumberField<String> |
PHONE_NUMBER_EXTENSION
Use with available fluent helpers to apply the PhoneNumberExtension field to query operations.
|
static AddressPhoneNumberField<String> |
PHONE_NUMBER_TYPE
Use with available fluent helpers to apply the PhoneNumberType field to query operations.
|
changedOriginalFields
Constructor and Description |
---|
AddressPhoneNumber() |
AddressPhoneNumber(String addressID,
String person,
String ordinalNumber,
String destinationLocationCountry,
Boolean isDefaultPhoneNumber,
String phoneNumber,
String phoneNumberExtension,
String internationalPhoneNumber,
String phoneNumberType) |
Modifier and Type | Method and Description |
---|---|
void |
attachToService(String servicePath,
HttpDestinationProperties destination)
Sets the service path and destination for the fetch commands of this entity.
|
static AddressPhoneNumber.AddressPhoneNumberBuilder |
builder() |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
static <T> AddressPhoneNumberField<T> |
field(String fieldName,
Class<T> fieldType)
Use with available fluent helpers to apply an extension field to query operations.
|
static <T,DomainT> |
field(String fieldName,
TypeConverter<T,DomainT> typeConverter)
Use with available fluent helpers to apply an extension field to query operations.
|
protected void |
fromMap(Map<String,Object> inputValues) |
String |
getAddressID()
(Key Field) Constraints: Not nullable, Maximum length: 10
|
protected String |
getDefaultServicePath()
Used by fluent helpers and navigation property methods to construct OData queries.
|
HttpDestinationProperties |
getDestinationForFetch()
Convienence field for reusing the same destination with multiple queries (e.g.
|
String |
getDestinationLocationCountry()
Constraints: Not nullable, Maximum length: 3
|
protected String |
getEntityCollection()
Used by fluent helpers and navigation property methods to construct OData queries.
|
String |
getInternationalPhoneNumber()
Constraints: Not nullable, Maximum length: 30
|
Boolean |
getIsDefaultPhoneNumber()
Constraints: none
|
protected Map<String,Object> |
getKey() |
String |
getOrdinalNumber()
(Key Field) Constraints: Not nullable, Maximum length: 3
|
String |
getPerson()
(Key Field) Constraints: Not nullable, Maximum length: 10
|
String |
getPhoneNumber()
Constraints: Not nullable, Maximum length: 30
|
String |
getPhoneNumberExtension()
Constraints: Not nullable, Maximum length: 10
|
String |
getPhoneNumberType()
Constraints: Not nullable, Maximum length: 1
|
Class<AddressPhoneNumber> |
getType() |
int |
hashCode() |
void |
setAddressID(String addressID)
(Key Field) Constraints: Not nullable, Maximum length: 10
|
void |
setDestinationLocationCountry(String destinationLocationCountry)
Constraints: Not nullable, Maximum length: 3
|
void |
setInternationalPhoneNumber(String internationalPhoneNumber)
Constraints: Not nullable, Maximum length: 30
|
void |
setIsDefaultPhoneNumber(Boolean isDefaultPhoneNumber)
Constraints: none
|
void |
setOrdinalNumber(String ordinalNumber)
(Key Field) Constraints: Not nullable, Maximum length: 3
|
void |
setPerson(String person)
(Key Field) Constraints: Not nullable, Maximum length: 10
|
void |
setPhoneNumber(String phoneNumber)
Constraints: Not nullable, Maximum length: 30
|
void |
setPhoneNumberExtension(String phoneNumberExtension)
Constraints: Not nullable, Maximum length: 10
|
void |
setPhoneNumberType(String phoneNumberType)
Constraints: Not nullable, Maximum length: 1
|
protected void |
setServicePathForFetch(String servicePathForFetch)
The service path only used for the fetch commands of this entity.
|
protected Map<String,Object> |
toMapOfFields() |
String |
toString() |
getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields, toMapOfNavigationProperties
public static final AddressPhoneNumberSelectable ALL_FIELDS
public static final AddressPhoneNumberField<String> ADDRESS_ID
public static final AddressPhoneNumberField<String> PERSON
public static final AddressPhoneNumberField<String> ORDINAL_NUMBER
public static final AddressPhoneNumberField<String> DESTINATION_LOCATION_COUNTRY
public static final AddressPhoneNumberField<Boolean> IS_DEFAULT_PHONE_NUMBER
public static final AddressPhoneNumberField<String> PHONE_NUMBER
public static final AddressPhoneNumberField<String> PHONE_NUMBER_EXTENSION
public static final AddressPhoneNumberField<String> INTERNATIONAL_PHONE_NUMBER
public static final AddressPhoneNumberField<String> PHONE_NUMBER_TYPE
public AddressPhoneNumber()
public AddressPhoneNumber(@Nullable String addressID, @Nullable String person, @Nullable String ordinalNumber, @Nullable String destinationLocationCountry, @Nullable Boolean isDefaultPhoneNumber, @Nullable String phoneNumber, @Nullable String phoneNumberExtension, @Nullable String internationalPhoneNumber, @Nullable String phoneNumberType)
@Nonnull public Class<AddressPhoneNumber> getType()
getType
in class VdmObject<AddressPhoneNumber>
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 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 setOrdinalNumber(@Nullable String ordinalNumber)
Original property name from the Odata EDM: OrdinalNumber
ordinalNumber
- Sequence Numberpublic void setDestinationLocationCountry(@Nullable String destinationLocationCountry)
Original property name from the Odata EDM: DestinationLocationCountry
This specification is used to determine the correct country code. A normalized form of the telephone number or fax number is then derived and stored in a field for a program-driven search.In most cases, the telephone number or fax number refers directly to an address.If this is the case, when a new number is created, the country of the address is proposed.If this is not the case (for example, with address-independent communication data for a business partner), the country from the user parameter LND is proposed (if it is maintained). If the user parameter LND is not maintained, the country of the company address assigned in the user master data is proposed.If the country of the address changes, the country of the corresponding telephone number and fax address is not changed automatically.Example: A business partner moves abroad.If the telephone number is for a permanent connection, the telephone number also changes when the business partner moves and has to be maintained again in the system.If the telephone number is for a mobile telephone and the number is retained, the original country for this telephone number also has to be retained and must not be changed automatically to the new country of the address.
destinationLocationCountry
- The country for the telephone number or fax number is maintained here.public void setIsDefaultPhoneNumber(@Nullable Boolean isDefaultPhoneNumber)
Original property name from the Odata EDM: IsDefaultPhoneNumber
The standard address is used for the following functions:When sending using the SMTP nodein SAPconnect, the home address of the communication type used is the one set as the sender address. The recipient can see this address in the sender information and can also reply directly to this address. The standard address is also transferred and can be used for incoming status notifications, for example.When sending using an RFC node in SAPconnect, the standard address of the communication type used is the one set as the sender address. The structure defined in the case of the RFC does not permit another address to be transferred, so the standard address is used for incoming status notifications too.The SAP users have the addresses of their exchange P.O. boxes in their standard communication type 'Internet Mail' as the home address and their Internet address in the SAP system as their standard address. Example:Home address: Bernard.Brown@Company.comStandard address: Bernard.Brown@System.Company.comSending using an SMTP nodeThe home address of the communication type 'Internet Mail' (Bernard.Brown@Company.com) is used as the sender address. If a reply is sent to this address the user receives directly in the exchange postbox.Sending using the RFC nodeThe standard address of the communication type 'Internet Mail' (Bernard.Brown@System.Company.com) is used as the sender address. If a reply is sent to this address, it arrives back to the SAP system.Example using a mail system groupThe users should get all messages in their Microsoft Exchange postboxes. In the SAP system the mail system group is activated for this using the setting "Send Messages to the Home Address".The address settings of the SAP users remain unchanged:Home address: Bernard.Brown@Company.comStandard address: Bernard.Brown@System.Company.comSending using an SMTP nodeThe home address of the communication type 'Internet Mail' (Bernard.Brown@Company.com) is used as the sender address. If a reply is sent to this address the user receives directly in the exchange postbox.Sending using the RFC nodeThe standard address of the communication type 'Internet Mail' (Bernard.Brown@System.Company.com) is used as the sender address. If a reply is sent to this address it arrives back in the SAP system. It is then forwarded using the mail system group to the home address and the user gets it in the exchange postbox.
isDefaultPhoneNumber
- If several addresses are maintained for one communication type, the user in the SAP System can be
reached under one of these addresses. One address can be set as theStandard Address.public void setPhoneNumber(@Nullable String phoneNumber)
Original property name from the Odata EDM: PhoneNumber
If the telephone number consists of a company number and an extension, the extension must be entered in the field extension.Telephone number, as it is dialled from within the country.For the number "01234/567-0" enter the following:Telephone: 01234/567Estension: 0For the number "01234/567-891" enter the following:Telephone: 01234/567Extension: 891For the number "012-345-678" (678 as extension) enter the following:Telepone: 012-345Extension: 678In the following cases enter the complete number (without country dialling code) in the field Telephone:No part of the number can be regarded as an extension.You are not sure which part of the number can be regarded as an extension.
phoneNumber
- Telephone number, consisting of dialling code and number, but without country dialling code.public void setPhoneNumberExtension(@Nullable String phoneNumberExtension)
Original property name from the Odata EDM: PhoneNumberExtension
If the telephone number consists of a company number and an extension, the extension should be entered here.Enter the extension.The following rules apply for the format of telephone and fax numbers:The length of the entries in the field Telephone and Extension (Fax and Extension) cannot be more than 24 characters in total.Leading spaces are not allowed in the field Telephone or Fax or in the field Extension.Valid characters are:Numbers (0123456789)Letters (ABCDEFGHIJKLMNOPQRSTUVWXYZ)Following other characters: /, (, ), - *, # and " " (space), but not as a leading space.If an + is entered as the first character, the system checks whether the specified number starts with a country code. If so, a warning message is displayed because the country code is automatically determined by the system and should not be stored in the Telephone number (Fax number) field.If an & is entered as the first character, the automatic check and formatting of the telephone number (fax number), as well as the determination of the country code, is suppressed.For the number "01234/567-0" enter the following:Telephone: 01234/567Estension: 0For the number "01234/567-891" enter the following:Telephone: 01234/567Extension: 891For the number "012-345-678" (678 as extension) enter the following:Telepone: 012-345Extension: 678In the following cases enter the complete number (without country dialling code) in the field Telephone:No part of the number can be regarded as an extension.You are not sure which part of the number can be regarded as an extension.
phoneNumberExtension
- Telephone extension numberpublic void setInternationalPhoneNumber(@Nullable String internationalPhoneNumber)
Original property name from the Odata EDM: InternationalPhoneNumber
This field is therefore not to be filled when Business Address Services function modules are called.
internationalPhoneNumber
- The content of this field is automatically calculated by the system based on the telephone number and
country code components.public void setPhoneNumberType(@Nullable String phoneNumberType)
Original property name from the Odata EDM: PhoneNumberType
' ' : The telephone number is a fixed-line telephone'1' : The telephone number is the standard fixed-line telephone'2' : The telephone nubmer is a mobile telephone'3' : The telephone number is the standard mobile telephoneEither the standard fixed-line telephone number or the standard mobile telephone number is also the standard telephone number (FLGDEFAULT = 'X').In older data sets, this field may have also have the value ' ' for the standard fixed-line telephone. In this case, however, FLGDEFAULT is always 'X'.In Customizing, you can specify whether the SMS-compatible indicator is to be proposed for new mobile telephone numbers created in dialog by choosing General Settings -> Set countries -> Define Mobile Telephone Attributes for each country.
phoneNumberType
- This field specifies whether the telephone number is a mobile telephone number.protected String getEntityCollection()
VdmEntity
getEntityCollection
in class VdmEntity<AddressPhoneNumber>
@Nonnull protected Map<String,Object> getKey()
getKey
in class VdmObject<AddressPhoneNumber>
@Nonnull protected Map<String,Object> toMapOfFields()
toMapOfFields
in class VdmObject<AddressPhoneNumber>
protected void fromMap(Map<String,Object> inputValues)
fromMap
in class VdmObject<AddressPhoneNumber>
@Nonnull public static <T> AddressPhoneNumberField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
T
- The type of the extension field when performing value comparisons.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.@Nonnull public static <T,DomainT> AddressPhoneNumberField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
T
- The type of the extension field when performing value comparisons.DomainT
- The type of the extension field as returned by the OData service.typeConverter
- A TypeConverterfieldName
- The name of the extension field as returned by the OData service.@Nullable public HttpDestinationProperties getDestinationForFetch()
VdmEntity
getDestinationForFetch
in class VdmEntity<AddressPhoneNumber>
protected void setServicePathForFetch(@Nullable String servicePathForFetch)
VdmEntity
Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.
setServicePathForFetch
in class VdmEntity<AddressPhoneNumber>
public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
VdmEntity
Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.
attachToService
in class VdmEntity<AddressPhoneNumber>
servicePath
- Optional parameter. New service path to apply to this entity and any associated entities that were
previously fetched. If a null value is provided and the service path has never been set, then the
service path will be set to the default defined in the corresponding service interface.destination
- New destination to apply to this entity and any associated entities that were previously fetched.protected String getDefaultServicePath()
VdmEntity
getDefaultServicePath
in class VdmEntity<AddressPhoneNumber>
protocol://hostname:port
and the OData resource name (entity set, $metadata
, etc.)public static AddressPhoneNumber.AddressPhoneNumberBuilder builder()
@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 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 getOrdinalNumber()
Original property name from the Odata EDM: OrdinalNumber
@Nullable public String getDestinationLocationCountry()
Original property name from the Odata EDM: DestinationLocationCountry
This specification is used to determine the correct country code. A normalized form of the telephone number or fax number is then derived and stored in a field for a program-driven search.In most cases, the telephone number or fax number refers directly to an address.If this is the case, when a new number is created, the country of the address is proposed.If this is not the case (for example, with address-independent communication data for a business partner), the country from the user parameter LND is proposed (if it is maintained). If the user parameter LND is not maintained, the country of the company address assigned in the user master data is proposed.If the country of the address changes, the country of the corresponding telephone number and fax address is not changed automatically.Example: A business partner moves abroad.If the telephone number is for a permanent connection, the telephone number also changes when the business partner moves and has to be maintained again in the system.If the telephone number is for a mobile telephone and the number is retained, the original country for this telephone number also has to be retained and must not be changed automatically to the new country of the address.
@Nullable public Boolean getIsDefaultPhoneNumber()
Original property name from the Odata EDM: IsDefaultPhoneNumber
The standard address is used for the following functions:When sending using the SMTP nodein SAPconnect, the home address of the communication type used is the one set as the sender address. The recipient can see this address in the sender information and can also reply directly to this address. The standard address is also transferred and can be used for incoming status notifications, for example.When sending using an RFC node in SAPconnect, the standard address of the communication type used is the one set as the sender address. The structure defined in the case of the RFC does not permit another address to be transferred, so the standard address is used for incoming status notifications too.The SAP users have the addresses of their exchange P.O. boxes in their standard communication type 'Internet Mail' as the home address and their Internet address in the SAP system as their standard address. Example:Home address: Bernard.Brown@Company.comStandard address: Bernard.Brown@System.Company.comSending using an SMTP nodeThe home address of the communication type 'Internet Mail' (Bernard.Brown@Company.com) is used as the sender address. If a reply is sent to this address the user receives directly in the exchange postbox.Sending using the RFC nodeThe standard address of the communication type 'Internet Mail' (Bernard.Brown@System.Company.com) is used as the sender address. If a reply is sent to this address, it arrives back to the SAP system.Example using a mail system groupThe users should get all messages in their Microsoft Exchange postboxes. In the SAP system the mail system group is activated for this using the setting "Send Messages to the Home Address".The address settings of the SAP users remain unchanged:Home address: Bernard.Brown@Company.comStandard address: Bernard.Brown@System.Company.comSending using an SMTP nodeThe home address of the communication type 'Internet Mail' (Bernard.Brown@Company.com) is used as the sender address. If a reply is sent to this address the user receives directly in the exchange postbox.Sending using the RFC nodeThe standard address of the communication type 'Internet Mail' (Bernard.Brown@System.Company.com) is used as the sender address. If a reply is sent to this address it arrives back in the SAP system. It is then forwarded using the mail system group to the home address and the user gets it in the exchange postbox.
@Nullable public String getPhoneNumber()
Original property name from the Odata EDM: PhoneNumber
If the telephone number consists of a company number and an extension, the extension must be entered in the field extension.Telephone number, as it is dialled from within the country.For the number "01234/567-0" enter the following:Telephone: 01234/567Estension: 0For the number "01234/567-891" enter the following:Telephone: 01234/567Extension: 891For the number "012-345-678" (678 as extension) enter the following:Telepone: 012-345Extension: 678In the following cases enter the complete number (without country dialling code) in the field Telephone:No part of the number can be regarded as an extension.You are not sure which part of the number can be regarded as an extension.
@Nullable public String getPhoneNumberExtension()
Original property name from the Odata EDM: PhoneNumberExtension
If the telephone number consists of a company number and an extension, the extension should be entered here.Enter the extension.The following rules apply for the format of telephone and fax numbers:The length of the entries in the field Telephone and Extension (Fax and Extension) cannot be more than 24 characters in total.Leading spaces are not allowed in the field Telephone or Fax or in the field Extension.Valid characters are:Numbers (0123456789)Letters (ABCDEFGHIJKLMNOPQRSTUVWXYZ)Following other characters: /, (, ), - *, # and " " (space), but not as a leading space.If an + is entered as the first character, the system checks whether the specified number starts with a country code. If so, a warning message is displayed because the country code is automatically determined by the system and should not be stored in the Telephone number (Fax number) field.If an & is entered as the first character, the automatic check and formatting of the telephone number (fax number), as well as the determination of the country code, is suppressed.For the number "01234/567-0" enter the following:Telephone: 01234/567Estension: 0For the number "01234/567-891" enter the following:Telephone: 01234/567Extension: 891For the number "012-345-678" (678 as extension) enter the following:Telepone: 012-345Extension: 678In the following cases enter the complete number (without country dialling code) in the field Telephone:No part of the number can be regarded as an extension.You are not sure which part of the number can be regarded as an extension.
@Nullable public String getInternationalPhoneNumber()
Original property name from the Odata EDM: InternationalPhoneNumber
This field is therefore not to be filled when Business Address Services function modules are called.
@Nullable public String getPhoneNumberType()
Original property name from the Odata EDM: PhoneNumberType
' ' : The telephone number is a fixed-line telephone'1' : The telephone number is the standard fixed-line telephone'2' : The telephone nubmer is a mobile telephone'3' : The telephone number is the standard mobile telephoneEither the standard fixed-line telephone number or the standard mobile telephone number is also the standard telephone number (FLGDEFAULT = 'X').In older data sets, this field may have also have the value ' ' for the standard fixed-line telephone. In this case, however, FLGDEFAULT is always 'X'.In Customizing, you can specify whether the SMS-compatible indicator is to be proposed for new mobile telephone numbers created in dialog by choosing General Settings -> Set countries -> Define Mobile Telephone Attributes for each country.
public String toString()
toString
in class VdmObject<AddressPhoneNumber>
public boolean equals(Object o)
equals
in class VdmObject<AddressPhoneNumber>
protected boolean canEqual(Object other)
canEqual
in class VdmObject<AddressPhoneNumber>
public int hashCode()
hashCode
in class VdmObject<AddressPhoneNumber>
Copyright © 2020 SAP SE. All rights reserved.