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

Class AddressEmailAddress

java.lang.Object

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

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

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

public class AddressEmailAddress
extends VdmEntity<AddressEmailAddress>

Address Email Address

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_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.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static AddressEmailAddress.AddressEmailAddressBuilder	builder()
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.
String	getAddressID() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getEmailAddress() Constraints: Not nullable, Maximum length: 241
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
Boolean	getIsDefaultEmailAddress() Constraints: none
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	setAddressID(String addressID) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setEmailAddress(String emailAddress) Constraints: Not nullable, Maximum length: 241
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
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
String	toString()

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

getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final 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.

Constructor Detail

AddressEmailAddress

@Generated(value="lombok")
public AddressEmailAddress()

AddressEmailAddress

@ConstructorProperties(value={"addressID","person","ordinalNumber","isDefaultEmailAddress","emailAddress","searchEmailAddress","erpConfigContext"})
@Generated(value="lombok")
public AddressEmailAddress(@Nullable
                                                             String addressID,
                                                             @Nullable
                                                             String person,
                                                             @Nullable
                                                             String ordinalNumber,
                                                             @Nullable
                                                             Boolean isDefaultEmailAddress,
                                                             @Nullable
                                                             String emailAddress,
                                                             @Nullable
                                                             String searchEmailAddress,
                                                             @Nullable
                                                             ErpConfigContext erpConfigContext)

Method Detail

getType

public Class<AddressEmailAddress> getType()

Specified by:

getType in class VdmObject<AddressEmailAddress>

Returns:

The class of this object.

field

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

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

Parameters:

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

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

Returns:

A representation of an extension field from this entity.

builder

@Generated(value="lombok")
public static AddressEmailAddress.AddressEmailAddressBuilder builder()

getAddressID

@Nullable
@Generated(value="lombok")
public String getAddressID()

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

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
@Generated(value="lombok")
public String getPerson()

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

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
@Generated(value="lombok")
public String getOrdinalNumber()

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

Returns:

Sequence Number

getIsDefaultEmailAddress

@Nullable
@Generated(value="lombok")
public Boolean getIsDefaultEmailAddress()

Constraints: none

Returns:

Flag: this address is the default address

getEmailAddress

@Nullable
@Generated(value="lombok")
public String getEmailAddress()

Constraints: Not nullable, Maximum length: 241

Example: user.name@company.com The 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
@Generated(value="lombok")
public String getSearchEmailAddress()

Constraints: Not nullable, Maximum length: 20

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.

getErpConfigContext

@Nullable
@Generated(value="lombok")
public ErpConfigContext getErpConfigContext()

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Returns:

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

setAddressID

@Generated(value="lombok")
public void setAddressID(@Nullable
                               String addressID)

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

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 -

setPerson

@Generated(value="lombok")
public void setPerson(@Nullable
                            String person)

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

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 -

setOrdinalNumber

@Generated(value="lombok")
public void setOrdinalNumber(@Nullable
                                   String ordinalNumber)

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

Parameters:

ordinalNumber -

setIsDefaultEmailAddress

@Generated(value="lombok")
public void setIsDefaultEmailAddress(@Nullable
                                           Boolean isDefaultEmailAddress)

Constraints: none

Parameters:

isDefaultEmailAddress -

setEmailAddress

@Generated(value="lombok")
public void setEmailAddress(@Nullable
                                  String emailAddress)

Constraints: Not nullable, Maximum length: 241

Example: user.name@company.com The 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 -

setSearchEmailAddress

@Generated(value="lombok")
public void setSearchEmailAddress(@Nullable
                                        String searchEmailAddress)

Constraints: Not nullable, Maximum length: 20

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 -

setErpConfigContext

@Generated(value="lombok")
public void setErpConfigContext(@Nullable
                                      ErpConfigContext erpConfigContext)

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Parameters:

erpConfigContext -

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class VdmObject<AddressEmailAddress>

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class VdmObject<AddressEmailAddress>

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class VdmObject<AddressEmailAddress>