Materialised Model

Overview

The Model overview figure shows a package proc.task_planning.materialised. This is a partial specification of classes that could be instantiated at Task Plan execution time to track Plan execution, and is provided as a guide to implementing a materialised form for runtime use. A minimal materialised model is described here, as a means of indicating some of the general issues that will be encountered in representation of the runtime form of a Plan definition. It should not be considered either normative or complete. The model is shown below.

Figure 1. proc.task_planning.materialised package

Class Descriptions

M_WORK_PLAN Class

Definition

Class	M_WORK_PLAN
Description	Materialised form of `WORK_PLAN`.
Attributes	Signature	Meaning
0..1	plans: `List<M_TASK_PLAN>`	Member Plans.
1..1	owner: `WORK_PLAN`	Owning Work Plan definition.
1..1	timeline: `M_TIMELINE`	Materialised global timeline.
1..1	calendar: `M_CALENDAR`	Materialised global calendar.
1..1	context: `M_PLAN_DATA_CONTEXT`	Materialised global context.

Class

M_WORK_PLAN

Description

Materialised form of WORK_PLAN.

Attributes

Signature

Meaning

0..1

plans: List<M_TASK_PLAN>

Member Plans.

1..1

owner: WORK_PLAN

Owning Work Plan definition.

1..1

timeline: M_TIMELINE

Materialised global timeline.

1..1

calendar: M_CALENDAR

Materialised global calendar.

1..1

context: M_PLAN_DATA_CONTEXT

Materialised global context.

M_TASK_PLAN Class

Definition

Class	M_TASK_PLAN
Description	Root object of a materialised Task Plan structure, used in execution.
Attributes	Signature	Meaning
0..1	start_time: `Iso8601_date_time`	Nominal start time for the Task Plan as a whole. The timings of individual Tasks may be specified as offsets from this time, via `PLANNED_TIME.relative_offset`.
1..1	definition: `M_TASK_GROUP`	Root of run-time Task Plan Task structure.
1..1	owner: `TASK_PLAN`	Owning Task Plan definition.
0..1	pending_callbacks: `List<M_CALLBACK>`	Reference list of all wait conditions in the Task Plan, and current status.
1..1	principal_performer: `M_PERFORMER_ALLOCATION`	Run-time principal performer - a person or other agent.
Functions	Signature	Meaning
1..1	lifecycle_state (): `TASK_LIFECYCLE`	Lifecycle state of Task Plan, derived as a copy of the `lifecycle_state()` of the definition `TASK_GROUP`.

Class

M_TASK_PLAN

Description

Root object of a materialised Task Plan structure, used in execution.

Attributes

Signature

Meaning

0..1

start_time: Iso8601_date_time

Nominal start time for the Task Plan as a whole. The timings of individual Tasks may be specified as offsets from this time, via PLANNED_TIME.relative_offset.

1..1

definition: M_TASK_GROUP

Root of run-time Task Plan Task structure.

1..1

owner: TASK_PLAN

Owning Task Plan definition.

0..1

pending_callbacks: List<M_CALLBACK>

Reference list of all wait conditions in the Task Plan, and current status.

1..1

principal_performer: M_PERFORMER_ALLOCATION

Run-time principal performer - a person or other agent.

Functions

Signature

Meaning

1..1

lifecycle_state (): TASK_LIFECYCLE

Lifecycle state of Task Plan, derived as a copy of the lifecycle_state() of the definition TASK_GROUP.

M_PERFORMER_ALLOCATION Class

Definition

Class	M_PERFORMER_ALLOCATION
Description	Tracking information for a current performer allocation.
Attributes	Signature	Meaning
1..1	performer: `PARTY_IDENTIFIED`	Identity of allocated performer.
1..1	connection: `String`	URI used to connect to performer (e.g. application, messaging channel) for notifications.
1..1	other_details: `Hash<String, String>`	Archetypable details.

Class

M_PERFORMER_ALLOCATION

Description

Tracking information for a current performer allocation.

Attributes

Signature

Meaning

1..1

performer: PARTY_IDENTIFIED

Identity of allocated performer.

1..1

connection: String

URI used to connect to performer (e.g. application, messaging channel) for notifications.

1..1

other_details: Hash<String, String>

Archetypable details.

M_PLAN_ITEM Class

Definition

