Class BusinessObjectType

A BusinessObjectType represents a type of business object.

BusinessObjectTypes are mutable

specfield: participant (boolean): determines whether or not the business object type represents a participant type
specfield: attributes : set of AttributeType held in the business object type
specfield: masters : set of master BusinessObjectTypes
specfield: fsm (FSM) : finite state machine attached to the business object type

Hierarchy

MetaElement
- BusinessObjectType

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BusinessObjectType(name: string, participant: boolean, attributes?: Set<AttributeType>, masters?: Set<BusinessObjectType>, methods?: Set<Method>): BusinessObjectType

Overrides MetaElement.constructor
- Defined in meta-model/businessObjectType/businessObjectType.ts:24
Creates a new BusinessObjectType bot such that:
- this.name = name &&
- this.participant = participant &&
- this.attributes = attributes &&
- this.masters = masters &&
- this.methods = methods &&
- this.fsm = a default FSM generated for this
Parameters
- name: string
  
  Name of the business object type
- participant: boolean
  
  Defines whether or not the bot represents a participant type
- Default value attributes: Set<AttributeType> = new Set<AttributeType>()
  
  Defines the data attributes held in the business object type
- Default value masters: Set<BusinessObjectType> = new Set<BusinessObjectType>()
  
  Set of master business object types
- Default value methods: Set<Method> = new Set<Method>()
  
  Set of methods added to this
Returns BusinessObjectType

Properties

Private attributes

attributes: Map<string, AttributeType>

Private fsm

fsm: FSM

Private hasDefaultFSM

hasDefaultFSM: boolean

Private masters

masters: Set<BusinessObjectType>

Private methods

methods: Map<string, Method>

Private participant

participant: boolean

Methods

addAttribute

addAttribute(attributeType: AttributeType): void

- Defined in meta-model/businessObjectType/businessObjectType.ts:113
modifies

this

effects

this_post.attributes = this.attributes U { attributeType }

Parameters
- attributeType: AttributeType
  
  attribute type to add to this
Returns void

addMaster

addMaster(master: BusinessObjectType): void

- Defined in meta-model/businessObjectType/businessObjectType.ts:122
modifies

this

effects

this_post.masters = this.masters U { master }

Parameters
- master: BusinessObjectType
  
  Master Business object type to add for this
Returns void

addMethod

addMethod(method: Method): void

- Defined in meta-model/businessObjectType/businessObjectType.ts:131
modifies

this

effects

this_post.methods = this.methods U { method }

Parameters
- method: Method
  
  method to be added to this.methods
Returns void

getAttribute

getAttribute(attributeId: string): AttributeType

- Defined in meta-model/businessObjectType/businessObjectType.ts:72
throws

an Error if attributeType with id attributeId is not part of this

willreturn

otherwise, retrurns an attribute type a so that a is in this.attributes and a.id = attributeId

Parameters
- attributeId: string
  
  ID of the attribute to be retrieved
Returns AttributeType

getAttributes

getAttributes(): Array<AttributeType>

- Defined in meta-model/businessObjectType/businessObjectType.ts:60
willreturn

this.attributes

Returns Array<AttributeType>

getFSM

getFSM(): FSM

- Defined in meta-model/businessObjectType/businessObjectType.ts:102
willreturn

this.fsm

Returns FSM

getId

getId(): string

Inherited from MetaElement.getId
- Defined in meta-model/metaElement/metaElement.ts:36
willreturn

this.id

Returns string

getMasters

getMasters(): Set<BusinessObjectType>

- Defined in meta-model/businessObjectType/businessObjectType.ts:65
willreturn

this.masters

Returns Set<BusinessObjectType>

getMethod

getMethod(methodId: string): Method

- Defined in meta-model/businessObjectType/businessObjectType.ts:92
throws

an error if there is method with methodId as id that belongs to this

willreturn

otherwise, returns a method m so that m is in this.methods and m.id = methodId;

Parameters
- methodId: string
  
  Id of the method to be retrieved
Returns Method

getMethods

getMethods(): Array<Method>

- Defined in meta-model/businessObjectType/businessObjectType.ts:83
willreturn

this.methods

Returns Array<Method>

getName

getName(): string

Inherited from MetaElement.getName
- Defined in meta-model/metaElement/metaElement.ts:43
willreturn

this.name

Returns string

isParticipant

isParticipant(): boolean

- Defined in meta-model/businessObjectType/businessObjectType.ts:55
willreturn

this.participant

Returns boolean

isValid

isValid(): boolean

Overrides MetaElement.isValid
- Defined in meta-model/businessObjectType/businessObjectType.ts:148
Returns boolean

setFSM

setFSM(fsm: FSM): void

- Defined in meta-model/businessObjectType/businessObjectType.ts:142
modifies

this

effects

this_post.fsm = fsm

Parameters
- fsm: FSM
  
  new FSM to be assigned to this
Returns void

setId

setId(id: string): void

Inherited from MetaElement.setId
- Defined in meta-model/metaElement/metaElement.ts:53
modifies

this

effects

this_post.id = id

Parameters
- id: string
  
  New ID to assign to this
Returns void

toJSON

toJSON(): IBusinessObjectTypeJSON

Overrides MetaElement.toJSON
- Defined in meta-model/businessObjectType/businessObjectType.ts:152
Returns IBusinessObjectTypeJSON

toModelFormat

toModelFormat(): IBusinessObjectTypeModelFormat

Overrides MetaElement.toModelFormat
- Defined in meta-model/businessObjectType/businessObjectType.ts:164
Returns IBusinessObjectTypeModelFormat

Static createMapFromArray

createMapFromArray<MetaElementType>(elements: Array<MetaElementType>): Map<string, MetaElementType>

Inherited from MetaElement.createMapFromArray
- Defined in meta-model/metaElement/metaElement.ts:85
willreturn

A Map storing all the MetaElements stored in elements, using elements's id as map identifier

Type parameters
- MetaElementType: MetaElement
Parameters
- elements: Array<MetaElementType>
  
  MetaElements to be stored into a map
Returns Map<string, MetaElementType>

Generated using TypeDoc