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

Class BuPaIdentification

java.lang.Object

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

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

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

public class BuPaIdentification
extends VdmEntity<BuPaIdentification>

Business Partner Identification

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuPaIdentification.BuPaIdentificationBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static BuPaIdentificationSelectable	ALL_FIELDS Selector for all available fields of BuPaIdentification.
static BuPaIdentificationField<String>	AUTHORIZATION_GROUP Use with available fluent helpers to apply the AuthorizationGroup field to query operations.
static BuPaIdentificationField<Calendar>	BP_IDENTIFICATION_ENTRY_DATE Use with available fluent helpers to apply the BPIdentificationEntryDate field to query operations.
static BuPaIdentificationField<String>	BP_IDENTIFICATION_NUMBER Use with available fluent helpers to apply the BPIdentificationNumber field to query operations.
static BuPaIdentificationField<String>	BP_IDENTIFICATION_TYPE Use with available fluent helpers to apply the BPIdentificationType field to query operations.
static BuPaIdentificationField<String>	BP_IDN_NMBR_ISSUING_INSTITUTE Use with available fluent helpers to apply the BPIdnNmbrIssuingInstitute field to query operations.
static BuPaIdentificationField<String>	BUSINESS_PARTNER Use with available fluent helpers to apply the BusinessPartner field to query operations.
static BuPaIdentificationField<String>	COUNTRY Use with available fluent helpers to apply the Country field to query operations.
static BuPaIdentificationField<String>	REGION Use with available fluent helpers to apply the Region field to query operations.
static BuPaIdentificationField<Calendar>	VALIDITY_END_DATE Use with available fluent helpers to apply the ValidityEndDate field to query operations.
static BuPaIdentificationField<Calendar>	VALIDITY_START_DATE Use with available fluent helpers to apply the ValidityStartDate field to query operations.

Constructor Summary

Constructors

Constructor and Description
BuPaIdentification()
BuPaIdentification(String businessPartner, String bPIdentificationType, String bPIdentificationNumber, String bPIdnNmbrIssuingInstitute, Calendar bPIdentificationEntryDate, String country, String region, Calendar validityStartDate, Calendar validityEndDate, String authorizationGroup, ErpConfigContext erpConfigContext)

Method Summary

Modifier and Type	Method and Description
static BuPaIdentification.BuPaIdentificationBuilder	builder()
boolean	equals(Object o)
static <T> BuPaIdentificationField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getAuthorizationGroup() Constraints: Not nullable, Maximum length: 4
Calendar	getBPIdentificationEntryDate() Constraints: Not nullable, Precision: 0
String	getBPIdentificationNumber() (Key Field) Constraints: Not nullable, Maximum length: 60
String	getBPIdentificationType() (Key Field) Constraints: Not nullable, Maximum length: 6
String	getBPIdnNmbrIssuingInstitute() Constraints: Not nullable, Maximum length: 40
String	getBusinessPartner() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getCountry() Constraints: Not nullable, Maximum length: 3
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
String	getRegion() Constraints: Not nullable, Maximum length: 3
Class<BuPaIdentification>	getType()
Calendar	getValidityEndDate() Constraints: Not nullable, Precision: 0
Calendar	getValidityStartDate() Constraints: Not nullable, Precision: 0
int	hashCode()
void	setAuthorizationGroup(String authorizationGroup) Constraints: Not nullable, Maximum length: 4
void	setBPIdentificationEntryDate(Calendar bPIdentificationEntryDate) Constraints: Not nullable, Precision: 0
void	setBPIdentificationNumber(String bPIdentificationNumber) (Key Field) Constraints: Not nullable, Maximum length: 60
void	setBPIdentificationType(String bPIdentificationType) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setBPIdnNmbrIssuingInstitute(String bPIdnNmbrIssuingInstitute) Constraints: Not nullable, Maximum length: 40
void	setBusinessPartner(String businessPartner) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setCountry(String country) Constraints: Not nullable, Maximum length: 3
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setRegion(String region) Constraints: Not nullable, Maximum length: 3
void	setValidityEndDate(Calendar validityEndDate) 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 BuPaIdentificationSelectable ALL_FIELDS

Selector for all available fields of BuPaIdentification.

