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

Class BuPaAddressUsage

java.lang.Object

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

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

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

public class BuPaAddressUsage
extends VdmEntity<BuPaAddressUsage>

Business Partner Address Usage

Original entity name from the Odata EDM: A_BuPaAddressUsageType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuPaAddressUsage.BuPaAddressUsageBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static BuPaAddressUsageField<String>	ADDRESS_ID Use with available fluent helpers to apply the AddressID field to query operations.
static BuPaAddressUsageField<String>	ADDRESS_USAGE Use with available fluent helpers to apply the AddressUsage field to query operations.
static BuPaAddressUsageSelectable	ALL_FIELDS Selector for all available fields of BuPaAddressUsage.
static BuPaAddressUsageField<String>	AUTHORIZATION_GROUP Use with available fluent helpers to apply the AuthorizationGroup field to query operations.
static BuPaAddressUsageField<String>	BUSINESS_PARTNER Use with available fluent helpers to apply the BusinessPartner field to query operations.
static BuPaAddressUsageField<Boolean>	STANDARD_USAGE Use with available fluent helpers to apply the StandardUsage field to query operations.
static BuPaAddressUsageField<ZonedDateTime>	VALIDITY_END_DATE Use with available fluent helpers to apply the ValidityEndDate field to query operations.
static BuPaAddressUsageField<ZonedDateTime>	VALIDITY_START_DATE Use with available fluent helpers to apply the ValidityStartDate field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
BuPaAddressUsage()
BuPaAddressUsage(String businessPartner, ZonedDateTime validityEndDate, String addressUsage, String addressID, ZonedDateTime validityStartDate, Boolean standardUsage, String authorizationGroup)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static BuPaAddressUsage.BuPaAddressUsageBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static <T> BuPaAddressUsageField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> BuPaAddressUsageField<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	getAddressID() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getAddressUsage() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getAuthorizationGroup() Constraints: Not nullable, Maximum length: 4
String	getBusinessPartner() (Key Field) Constraints: Not nullable, Maximum length: 10
protected String	getDefaultServicePath()
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
protected Map<String,Object>	getKey()
Boolean	getStandardUsage() Constraints: none
Class<BuPaAddressUsage>	getType()
ZonedDateTime	getValidityEndDate() (Key Field) Constraints: Not nullable, Precision: 0
ZonedDateTime	getValidityStartDate() Constraints: Not nullable, Precision: 0
int	hashCode()
void	setAddressID(String addressID) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setAddressUsage(String addressUsage) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setAuthorizationGroup(String authorizationGroup) Constraints: Not nullable, Maximum length: 4
void	setBusinessPartner(String businessPartner) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setStandardUsage(Boolean standardUsage) Constraints: none
void	setValidityEndDate(ZonedDateTime validityEndDate) (Key Field) Constraints: Not nullable, Precision: 0
void	setValidityStartDate(ZonedDateTime validityStartDate) Constraints: Not nullable, Precision: 0
protected Map<String,Object>	toMapOfFields()
String	toString()

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

getEndpointUrl, getServicePathForFetch, getVersionIdentifier, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.s4hana.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 BuPaAddressUsageSelectable ALL_FIELDS

Selector for all available fields of BuPaAddressUsage.

BUSINESS_PARTNER

public static final BuPaAddressUsageField<String> BUSINESS_PARTNER

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

VALIDITY_END_DATE

public static final BuPaAddressUsageField<ZonedDateTime> VALIDITY_END_DATE

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

ADDRESS_USAGE

public static final BuPaAddressUsageField<String> ADDRESS_USAGE

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

ADDRESS_ID

public static final BuPaAddressUsageField<String> ADDRESS_ID

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

VALIDITY_START_DATE

public static final BuPaAddressUsageField<ZonedDateTime> VALIDITY_START_DATE

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

STANDARD_USAGE

public static final BuPaAddressUsageField<Boolean> STANDARD_USAGE

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

AUTHORIZATION_GROUP

public static final BuPaAddressUsageField<String> AUTHORIZATION_GROUP

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

Constructor Detail

BuPaAddressUsage

public BuPaAddressUsage()

BuPaAddressUsage

public BuPaAddressUsage(@Nullable
                        String businessPartner,
                        @Nullable
                        ZonedDateTime validityEndDate,
                        @Nullable
                        String addressUsage,
                        @Nullable
                        String addressID,
                        @Nullable
                        ZonedDateTime validityStartDate,
                        @Nullable
                        Boolean standardUsage,
                        @Nullable
                        String authorizationGroup)

Method Detail

getType

@Nonnull
public Class<BuPaAddressUsage> getType()

Specified by:

getType in class VdmObject<BuPaAddressUsage>

Returns:

The class of this object.

setBusinessPartner

public void setBusinessPartner(@Nullable
                               String businessPartner)

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

Original property name from the Odata EDM: BusinessPartner

Parameters:

businessPartner - Key identifying a business partner in the SAP system. The key is unique within a client.

setValidityEndDate