Class	*M_PLAN_ITEM (abstract)*
Description	Abstract parent of materialised run-time types that correspond to design time `PLAN_ITEM` instances.
Attributes	Signature	Meaning
1..1	definition: `PLAN_ITEM`	Corresponding item from Task Plan definition. Redefined in descendants to the definition type corresponding to each runtime (RT_XXX) type.

Class

M_PLAN_ITEM (abstract)

Description

Abstract parent of materialised run-time types that correspond to design time PLAN_ITEM instances.

Attributes

Signature

Meaning

1..1

definition: PLAN_ITEM

Corresponding item from Task Plan definition. Redefined in descendants to the definition type corresponding to each runtime (RT_XXX) type.

M_TASK_GROUP Class

Definition

Class	M_TASK_GROUP
Description	Materialised form of `TASK_GROUP` from a Task Plan definition.
Inherit	`M_PLAN_ITEM`
Attributes	Signature	Meaning
0..1	members: `List<M_PLAN_ITEM>`	Member run-time items in group, mimicking structure of the corresponding definition group instance.
1..1 (redefined)	definition: `TASK_GROUP`	Reference to corresponding TASK_GROUP instance in Task Plan definition.
Functions	Signature	Meaning
1..1	lifecycle_state (): `TASK_LIFECYCLE`	Effective lifecycle state, computed from the states of members of the group.

Class

M_TASK_GROUP

Description

Materialised form of TASK_GROUP from a Task Plan definition.

Inherit

M_PLAN_ITEM

Attributes

Signature

Meaning

0..1

members: List<M_PLAN_ITEM>

Member run-time items in group, mimicking structure of the corresponding definition group instance.

1..1
(redefined)

definition: TASK_GROUP

Reference to corresponding TASK_GROUP instance in Task Plan definition.

Functions

Signature

Meaning

1..1

lifecycle_state (): TASK_LIFECYCLE

Effective lifecycle state, computed from the states of members of the group.

M_TASK Class

Definition

Class	M_TASK
Description	Materialised form of `TASK` type and its descendants from a Task Plan definition.
Inherit	`M_PLAN_ITEM`
Attributes	Signature	Meaning
1..1	lifecycle_state: `TASK_LIFECYCLE`	Current lifecycle state of this Task at run-time.
0..1	events: `List<TASK_EVENT_RECORD>`	List of references to run-time events that have occurred on this Task.
0..1	preconditions: `List<EL_BOOLEAN_EXPRESSION>`	Run-time form of preconditions on corresponding TASK in Task Plan definition.
1..1 (redefined)	definition: `TASK`	Reference to corresponding TASK instance in Task Plan definition.

Class

M_TASK

Description

Materialised form of TASK type and its descendants from a Task Plan definition.

Inherit

M_PLAN_ITEM

Attributes

Signature

Meaning

1..1

lifecycle_state: TASK_LIFECYCLE

Current lifecycle state of this Task at run-time.

0..1

events: List<TASK_EVENT_RECORD>

List of references to run-time events that have occurred on this Task.

0..1

preconditions: List<EL_BOOLEAN_EXPRESSION>

Run-time form of preconditions on corresponding TASK in Task Plan definition.

1..1
(redefined)

definition: TASK

Reference to corresponding TASK instance in Task Plan definition.

M_TASK_ACTION Class

Definition

Class	M_TASK_ACTION
Description	Materialised form of `TASK_ACTION` type.
Attributes	Signature	Meaning
1..1	definition: `TASK_ACTION`

Class

M_TASK_ACTION

Description

Materialised form of TASK_ACTION type.

Attributes

Signature

Meaning

1..1

definition: TASK_ACTION

M_DISPATCHABLE_ACTION Class

Definition

Class	M_DISPATCHABLE_ACTION
Description	Materialised form of `DISPATCHABLE_ACTION`.
Inherit	`M_TASK_ACTION`

Class

M_DISPATCHABLE_ACTION

Description

Materialised form of DISPATCHABLE_ACTION.

Inherit

M_TASK_ACTION

M_PERFORMABLE_ACTION Class

Definition

Class	M_PERFORMABLE_ACTION
Description	Materialised form of `PERFORMABLE_ACTION`.
Inherit	`M_TASK_ACTION`

Class

M_PERFORMABLE_ACTION

Description

Materialised form of PERFORMABLE_ACTION.

Inherit

M_TASK_ACTION