Template:— referencing_work_request (ref_wrk_req) |
Date: 2008/02/28 13:39:57 Revision: 1.3
|
This section specifies the template referencing_work_request.
NOTE
An explanation of a template and the associated instantiation path is
provided in the
Template overview
section.
This template describes how to represent a reference to a work request.
The EXPRESS-G diagram in
Figure
1
shows the templates and EXPRESS entities that are required
to represent the template
"referencing_work_request".
The text highlighted in blue shows the template parameters.
Figure 1 — An EXPRESS-G representation of the Information model for referencing_work_request
The graphic for the template to be used in other EXPRESS-G diagrams
is shown in Figure
2
below.
Figure 2 — The graphical representation of the referencing_work_request template
The following input parameters are defined for this template:
id_class_name (Default=Work_request_identification_code,Type='CLASS')
The name of the class used to classify the identifier and so
provide the role or reason for the identification.
The following classes and their sub-classes can be used:
id_ecl_id (Default=urn:plcs:rdl:std,Type='URN')
The identifier of the organization that
"owns" the identifier.
The name of the class being used to classify the
identification of the organization. For example CAGE code.
The following classes and their sub-classes can be used:
The version identifier being assigned to the
Work_request.
NOTE
If the version is not known use /NULL.
The name of the class used to classify the identifier and so
provide the role or reason for the identification.
The following classes and their sub-classes can be used:
The identifier of the
External_class_library
storing the class provide by the input parameter @version_id_class_name
The identifier of the organization that
"owns" the version identifier.
The name of the class being used to classify the
identification of the organization that
"owns" the version identifier. For example CAGE code.
The following classes and their sub-classes can be used:
The identifier of the
External_class_library
storing the class provide by the input parameter @version_org_id_class_name.
The following reference parameters are defined for this template:
Allow the
Work_request
entity instantiated in this path to be referenced when this template is used.
Note: The
Work_request
entity can be referenced in a template path by:
%^target = $referencing_work_request.work_req%
where
target
is the parameter to which the
Work_request
is bound.
The following parameter combinations specify a uniqueness constraint:
Unique constraint: Unique work request
Unique constraint: Unique work request version
There shall be at most one instance of the
entity
(
Work_request)
within the data set uniquely identified
by a combination of the following parameters on this
template (referencing_work_request) namely:
id,
id_class_name,
id_ecl_id,
org_id,
org_id_class_name,
org_id_ecl_id,
version_id,
version_id_class_name,
version_id_ecl_id,
version_org_id,
version_org_id_class_name,
version_org_id_ecl_id.
The
instance is
referenced by the following template parameter:
work_req.
The instantiation path shown below specifies the entities that are to be
instantiated by the template.
-- Instantiate a Work_request Work_request-- Bind the Work_request to the parameter ^work_req. -- The parameter is a reference parameter so the Work_request -- entity can be referred to when this template is used. %^work_req =
Work_request%
^work_req.description = '/IGNORE'
^work_req.purpose = '/IGNORE'
^work_req.request_id = '/IGNORE'
^work_req.version_id = '/IGNORE'
-- Identify the Work_request /
assigning_identification(
id=@id,
id_class_name=@id_class_name,
id_ecl_id=@id_ecl_id,
org_id=@org_id,
org_id_class_name=@org_id_class_name,
org_id_ecl_id=@org_id_ecl_id,
items=^work_req)/
-- Identify the Work_request version /
assigning_identification(
id=@version_id,
id_class_name=@version_id_class_name,
id_ecl_id=@version_id_ecl_id,
org_id=@version_org_id,
org_id_class_name=@version_org_id_class_name,
org_id_ecl_id=@version_org_id_ecl_id,
items=^work_req)/
The following entities are instantiated with attributes as specified:
The instance diagram in Figure
3
shows an example of the EXPRESS entities and templates that are instantiated by the template:
/referencing_work_request(id='Issue 134', id_class_name='Work_request_identification_code', id_ecl_id='urn:plcs:rdl:std', org_id='BikeRent Limited', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std', version_id='v1', version_id_class_name='Version_identification_code', version_id_ecl_id='urn:plcs:rdl:std', version_org_id='BikeRent Limited', version_org_id_class_name='Organization_name', version_org_id_ecl_id='urn:plcs:rdl:std')/
(an illustration of the consolidated referencing_work_request template is shown in
Figure
4 below.)
Figure 3 — Entities instantiated by referencing_work_request template
The instance diagram in
Figure
4
shows the graphic symbol for the template that is to be
used in other instance diagrams. The example template is:
/referencing_work_request(id='Issue 134', id_class_name='Work_request_identification_code', id_ecl_id='urn:plcs:rdl:std', org_id='BikeRent Limited', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std', version_id='v1', version_id_class_name='Version_identification_code', version_id_ecl_id='urn:plcs:rdl:std', version_org_id='BikeRent Limited', version_org_id_class_name='Organization_name', version_org_id_ecl_id='urn:plcs:rdl:std')/
Figure 4 — Instantiation of referencing_work_request template
Characterizations
No common characterizations of the template
referencing_work_request
have been identified. However, the ISO 10303-239 EXPRESS model
may enable other assignments to the entities instantiated by the template.