Options
All
  • Public
  • Public/Protected
  • All
Menu

Business Partner Role

Hierarchy

  • Entity
    • BusinessPartnerRole

Implements

Index

Properties

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

authorizationGroup

authorizationGroup: string

Authorization Group. You can use authorization groups to stipulate which business partners a user is allowed to process. 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. Maximum length: 4.

nullable

businessPartner

businessPartner: string

Business Partner Number. Key identifying a business partner in the SAP system. The key is unique within a client. Maximum length: 10.

businessPartnerRole

businessPartnerRole: string

BP Role. Function that a business partner takes on, depending on a business transaction. 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. Maximum length: 6.

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

validFrom

validFrom: Moment

Validity Start of a BP Role.

nullable

validTo

validTo: Moment

Validity End of a BP Role.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Static AUTHORIZATION_GROUP

AUTHORIZATION_GROUP: StringField<BusinessPartnerRole> = new StringField('AuthorizationGroup', BusinessPartnerRole, 'Edm.String')

Static representation of the authorizationGroup property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static BUSINESS_PARTNER

BUSINESS_PARTNER: StringField<BusinessPartnerRole> = new StringField('BusinessPartner', BusinessPartnerRole, 'Edm.String')

Static representation of the businessPartner property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static BUSINESS_PARTNER_ROLE

BUSINESS_PARTNER_ROLE: StringField<BusinessPartnerRole> = new StringField('BusinessPartnerRole', BusinessPartnerRole, 'Edm.String')

Static representation of the businessPartnerRole property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static VALID_FROM

VALID_FROM: DateField<BusinessPartnerRole> = new DateField('ValidFrom', BusinessPartnerRole, 'Edm.DateTimeOffset')

Static representation of the validFrom property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static VALID_TO

VALID_TO: DateField<BusinessPartnerRole> = new DateField('ValidTo', BusinessPartnerRole, 'Edm.DateTimeOffset')

Static representation of the validTo property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: (StringField<BusinessPartnerRole> | DateField<BusinessPartnerRole>)[] = [BusinessPartnerRole.BUSINESS_PARTNER,BusinessPartnerRole.BUSINESS_PARTNER_ROLE,BusinessPartnerRole.VALID_FROM,BusinessPartnerRole.VALID_TO,BusinessPartnerRole.AUTHORIZATION_GROUP]

All fields of the BusinessPartnerRole entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_BUSINESS_PARTNER"

Default url path for the according service.

Static _entityName

_entityName: string = "A_BusinessPartnerRole"

Technical entity name for BusinessPartnerRole.

Static _keyFields

_keyFields: Array<Selectable<BusinessPartnerRole>> = [BusinessPartnerRole.BUSINESS_PARTNER, BusinessPartnerRole.BUSINESS_PARTNER_ROLE]

All key fields of the BusinessPartnerRole entity.

Static _keys

_keys: any = BusinessPartnerRole._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property BusinessPartnerRole.

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"

Technical service name for BusinessPartnerRole.

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): this
  • Returns this

getUpdatedProperties

  • getUpdatedProperties(): this
  • Returns all changed properties compared to the last known remote state.

    Returns this

    Entity with all properties that changed

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

Static builder

Static Protected entityBuilder

  • entityBuilder<EntityT, JsonT>(entityConstructor: Constructable<EntityT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the BusinessPartnerRole entity type.

    Returns BusinessPartnerRoleRequestBuilder

    A BusinessPartnerRole request builder.