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

Class BusinessPartnerRole

java.lang.Object

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

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

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

public class BusinessPartnerRole
extends VdmEntity<BusinessPartnerRole>

Business Partner Role

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BusinessPartnerRole.BusinessPartnerRoleBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static BusinessPartnerRoleSelectable	ALL_FIELDS Selector for all available fields of BusinessPartnerRole.
static BusinessPartnerRoleField<String>	AUTHORIZATION_GROUP Use with available fluent helpers to apply the AuthorizationGroup field to query operations.
static BusinessPartnerRoleField<String>	BUSINESS_PARTNER Use with available fluent helpers to apply the BusinessPartner field to query operations.
static BusinessPartnerRoleField<String>	BUSINESS_PARTNER_ROLE Use with available fluent helpers to apply the BusinessPartnerRole field to query operations.
static BusinessPartnerRoleField<Calendar>	VALID_FROM Use with available fluent helpers to apply the ValidFrom field to query operations.
static BusinessPartnerRoleField<Calendar>	VALID_TO Use with available fluent helpers to apply the ValidTo field to query operations.

Constructor Summary

Constructors

Constructor and Description
BusinessPartnerRole()
BusinessPartnerRole(String businessPartner, String businessPartnerRole, Calendar validFrom, Calendar validTo, String authorizationGroup, ErpConfigContext erpConfigContext)

Method Summary

Modifier and Type	Method and Description
static BusinessPartnerRole.BusinessPartnerRoleBuilder	builder()
boolean	equals(Object o)
static <T> BusinessPartnerRoleField<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
String	getBusinessPartner() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getBusinessPartnerRole() (Key Field) Constraints: Not nullable, Maximum length: 6
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
Class<BusinessPartnerRole>	getType()
Calendar	getValidFrom() Constraints: Not nullable, Precision: 0
Calendar	getValidTo() Constraints: Not nullable, Precision: 0
int	hashCode()
void	setAuthorizationGroup(String authorizationGroup) Constraints: Not nullable, Maximum length: 4
void	setBusinessPartner(String businessPartner) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setBusinessPartnerRole(String businessPartnerRole) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setValidFrom(Calendar validFrom) Constraints: Not nullable, Precision: 0
void	setValidTo(Calendar validTo) 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 BusinessPartnerRoleSelectable ALL_FIELDS

Selector for all available fields of BusinessPartnerRole.

BUSINESS_PARTNER

public static final BusinessPartnerRoleField<String> BUSINESS_PARTNER

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

BUSINESS_PARTNER_ROLE

public static final BusinessPartnerRoleField<String> BUSINESS_PARTNER_ROLE

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

VALID_FROM

public static final BusinessPartnerRoleField<Calendar> VALID_FROM

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

VALID_TO

public static final BusinessPartnerRoleField<Calendar> VALID_TO

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

AUTHORIZATION_GROUP

public static final BusinessPartnerRoleField<String> AUTHORIZATION_GROUP

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

Constructor Detail

BusinessPartnerRole

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

BusinessPartnerRole

@ConstructorProperties(value={"businessPartner","businessPartnerRole","validFrom","validTo","authorizationGroup","erpConfigContext"})
 @Generated(value="lombok")
public BusinessPartnerRole(@Nullable
                                                                                                                                                                                             String businessPartner,
                                                                                                                                                                                             @Nullable
                                                                                                                                                                                             String businessPartnerRole,
                                                                                                                                                                                             @Nullable
                                                                                                                                                                                             Calendar validFrom,
                                                                                                                                                                                             @Nullable
                                                                                                                                                                                             Calendar validTo,
                                                                                                                                                                                             @Nullable
                                                                                                                                                                                             String authorizationGroup,
                                                                                                                                                                                             @Nullable
                                                                                                                                                                                             ErpConfigContext erpConfigContext)

Method Detail

getType

public Class<BusinessPartnerRole> getType()

Specified by:

getType in class VdmObject<BusinessPartnerRole>

Returns:

The class of this object.

field

public static <T> BusinessPartnerRoleField<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 BusinessPartnerRole.BusinessPartnerRoleBuilder 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.

getBusinessPartnerRole

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

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

You can define business partner roles along with their attributes in Customizing. You can create an alphanumeric, 6-digit key for the BP role. You can also choose a title as the short form and a description as the long form for the role text. Screen control in the dialog takes place by assigning a BP view. A program can access specific business partner roles for a business partner using thebusiness partner role category . The role categories are also in the TB003 table.

Returns:

Function that a business partner takes on, depending on a business transaction.

getValidFrom

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

Constraints: Not nullable, Precision: 0

Returns:

Validity Start of a BP Role

getValidTo

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

Constraints: Not nullable, Precision: 0

Returns:

Validity End of a BP Role

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 -

setBusinessPartnerRole

@Generated(value="lombok")
public void setBusinessPartnerRole(@Nullable
                                                              String businessPartnerRole)

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

You can define business partner roles along with their attributes in Customizing. You can create an alphanumeric, 6-digit key for the BP role. You can also choose a title as the short form and a description as the long form for the role text. Screen control in the dialog takes place by assigning a BP view. A program can access specific business partner roles for a business partner using thebusiness partner role category . The role categories are also in the TB003 table.

Parameters:

businessPartnerRole -

setValidFrom

@Generated(value="lombok")
public void setValidFrom(@Nullable
                                                    Calendar validFrom)

Constraints: Not nullable, Precision: 0

Parameters:

validFrom -

setValidTo

@Generated(value="lombok")
public void setValidTo(@Nullable
                                                  Calendar validTo)

Constraints: Not nullable, Precision: 0

Parameters:

validTo -

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

equals

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

Overrides:

equals in class VdmObject<BusinessPartnerRole>

hashCode

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

Overrides:

hashCode in class VdmObject<BusinessPartnerRole>