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

Class BusinessPartnerRole

java.lang.Object

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

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

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

public class BusinessPartnerRole
extends VdmEntity<BusinessPartnerRole>

Role

Original entity name from the Odata EDM: A_BusinessPartnerRoleType

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<ZonedDateTime>	VALID_FROM Use with available fluent helpers to apply the ValidFrom field to query operations.
static BusinessPartnerRoleField<ZonedDateTime>	VALID_TO Use with available fluent helpers to apply the ValidTo field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
BusinessPartnerRole()
BusinessPartnerRole(String businessPartner, String businessPartnerRole, ZonedDateTime validFrom, ZonedDateTime validTo, String authorizationGroup)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static BusinessPartnerRole.BusinessPartnerRoleBuilder	builder()
protected boolean	canEqual(Object other)
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.
static <T,DomainT> BusinessPartnerRoleField<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	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
protected String	getDefaultServicePath() Used by fluent helpers and navigation property methods to construct OData queries.
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
protected Map<String,Object>	getKey()
Class<BusinessPartnerRole>	getType()
ZonedDateTime	getValidFrom() Constraints: Not nullable, Precision: 0
ZonedDateTime	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
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setValidFrom(ZonedDateTime validFrom) Constraints: Not nullable, Precision: 0
void	setValidTo(ZonedDateTime validTo) Constraints: Not nullable, Precision: 0
protected Map<String,Object>	toMapOfFields()
String	toString()

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

getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.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 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<ZonedDateTime> VALID_FROM

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

VALID_TO

public static final BusinessPartnerRoleField<ZonedDateTime> 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

public BusinessPartnerRole()

BusinessPartnerRole

public BusinessPartnerRole(@Nullable
                           String businessPartner,
                           @Nullable
                           String businessPartnerRole,
                           @Nullable
                           ZonedDateTime validFrom,
                           @Nullable
                           ZonedDateTime validTo,
                           @Nullable
                           String authorizationGroup)

Method Detail

getType

@Nonnull
public Class<BusinessPartnerRole> getType()

Specified by:

getType in class VdmObject<BusinessPartnerRole>

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.

setBusinessPartnerRole

public void setBusinessPartnerRole(@Nullable
                                   String businessPartnerRole)

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

Original property name from the Odata EDM: BusinessPartnerRole

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 - Function that a business partner takes on, depending on a business transaction.

setValidFrom

public void setValidFrom(@Nullable
                         ZonedDateTime validFrom)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: ValidFrom

Parameters:

validFrom - Validity Start of a BP Role

setValidTo

public void setValidTo(@Nullable
                       ZonedDateTime validTo)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: ValidTo

Parameters:

validTo - Validity End of a BP Role

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

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<BusinessPartnerRole>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<BusinessPartnerRole>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<BusinessPartnerRole>

fromMap

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

Overrides:

fromMap in class VdmObject<BusinessPartnerRole>

field

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

getDestinationForFetch

@Nullable
public HttpDestinationProperties getDestinationForFetch()

Description copied from class: VdmEntity

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

Overrides:

getDestinationForFetch in class VdmEntity<BusinessPartnerRole>

Returns:

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

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

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)

Description copied from class: VdmEntity

Sets the service path and destination for the fetch commands of this entity. 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<BusinessPartnerRole>

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.

destination - New destination to apply to this entity and any associated entities that were previously fetched.

getDefaultServicePath

protected String getDefaultServicePath()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<BusinessPartnerRole>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

builder

@Nonnull
public static BusinessPartnerRole.BusinessPartnerRoleBuilder 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.

getBusinessPartnerRole

@Nullable
public String getBusinessPartnerRole()

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

Original property name from the Odata EDM: BusinessPartnerRole

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
public ZonedDateTime getValidFrom()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: ValidFrom

Returns:

Validity Start of a BP Role

getValidTo

@Nullable
public ZonedDateTime getValidTo()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: ValidTo

Returns:

Validity End of a BP Role

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

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<BusinessPartnerRole>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<BusinessPartnerRole>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<BusinessPartnerRole>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BusinessPartnerRole>