Class Method

Methods are MetaElements that are executed to create business objects, alter their state or end their lifecycle.

Methods are mutable

specfield: ownershipType : type of ownership of the method from the business object type
specfield: effectType : type of effect provoked by the execution of the method
specfield: parameters : list of parameters to provide when invoking a method
specfield: triggeringEvent: BusinessEventType which triggers the execution of this

Hierarchy

MetaElement
- Method
  - ModifyingMethod

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Method(name: string, triggeringEvent: BusinessEventType, ownershipType: OwnershipType, effectType: EffectType, parameters?: Array<AttributeType>): Method

Overrides MetaElement.constructor
- Defined in meta-model/method/method.ts:24
Creates a new method m so that:
- m.name = name &&
- m.effectType = effectType &&
- m.ownershipType = ownershipType &&
- m.parameters = parameters &&
- m.triggeringEvent = triggeringEvent
Parameters
- name: string
  
  Name of the method
- triggeringEvent: BusinessEventType
  
  Triggering [[BusinessEventtype]]
- ownershipType: OwnershipType
  
  Type of ownership of the method
- effectType: EffectType
  
  Type of effect of the method
- Default value parameters: Array<AttributeType> = new Array<AttributeType>()
  
  Parameters to provide when invoking method
Returns Method

Properties

Private effectType

effectType: EffectType

Private ownershipType

ownershipType: OwnershipType

Private parameters

parameters: Map<string, AttributeType>

Private triggeringEvent

triggeringEvent: BusinessEventType

Methods

addParameter

addParameter(param: AttributeType): void

- Defined in meta-model/method/method.ts:96
modifies

this

effects

this_post.parameters = this.parameters U { param }

Parameters
- param: AttributeType
  
  parameter to be added to this
Returns void

getEffectType

getEffectType(): EffectType

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

this.effectType

Returns EffectType

getId

getId(): string

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

this.id

Returns string

getName

getName(): string

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

this.name

Returns string

getOwnershipType

getOwnershipType(): OwnershipType

- Defined in meta-model/method/method.ts:53
willreturn

this.ownershipType

Returns OwnershipType

getParameter

getParameter(paramId: string): AttributeType

- Defined in meta-model/method/method.ts:76
throws

an error in case there is no parameter with id paramId known to this

willreturn

otherwise, returns a parameter p so that p is in this.parameters and p.id = paramId

Parameters
- paramId: string
  
  id of the parameter to be retrieved
Returns AttributeType

getParameters

getParameters(): Array<AttributeType>

- Defined in meta-model/method/method.ts:67
willreturn

this.parameters

Returns Array<AttributeType>

getTriggeringEvent

getTriggeringEvent(): BusinessEventType

- Defined in meta-model/method/method.ts:85
willreturn

this.triggeringEvent

Returns BusinessEventType

isValid

isValid(): boolean

Inherited from MetaElement.isValid
- Defined in meta-model/metaElement/metaElement.ts:76
willreturn

true if this contains all required data to be a valid MetaElement

willreturn

false otherwise

Returns boolean

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

Overrides MetaElement.toJSON
- Defined in meta-model/method/method.ts:101
Returns IMethodJSON

toModelFormat

toModelFormat(): IMethodModelFormat

Overrides MetaElement.toModelFormat
- Defined in meta-model/method/method.ts:112
Returns IMethodModelFormat

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