public void setValidityEndDate(@Nullable
                               ZonedDateTime validityEndDate)

(Key Field) Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: ValidityEndDate

Parameters:

validityEndDate - Validity End of a Business Partner Address Usage

setAddressUsage

public void setAddressUsage(@Nullable
                            String addressUsage)

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

Original property name from the Odata EDM: AddressUsage

Maintain the usage types for addresses (address types) in Customizing.You can create a short description and a name for the address type.When maintaining business partners you can use the function address usage to assign business partner addresses to address types.If necessary, you can set the indicator for multiple use in Customizing.Correspondence addressDelivery address

Parameters:

addressUsage - Business partner attribute, which you can use to distinguish between various addresses by defining the address usage for communication with business partners.

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.

setValidityStartDate

public void setValidityStartDate(@Nullable
                                 ZonedDateTime validityStartDate)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: ValidityStartDate

Parameters:

validityStartDate - Validity Start of a Business Partner Address Usage

setStandardUsage

public void setStandardUsage(@Nullable
                             Boolean standardUsage)

Constraints: none

Original property name from the Odata EDM: StandardUsage

Several addresses per period can be assigned to an address usage.If this is the case, then this indicator controls which of the assigned addresses should be the standard address of the relevant usage. This is determined automatically when the address usage is accessed.

Parameters:

standardUsage - Establishes which is the standard address for an address usage.

setAuthorizationGroup

public void setAuthorizationGroup(@Nullable
                                  String authorizationGroup)

Constraints: Not nullable, Maximum length: 4

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.

Parameters:

authorizationGroup - You can use authorization groups to stipulate which business partners a user is allowed to process.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<BuPaAddressUsage>

getKey

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

Overrides:

getKey in class VdmObject<BuPaAddressUsage>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<BuPaAddressUsage>

fromMap

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

Overrides:

fromMap in class VdmObject<BuPaAddressUsage>

field

@Nonnull
public static <T> BuPaAddressUsageField<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> BuPaAddressUsageField<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.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Description copied from class: VdmEntity

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

Overrides:

getErpConfigContext in class VdmEntity<BuPaAddressUsage>

Returns:

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

setErpConfigContext

@Deprecated
public void setErpConfigContext(@Nullable
                                            ErpConfigContext erpConfigContext)

Deprecated. Use attachToService(String, ErpConfigContext) instead.

Description copied from class: VdmEntity

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

Overrides:

setErpConfigContext in class VdmEntity<BuPaAddressUsage>

Parameters:

erpConfigContext - New ERP configuration context to apply to this entity

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<BuPaAddressUsage>

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nullable
                            ErpConfigContext configContext)

Description copied from class: VdmEntity

Sets the service path and ERP configuration context for the fetch commands of this entity. Ensures that both are set to some value by using defaults if null values are provided in the arguments. Existing values are preserved if null values are provided in the arguments. 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<BuPaAddressUsage>

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.

configContext - Optional parameter. New ERP configuration context to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the ERP configuration context has never been set, then the ERP configuration context will be set to a new instance of ErpConfigContext.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<BuPaAddressUsage>

builder

public static BuPaAddressUsage.BuPaAddressUsageBuilder builder()

getBusinessPartner

@Nullable
public String getBusinessPartner()

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

Original property name from the Odata EDM: BusinessPartner

Returns:

Key identifying a business partner in the SAP system. The key is unique within a client.

getValidityEndDate

@Nullable
public ZonedDateTime getValidityEndDate()

(Key Field) Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: ValidityEndDate

Returns:

Validity End of a Business Partner Address Usage

getAddressUsage

@Nullable
public String getAddressUsage()

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

Original property name from the Odata EDM: AddressUsage

Maintain the usage types for addresses (address types) in Customizing.You can create a short description and a name for the address type.When maintaining business partners you can use the function address usage to assign business partner addresses to address types.If necessary, you can set the indicator for multiple use in Customizing.Correspondence addressDelivery address

Returns:

Business partner attribute, which you can use to distinguish between various addresses by defining the address usage for communication with business partners.

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.

getValidityStartDate

@Nullable
public ZonedDateTime getValidityStartDate()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: ValidityStartDate

Returns:

Validity Start of a Business Partner Address Usage

getStandardUsage

@Nullable
public Boolean getStandardUsage()

Constraints: none

Original property name from the Odata EDM: StandardUsage

Several addresses per period can be assigned to an address usage.If this is the case, then this indicator controls which of the assigned addresses should be the standard address of the relevant usage. This is determined automatically when the address usage is accessed.

Returns:

Establishes which is the standard address for an address usage.

getAuthorizationGroup

@Nullable
public String getAuthorizationGroup()

Constraints: Not nullable, Maximum length: 4

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.

Returns:

You can use authorization groups to stipulate which business partners a user is allowed to process.

toString

public String toString()

Overrides:

toString in class VdmObject<BuPaAddressUsage>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<BuPaAddressUsage>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<BuPaAddressUsage>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BuPaAddressUsage>