BUSINESS_PARTNER

public static final BuPaIdentificationField<String> BUSINESS_PARTNER

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

BP_IDENTIFICATION_TYPE

public static final BuPaIdentificationField<String> BP_IDENTIFICATION_TYPE

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

BP_IDENTIFICATION_NUMBER

public static final BuPaIdentificationField<String> BP_IDENTIFICATION_NUMBER

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

BP_IDN_NMBR_ISSUING_INSTITUTE

public static final BuPaIdentificationField<String> BP_IDN_NMBR_ISSUING_INSTITUTE

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

BP_IDENTIFICATION_ENTRY_DATE

public static final BuPaIdentificationField<Calendar> BP_IDENTIFICATION_ENTRY_DATE

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

COUNTRY

public static final BuPaIdentificationField<String> COUNTRY

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

REGION

public static final BuPaIdentificationField<String> REGION

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

VALIDITY_START_DATE

public static final BuPaIdentificationField<Calendar> VALIDITY_START_DATE

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

VALIDITY_END_DATE

public static final BuPaIdentificationField<Calendar> VALIDITY_END_DATE

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

AUTHORIZATION_GROUP

public static final BuPaIdentificationField<String> AUTHORIZATION_GROUP

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

Constructor Detail

BuPaIdentification

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

BuPaIdentification

@ConstructorProperties(value={"businessPartner","bPIdentificationType","bPIdentificationNumber","bPIdnNmbrIssuingInstitute","bPIdentificationEntryDate","country","region","validityStartDate","validityEndDate","authorizationGroup","erpConfigContext"})
 @Generated(value="lombok")
public BuPaIdentification(@Nullable
                                                                                                                                                                                                                                                                                                                 String businessPartner,
                                                                                                                                                                                                                                                                                                                 @Nullable
                                                                                                                                                                                                                                                                                                                 String bPIdentificationType,
                                                                                                                                                                                                                                                                                                                 @Nullable
                                                                                                                                                                                                                                                                                                                 String bPIdentificationNumber,
                                                                                                                                                                                                                                                                                                                 @Nullable
                                                                                                                                                                                                                                                                                                                 String bPIdnNmbrIssuingInstitute,
                                                                                                                                                                                                                                                                                                                 @Nullable
                                                                                                                                                                                                                                                                                                                 Calendar bPIdentificationEntryDate,
                                                                                                                                                                                                                                                                                                                 @Nullable
                                                                                                                                                                                                                                                                                                                 String country,
                                                                                                                                                                                                                                                                                                                 @Nullable
                                                                                                                                                                                                                                                                                                                 String region,
                                                                                                                                                                                                                                                                                                                 @Nullable
                                                                                                                                                                                                                                                                                                                 Calendar validityStartDate,
                                                                                                                                                                                                                                                                                                                 @Nullable
                                                                                                                                                                                                                                                                                                                 Calendar validityEndDate,
                                                                                                                                                                                                                                                                                                                 @Nullable
                                                                                                                                                                                                                                                                                                                 String authorizationGroup,
                                                                                                                                                                                                                                                                                                                 @Nullable
                                                                                                                                                                                                                                                                                                                 ErpConfigContext erpConfigContext)

Method Detail

getType

public Class<BuPaIdentification> getType()

Specified by:

getType in class VdmObject<BuPaIdentification>

Returns:

The class of this object.

field

public static <T> BuPaIdentificationField<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 BuPaIdentification.BuPaIdentificationBuilder builder()

getBusinessPartner

@Nullable
 @Generated(value="lombok")
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.

getBPIdentificationType

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

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

The identification type is for classifying identification numbers. You can define the identification types and their descriptions in Customizing. You can also specify for which business partner category an ID type should be valid. If necessary, assign the identification type to an Identification Category. You can only assign one identification type to an identification category.

Returns:

A document (such as an ID card or driver's license) or an entry in a system of records (such as a commercial register) whose key can be stored as an attribute for a business partner.

getBPIdentificationNumber

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

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

Returns:

Number that serves to identify a business partner, such as driver's license, or ID card number.

getBPIdnNmbrIssuingInstitute

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

Constraints: Not nullable, Maximum length: 40

Returns:

Institution that adminsters or assigns an ID number.

getBPIdentificationEntryDate

@Nullable
 @Generated(value="lombok")
public Calendar getBPIdentificationEntryDate()

Constraints: Not nullable, Precision: 0

Returns:

Date on which the ID number was registered or assigned by the appropriate authority.

getCountry

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

Constraints: Not nullable, Maximum length: 3

Returns:

Country in which an ID number was assigned, or in which the number is valid.

getRegion

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

Constraints: Not nullable, Maximum length: 3

The automatic address formatting function prints the region in addresses in the USA, Canada, Italy, Brazil or Australia, and the county in Great Britain. For more information, see the examples in the documentation on the Address Layout Key. Meaning of the regional code in ... Australia -> Province Brazil -> State Canada -> Province Germany -> State Great Britain -> County Italy -> Province Japan -> Prefecture Switzerland -> Canton USA -> State

Returns:

In some countries, the region forms part of the address. The meaning depends on the country.

getValidityStartDate

@Nullable
 @Generated(value="lombok")
public Calendar getValidityStartDate()

Constraints: Not nullable, Precision: 0

Returns:

This date marks the start of validity of an ID number.

getValidityEndDate

@Nullable
 @Generated(value="lombok")
public Calendar getValidityEndDate()

Constraints: Not nullable, Precision: 0

Returns:

This date marks the end of validity of an ID number.

getAuthorizationGroup

@Nullable
 @Generated(value="lombok")
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
 @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.

setBusinessPartner

@Generated(value="lombok")
public void setBusinessPartner(@Nullable
                                                          String businessPartner)

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

Parameters:

businessPartner -

setBPIdentificationType

@Generated(value="lombok")
public void setBPIdentificationType(@Nullable
                                                               String bPIdentificationType)

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

The identification type is for classifying identification numbers. You can define the identification types and their descriptions in Customizing. You can also specify for which business partner category an ID type should be valid. If necessary, assign the identification type to an Identification Category. You can only assign one identification type to an identification category.

Parameters:

bPIdentificationType -

setBPIdentificationNumber

@Generated(value="lombok")
public void setBPIdentificationNumber(@Nullable
                                                                 String bPIdentificationNumber)

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

Parameters:

bPIdentificationNumber -

setBPIdnNmbrIssuingInstitute

@Generated(value="lombok")
public void setBPIdnNmbrIssuingInstitute(@Nullable
                                                                    String bPIdnNmbrIssuingInstitute)

Constraints: Not nullable, Maximum length: 40

Parameters:

bPIdnNmbrIssuingInstitute -

setBPIdentificationEntryDate

@Generated(value="lombok")
public void setBPIdentificationEntryDate(@Nullable
                                                                    Calendar bPIdentificationEntryDate)

Constraints: Not nullable, Precision: 0

Parameters:

bPIdentificationEntryDate -

setCountry

@Generated(value="lombok")
public void setCountry(@Nullable
                                                  String country)

Constraints: Not nullable, Maximum length: 3

Parameters:

country -

setRegion

@Generated(value="lombok")
public void setRegion(@Nullable
                                                 String region)

Constraints: Not nullable, Maximum length: 3

The automatic address formatting function prints the region in addresses in the USA, Canada, Italy, Brazil or Australia, and the county in Great Britain. For more information, see the examples in the documentation on the Address Layout Key. Meaning of the regional code in ... Australia -> Province Brazil -> State Canada -> Province Germany -> State Great Britain -> County Italy -> Province Japan -> Prefecture Switzerland -> Canton USA -> State

Parameters:

region -

setValidityStartDate

@Generated(value="lombok")
public void setValidityStartDate(@Nullable
                                                            Calendar validityStartDate)

Constraints: Not nullable, Precision: 0

Parameters:

validityStartDate -

setValidityEndDate

@Generated(value="lombok")
public void setValidityEndDate(@Nullable
                                                          Calendar validityEndDate)

Constraints: Not nullable, Precision: 0

Parameters:

validityEndDate -

setAuthorizationGroup

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

@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<BuPaIdentification>

equals

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

Overrides:

equals in class VdmObject<BuPaIdentification>

hashCode

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

Overrides:

hashCode in class VdmObject<BuPaIdentification>