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

Class AddressEmailAddress

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<AddressEmailAddress>

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

public class AddressEmailAddress
extends VdmEntity<AddressEmailAddress>

Email Address

Original entity name from the Odata EDM: A_AddressEmailAddressType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddressEmailAddress.AddressEmailAddressBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static AddressEmailAddressField<String>	ADDRESS_COMMUNICATION_REMARK_TEXT Use with available fluent helpers to apply the AddressCommunicationRemarkText field to query operations.
static AddressEmailAddressField<String>	ADDRESS_ID Use with available fluent helpers to apply the AddressID field to query operations.
static AddressEmailAddressSelectable	ALL_FIELDS Selector for all available fields of AddressEmailAddress.
static AddressEmailAddressField<String>	EMAIL_ADDRESS Use with available fluent helpers to apply the EmailAddress field to query operations.
static AddressEmailAddressField<Boolean>	IS_DEFAULT_EMAIL_ADDRESS Use with available fluent helpers to apply the IsDefaultEmailAddress field to query operations.
static AddressEmailAddressField<String>	ORDINAL_NUMBER Use with available fluent helpers to apply the OrdinalNumber field to query operations.
static AddressEmailAddressField<String>	PERSON Use with available fluent helpers to apply the Person field to query operations.
static AddressEmailAddressField<String>	SEARCH_EMAIL_ADDRESS Use with available fluent helpers to apply the SearchEmailAddress field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
AddressEmailAddress()
AddressEmailAddress(String addressID, String person, String ordinalNumber, Boolean isDefaultEmailAddress, String emailAddress, String searchEmailAddress, String addressCommunicationRemarkText)

Method Summary

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 AddressEmailAddress.AddressEmailAddressBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static <T> AddressEmailAddressField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> AddressEmailAddressField<T>	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	getAddressCommunicationRemarkText() Constraints: Not nullable, Maximum length: 50
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	getEmailAddress() Constraints: Not nullable, Maximum length: 241
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
Boolean	getIsDefaultEmailAddress() 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	getSearchEmailAddress() Constraints: Not nullable, Maximum length: 20
Class<AddressEmailAddress>	getType()
int	hashCode()
void	setAddressCommunicationRemarkText(String addressCommunicationRemarkText) Constraints: Not nullable, Maximum length: 50
void	setAddressID(String addressID) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setEmailAddress(String emailAddress) Constraints: Not nullable, Maximum length: 241
void	setIsDefaultEmailAddress(Boolean isDefaultEmailAddress) 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	setSearchEmailAddress(String searchEmailAddress) Constraints: Not nullable, Maximum length: 20
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
protected Map<String,Object>	toMapOfFields()
String	toString()

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

getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

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

getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields, toMapOfNavigationProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final AddressEmailAddressSelectable ALL_FIELDS

Selector for all available fields of AddressEmailAddress.

ADDRESS_ID

public static final AddressEmailAddressField<String> ADDRESS_ID

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

PERSON

public static final AddressEmailAddressField<String> PERSON

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

ORDINAL_NUMBER

public static final AddressEmailAddressField<String> ORDINAL_NUMBER

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

IS_DEFAULT_EMAIL_ADDRESS

public static final AddressEmailAddressField<Boolean> IS_DEFAULT_EMAIL_ADDRESS

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

EMAIL_ADDRESS

public static final AddressEmailAddressField<String> EMAIL_ADDRESS

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

SEARCH_EMAIL_ADDRESS

public static final AddressEmailAddressField<String> SEARCH_EMAIL_ADDRESS

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

ADDRESS_COMMUNICATION_REMARK_TEXT

public static final AddressEmailAddressField<String> ADDRESS_COMMUNICATION_REMARK_TEXT

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

Constructor Detail

AddressEmailAddress

public AddressEmailAddress()

AddressEmailAddress

