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

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<Calendar>	VALIDITY_END_DATE Use with available fluent helpers to apply the ValidityEndDate field to query operations.
static BuPaAddressUsageField<Calendar>	VALIDITY_START_DATE Use with available fluent helpers to apply the ValidityStartDate field to query operations.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static BuPaAddressUsage.BuPaAddressUsageBuilder	builder()
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.
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.
String	getAddressUsage() (Key Field) Constraints: Not nullable, Maximum length: 10 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
String	getAuthorizationGroup() Constraints: Not nullable, Maximum length: 4 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.
String	getBusinessPartner() (Key Field) Constraints: Not nullable, Maximum length: 10
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
Boolean	getStandardUsage() Constraints: noneSeveral 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.
Class<BuPaAddressUsage>	getType()
Calendar	getValidityEndDate() (Key Field) Constraints: Not nullable, Precision: 0
Calendar	getValidityStartDate() Constraints: Not nullable, Precision: 0
int	hashCode()
void	setAddressID(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.
void	setAddressUsage(String addressUsage) (Key Field) Constraints: Not nullable, Maximum length: 10 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
void	setAuthorizationGroup(String authorizationGroup) Constraints: Not nullable, Maximum length: 4 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.
void	setBusinessPartner(String businessPartner) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
void	setStandardUsage(Boolean standardUsage) Constraints: noneSeveral 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.
void	setValidityEndDate(Calendar validityEndDate) (Key Field) Constraints: Not nullable, Precision: 0
void	setValidityStartDate(Calendar validityStartDate) Constraints: Not nullable, Precision: 0
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 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<Calendar> 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<Calendar> 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
                        Calendar validityEndDate,
                        @Nullable
                        String addressUsage,
                        @Nullable
                        String addressID,
                        @Nullable
                        Calendar validityStartDate,
                        @Nullable
                        Boolean standardUsage,
                        @Nullable
                        String authorizationGroup,
                        @Nullable
                        ErpConfigContext erpConfigContext)

Method Detail

getType

public Class<BuPaAddressUsage> getType()

Specified by:

getType in class VdmObject<BuPaAddressUsage>

Returns:

The class of this object.

field

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

public static BuPaAddressUsage.BuPaAddressUsageBuilder builder()

getBusinessPartner

@Nullable
public String getBusinessPartner()

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

Returns:

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

getValidityEndDate

@Nullable
public Calendar getValidityEndDate()

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

Returns:

Validity End of a Business Partner Address Usage

getAddressUsage

@Nullable
public String getAddressUsage()

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

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

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 Calendar getValidityStartDate()

Constraints: Not nullable, Precision: 0

Returns:

Validity Start of a Business Partner Address Usage

getStandardUsage

@Nullable
public Boolean getStandardUsage()

Constraints: none

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

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.

getErpConfigContext

@Nullable
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.

setBusinessPartner

public void setBusinessPartner(@Nullable
                               String businessPartner)

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

Parameters:

businessPartner -

setValidityEndDate

public void setValidityEndDate(@Nullable
                               Calendar validityEndDate)

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

Parameters:

validityEndDate -

setAddressUsage

public void setAddressUsage(@Nullable
                            String addressUsage)

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

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 -

setAddressID

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 -

setValidityStartDate

public void setValidityStartDate(@Nullable
                                 Calendar validityStartDate)

Constraints: Not nullable, Precision: 0

Parameters:

validityStartDate -

setStandardUsage

public void setStandardUsage(@Nullable
                             Boolean standardUsage)

Constraints: none

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 -

setAuthorizationGroup

public void setAuthorizationGroup(@Nullable
                                  String authorizationGroup)

Constraints: Not nullable, Maximum length: 4

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 -

setErpConfigContext

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

public String toString()

Overrides:

toString in class VdmObject<BuPaAddressUsage>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<BuPaAddressUsage>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BuPaAddressUsage>