Class ModifyingMethod

A ModifyingMethod is a Method that modifies the value of a business object's attribute.

ModifyingMethods are mutable

specfield: modifiedAttribute: attribute whose value can be modified when executing this

Hierarchy

Method
- ModifyingMethod

Index

Constructors

constructor

Properties

modifiedAttribute

Methods

Constructors

constructor

new ModifyingMethod(name: string, triggeringEvent: BusinessEventType, ownershipType: OwnershipType, parameters?: Array<AttributeType>, modifiedAttribute?: AttributeType): ModifyingMethod

Overrides Method.constructor
- Defined in meta-model/method/modifyingMethod/modifyingMethod.ts:18
Creates a new ModifyingMethod m so that:
- this.name = name &&
- this.triggeringEvent = triggeringEvent &&
- this.ownershipType = ownershipType &&
- this.effectType = EffectType.Modify &&
- this.modifiedAttribute = modifiedAttribute &&
Parameters
- name: string
  
  Name of the method
- triggeringEvent: BusinessEventType
- ownershipType: OwnershipType
  
  Type of ownership of the method from the business object type
- Default value parameters: Array<AttributeType> = new Array<AttributeType>()
  
  Parameters to provide to execute the method
- Optional modifiedAttribute: AttributeType
  
  AttributeType whose instanced value can be modified when executing this
Returns ModifyingMethod

Properties

Private modifiedAttribute

modifiedAttribute: AttributeType

Methods

addParameter

addParameter(param: AttributeType): void

Inherited from Method.addParameter
- 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

Inherited from Method.getEffectType
- 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

getModifiedAttribute

getModifiedAttribute(): AttributeType

- Defined in meta-model/method/modifyingMethod/modifyingMethod.ts:43
willreturn

this.modifiedAttribute

Returns AttributeType

getName

getName(): string

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

this.name

Returns string

getOwnershipType

getOwnershipType(): OwnershipType

Inherited from Method.getOwnershipType
- Defined in meta-model/method/method.ts:53
willreturn

this.ownershipType

Returns OwnershipType

getParameter

getParameter(paramId: string): AttributeType

Inherited from Method.getParameter
- 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>

Inherited from Method.getParameters
- Defined in meta-model/method/method.ts:67
willreturn

this.parameters

Returns Array<AttributeType>

getTriggeringEvent

getTriggeringEvent(): BusinessEventType

Inherited from Method.getTriggeringEvent
- Defined in meta-model/method/method.ts:85
willreturn

this.triggeringEvent

Returns BusinessEventType

isValid

isValid(): boolean

Overrides MetaElement.isValid
- Defined in meta-model/method/modifyingMethod/modifyingMethod.ts:74
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(): IModifyingMethodJSON

Overrides Method.toJSON
- Defined in meta-model/method/modifyingMethod/modifyingMethod.ts:48
Returns IModifyingMethodJSON

toModelFormat

toModelFormat(): IModifyingMethodModelFormat

Overrides Method.toModelFormat
- Defined in meta-model/method/modifyingMethod/modifyingMethod.ts:61
Returns IModifyingMethodModelFormat

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