public AddressEmailAddress(@Nullable
                           String addressID,
                           @Nullable
                           String person,
                           @Nullable
                           String ordinalNumber,
                           @Nullable
                           Boolean isDefaultEmailAddress,
                           @Nullable
                           String emailAddress,
                           @Nullable
                           String searchEmailAddress,
                           @Nullable
                           String addressCommunicationRemarkText)

Method Detail

getType

@Nonnull
public Class<AddressEmailAddress> getType()

Specified by:

getType in class VdmObject<AddressEmailAddress>

Returns:

The class of this object.

setAddressID

public void setAddressID(@Nullable
                         String addressID)

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

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.

Parameters:

addressID - Internal key for identifying a Business Address Services address.

setPerson

public void setPerson(@Nullable
                      String person)

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

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.

Parameters:

person - Internal key for identifying a person in Business Address Services.

setOrdinalNumber

public void setOrdinalNumber(@Nullable
                             String ordinalNumber)

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

Original property name from the Odata EDM: OrdinalNumber

Parameters:

ordinalNumber - Sequence Number

setIsDefaultEmailAddress

public void setIsDefaultEmailAddress(@Nullable
                                     Boolean isDefaultEmailAddress)

Constraints: none

Original property name from the Odata EDM: IsDefaultEmailAddress

Parameters:

isDefaultEmailAddress - Flag: this address is the default address

setEmailAddress

public void setEmailAddress(@Nullable
                            String emailAddress)

Constraints: Not nullable, Maximum length: 241

Original property name from the Odata EDM: EmailAddress

Example: user.name@company.comThe Internet mail address is used to send mail via the Internet world-wide; the protocol used is SMTP (Simple Mail Transfer Protocol).The Internet mail address format is specified in various RFCs (Internet Request for Comment), including RFCs 821 and 822.This is not an IP address (192.56.30.6).

Parameters:

emailAddress - Internet mail address, also called e-mail address.

setSearchEmailAddress

public void setSearchEmailAddress(@Nullable
                                  String searchEmailAddress)

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: SearchEmailAddress

It contains the first 20 characters of the Internet mail address in normalized form, that is, without comment characters and converted into uppercase.The field cannot be maintained by the user or from an interface.The table ADR6 contains an index for this field.Using an Internet mail address, the corresponding key of table ADR6 and the owner of the address are determined (for example, business partner or user).

Parameters:

searchEmailAddress - This field is generated by the system from the complete Internet mail address and is stored in table ADR6.

setAddressCommunicationRemarkText

public void setAddressCommunicationRemarkText(@Nullable
                                              String addressCommunicationRemarkText)

Constraints: Not nullable, Maximum length: 50

Original property name from the Odata EDM: AddressCommunicationRemarkText

You can maintain further information about the communication connection here. In the case of telephone numbers, for example, you can maintain the times at which the call recipient is available and those at which they are not, or you can specify whether the number is that of the secretary.The information is stored in table ADRT, regardless of language.

Parameters:

addressCommunicationRemarkText - Additional information about the communication connection

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<AddressEmailAddress>

Returns:

EDMX name of the entity collection identifier.

getKey

@Nonnull
protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<AddressEmailAddress>

Returns:

The compound key of this object.

toMapOfFields

@Nonnull
protected Map<String,Object> toMapOfFields()

Overrides:

toMapOfFields in class VdmObject<AddressEmailAddress>

fromMap

protected void fromMap(Map<String,Object> inputValues)

Overrides:

fromMap in class VdmObject<AddressEmailAddress>

field

@Nonnull
public static <T> AddressEmailAddressField<T> field(@Nonnull
                                                             String fieldName,
                                                             @Nonnull
                                                             Class<T> fieldType)

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

Type Parameters:

T - The type of the extension field when performing value comparisons.

Parameters:

fieldName - The name of the extension field as returned by the OData service.

fieldType - The Java type to use for the extension field when performing value comparisons.

Returns:

A representation of an extension field from this entity.

field

@Nonnull
public static <T,DomainT> AddressEmailAddressField<T> field(@Nonnull
                                                                     String fieldName,
                                                                     @Nonnull
                                                                     TypeConverter<T,DomainT> typeConverter)

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

Type Parameters:

T - The type of the extension field when performing value comparisons.

DomainT - The type of the extension field as returned by the OData service.

Parameters:

typeConverter - A TypeConverter instance whose first generic type matches the Java type of the field

fieldName - The name of the extension field as returned by the OData service.

Returns:

A representation of an extension field from this entity, holding a reference to the given TypeConverter.

getDestinationForFetch

@Nullable
public HttpDestinationProperties getDestinationForFetch()

Description copied from class: VdmEntity

Convienence field for reusing the same destination with multiple queries (e.g. fetching associated entities). New destination to apply to this entity

Overrides:

getDestinationForFetch in class VdmEntity<AddressEmailAddress>

Returns:

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

setServicePathForFetch

protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)

Description copied from class: VdmEntity

The service path only used for the fetch commands of this entity.

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.

Overrides:

setServicePathForFetch in class VdmEntity<AddressEmailAddress>

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)

Description copied from class: VdmEntity

Sets the service path and destination for the fetch commands of this entity. Also applies to any associated entities (navigation properties) that were previously fetched.

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.

Overrides:

attachToService in class VdmEntity<AddressEmailAddress>

Parameters:

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.

getDefaultServicePath

protected String getDefaultServicePath()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<AddressEmailAddress>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

builder

@Nonnull
public static AddressEmailAddress.AddressEmailAddressBuilder builder()

getAddressID

@Nullable
public String getAddressID()

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

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.

Returns:

Internal key for identifying a Business Address Services address.

getPerson

@Nullable
public String getPerson()

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

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.

Returns:

Internal key for identifying a person in Business Address Services.

getOrdinalNumber

@Nullable
public String getOrdinalNumber()

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

Original property name from the Odata EDM: OrdinalNumber

Returns:

Sequence Number

getIsDefaultEmailAddress

@Nullable
public Boolean getIsDefaultEmailAddress()

Constraints: none

Original property name from the Odata EDM: IsDefaultEmailAddress

Returns:

Flag: this address is the default address

getEmailAddress

@Nullable
public String getEmailAddress()

Constraints: Not nullable, Maximum length: 241

Original property name from the Odata EDM: EmailAddress

Example: user.name@company.comThe Internet mail address is used to send mail via the Internet world-wide; the protocol used is SMTP (Simple Mail Transfer Protocol).The Internet mail address format is specified in various RFCs (Internet Request for Comment), including RFCs 821 and 822.This is not an IP address (192.56.30.6).

Returns:

Internet mail address, also called e-mail address.

getSearchEmailAddress

@Nullable
public String getSearchEmailAddress()

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: SearchEmailAddress

It contains the first 20 characters of the Internet mail address in normalized form, that is, without comment characters and converted into uppercase.The field cannot be maintained by the user or from an interface.The table ADR6 contains an index for this field.Using an Internet mail address, the corresponding key of table ADR6 and the owner of the address are determined (for example, business partner or user).

Returns:

This field is generated by the system from the complete Internet mail address and is stored in table ADR6.

getAddressCommunicationRemarkText

@Nullable
public String getAddressCommunicationRemarkText()

Constraints: Not nullable, Maximum length: 50

Original property name from the Odata EDM: AddressCommunicationRemarkText

You can maintain further information about the communication connection here. In the case of telephone numbers, for example, you can maintain the times at which the call recipient is available and those at which they are not, or you can specify whether the number is that of the secretary.The information is stored in table ADRT, regardless of language.

Returns:

Additional information about the communication connection

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<AddressEmailAddress>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<AddressEmailAddress>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<AddressEmailAddress>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<AddressEmailAddress>