Template:— representing_contract (rep_ctr) Date: 2008/03/03 07:36:04
Revision: 1.21
Template: representing_contract

XML references to the Template

These can be cut and pasted into the XML as required.

representing_contract

Set up a hyperlink to the template definition.
<template_ref name="representing_contract" capability="representing_contract"/>

Set up a table of the template parameters.
<template_table figure_id="?" instance="" name="representing_contract" capability="representing_contract">
  <param name="rep_ctr_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_ctr_id_class_name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_ctr_id_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="rep_ctr_id_org_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_ctr_id_org_id_class_name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_ctr_id_org_id_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="rep_ctr_ass_contractee_org_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_ctr_ass_contractee_org_id_class_name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_ctr_ass_contractee_org_id_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="rep_ctr_ass_contractor_org_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_ctr_ass_contractor_org_id_class_name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_ctr_ass_contractor_org_id_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="rep_ctr_doc_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_ctr_doc_org_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_ctr_doc_org_id_class_name">
    <param_value>Organization_name</param_value>
    <description></description>
  </param>
  <param name="rep_ctr_doc_org_id_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="rep_ctr_doc_vn_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_ctr_doc_vn_id_class_name">
    <param_value>Version_identification_code</param_value>
    <description></description>
  </param>
  <param name="rep_ctr_doc_vn_id_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="rep_ctr_doc_vn_org_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_ctr_doc_vn_org_id_class_name">
    <param_value>Organization_name</param_value>
    <description></description>
  </param>
  <param name="rep_ctr_doc_vn_org_id_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="rep_ctr_life_cycle_stage">
    <param_value>Support_stage</param_value>
    <description></description>
  </param>
  <param name="rep_ctr_life_cycle_stage_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="rep_ctr_domain">
    <param_value>Product_life_cycle_support</param_value>
    <description></description>
  </param>
  <param name="rep_ctr_domain_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="representing_contract">
  <param_in name="rep_ctr_id" value=""/>
  <param_in name="rep_ctr_id_class_name" value=""/>
  <param_in name="rep_ctr_id_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="rep_ctr_id_org_id" value=""/>
  <param_in name="rep_ctr_id_org_id_class_name" value=""/>
  <param_in name="rep_ctr_id_org_id_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="rep_ctr_ass_contractee_org_id" value=""/>
  <param_in name="rep_ctr_ass_contractee_org_id_class_name" value=""/>
  <param_in name="rep_ctr_ass_contractee_org_id_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="rep_ctr_ass_contractor_org_id" value=""/>
  <param_in name="rep_ctr_ass_contractor_org_id_class_name" value=""/>
  <param_in name="rep_ctr_ass_contractor_org_id_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="rep_ctr_doc_id" value=""/>
  <param_in name="rep_ctr_doc_org_id" value=""/>
  <param_in name="rep_ctr_doc_org_id_class_name" value="Organization_name"/>
  <param_in name="rep_ctr_doc_org_id_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="rep_ctr_doc_vn_id" value=""/>
  <param_in name="rep_ctr_doc_vn_id_class_name" value="Version_identification_code"/>
  <param_in name="rep_ctr_doc_vn_id_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="rep_ctr_doc_vn_org_id" value=""/>
  <param_in name="rep_ctr_doc_vn_org_id_class_name" value="Organization_name"/>
  <param_in name="rep_ctr_doc_vn_org_id_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="rep_ctr_life_cycle_stage" value="Support_stage"/>
  <param_in name="rep_ctr_life_cycle_stage_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="rep_ctr_domain" value="Product_life_cycle_support"/>
  <param_in name="rep_ctr_domain_ecl_id" value="urn:plcs:rdl:std"/>
</template_example>

representing_contract
/representing_contract(rep_ctr_id='', rep_ctr_id_class_name='', rep_ctr_id_ecl_id='urn:plcs:rdl:std', rep_ctr_id_org_id='', rep_ctr_id_org_id_class_name='', rep_ctr_id_org_id_ecl_id='urn:plcs:rdl:std', rep_ctr_ass_contractee_org_id='', rep_ctr_ass_contractee_org_id_class_name='', rep_ctr_ass_contractee_org_id_ecl_id='urn:plcs:rdl:std', rep_ctr_ass_contractor_org_id='', rep_ctr_ass_contractor_org_id_class_name='', rep_ctr_ass_contractor_org_id_ecl_id='urn:plcs:rdl:std', rep_ctr_doc_id='', rep_ctr_doc_org_id='', rep_ctr_doc_org_id_class_name='Organization_name', rep_ctr_doc_org_id_ecl_id='urn:plcs:rdl:std', rep_ctr_doc_vn_id='', rep_ctr_doc_vn_id_class_name='Version_identification_code', rep_ctr_doc_vn_id_ecl_id='urn:plcs:rdl:std', rep_ctr_doc_vn_org_id='', rep_ctr_doc_vn_org_id_class_name='Organization_name', rep_ctr_doc_vn_org_id_ecl_id='urn:plcs:rdl:std', rep_ctr_life_cycle_stage='Support_stage', rep_ctr_life_cycle_stage_ecl_id='urn:plcs:rdl:std', rep_ctr_domain='Product_life_cycle_support', rep_ctr_domain_ecl_id='urn:plcs:rdl:std')/

Path

-- Instantiate a Contract
Contract

-- Bind the Contract to the parameter ^contract
-- The parameter is a reference parameter so the Contract_assignment
-- entity can be referred to when this template is used.
%^contract = Contract%

-- Set the Contract attributes id, purpose and kind to be ignored
Contract.id = '/IGNORE'
Contract.kind = '/IGNORE'
Contract.purpose = '/IGNORE'

-- Identify the Contract
/assigning_identification(
    items=^contract,
    id=@rep_ctr_id,
    id_class_name=@rep_ctr_id_class_name,
    id_ecl_id=@rep_ctr_id_ecl_id,
    org_id=@rep_ctr_id_org_id,
    org_id_class_name=@rep_ctr_id_org_id_class_name,
    org_id_ecl_id=@rep_ctr_id_org_id_ecl_id )/

-- documents defining the Contract
/representing_document(
    doc_id=@rep_ctr_doc_id,
    doc_id_class_name='Contract',
    doc_id_ecl_id='urn:plcs:rdl:std',
    doc_org_id=@rep_ctr_doc_org_id,
    doc_org_id_class_name=@rep_ctr_doc_org_id_class_name,
    doc_org_id_ecl_id=@rep_ctr_doc_org_id_ecl_id,
    doc_vn_id=@rep_ctr_doc_vn_id,
    doc_vn_id_class_name=@rep_ctr_doc_vn_id_class_name,
    doc_vn_id_ecl_id=@rep_ctr_doc_vn_id_ecl_id,
    doc_vn_org_id=@rep_ctr_doc_vn_org_id,
    doc_vn_org_id_class_name=@rep_ctr_doc_vn_org_id_class_name,
    doc_vn_org_id_ecl_id=@rep_ctr_doc_vn_org_id_ecl_id,
    domain=@rep_ctr_domain,
    domain_ecl_id=@rep_ctr_domain_ecl_id,
    life_cycle_stage=@rep_ctr_life_cycle_stage,
    life_cycle_stage_ecl_id=@rep_ctr_life_cycle_stage_ecl_id)/
%^view_definition_context = $representing_document.view_definition_context%
%^document_definition = $representing_document.document_definition%
%^document_version = $representing_document.document_version%
%^document = $representing_document.document%

-- Assign a document to the Contract
/assigning_document(
    doc_ass_role='Document_assignment',
    doc_ar_ecl_id='urn:plcs:rdl:std',
    is_assigned_to=^contract),
    assigned_document=^document_version)/
%^document_assignment = $assigning_document.doc_asg%

-- Assign a contractee to the Contract
/assigning_organization(
    items=^contract,
    org_id=@rep_ctr_ass_contractee_org_id,
    org_id_class_name=@rep_ctr_ass_contractee_org_id_class_name,
    org_id_ecl_id=@rep_ctr_ass_contractee_org_id_ecl_id,
    org_assgn_class_name='Contractee',
    org_assgn_ecl_id='urn:plcs:rdl:std' )/
%^contractee = $assigning_organization.organization%

-- Assign a contractor to the Contract
/assigning_organization(
    items=^contract,
    org_id=@rep_ctr_ass_contractor_org_id,
    org_id_class_name=@rep_ctr_ass_contractor_org_id_class_name,
    org_id_ecl_id=@rep_ctr_ass_contractor_org_id_ecl_id,
    org_assgn_class_name='Contractor',
    org_assgn_ecl_id='urn:plcs:rdl:std' )/
%^contractor = $assigning_organization.organization%
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Contract.id '/IGNORE'
Contract.kind '/IGNORE'
Contract.purpose '/IGNORE'

XML representation of path

<refpath
   template="representing_contract">
   <comment>
      Instantiate a Contract
   </comment>
   <instantiate
      entity="Contract"
      context="">
      
   </instantiate>
   <comment>
      Bind the Contract to the parameter ^contract
   </comment>
   <comment>
      The parameter is a reference parameter so the Contract_assignment
   </comment>
   <comment>
      entity can be referred to when this template is used.
   </comment>
   <bind
      parameter="contract">
      <express_entity
         entity="Contract"
         context="">
         
      </express_entity>
   </bind>
   <comment>
      Set the Contract attributes id, purpose and kind to be ignored
   </comment>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Contract"
            attribute="id"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Contract"
            attribute="kind"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Contract"
            attribute="purpose"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <comment>
      Identify the Contract
   </comment>
   <call_template
      name="assigning_identification"
      business_context="">
      <param_in
         name="items"
         value="^contract">
         
      </param_in>
      <param_in
         name="id"
         value="@rep_ctr_id">
         
      </param_in>
      <param_in
         name="id_class_name"
         value="@rep_ctr_id_class_name">
         
      </param_in>
      <param_in
         name="id_ecl_id"
         value="@rep_ctr_id_ecl_id">
         
      </param_in>
      <param_in
         name="org_id"
         value="@rep_ctr_id_org_id">
         
      </param_in>
      <param_in
         name="org_id_class_name"
         value="@rep_ctr_id_org_id_class_name">
         
      </param_in>
      <param_in
         name="org_id_ecl_id"
         value="@rep_ctr_id_org_id_ecl_id ">
         
      </param_in>
   </call_template>
   <comment>
      documents defining the Contract
   </comment>
   <call_template
      name="representing_document"
      business_context="">
      <param_in
         name="doc_id"
         value="@rep_ctr_doc_id">
         
      </param_in>
      <param_in
         name="doc_id_class_name"
         value="'Contract'">
         
      </param_in>
      <param_in
         name="doc_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="doc_org_id"
         value="@rep_ctr_doc_org_id">
         
      </param_in>
      <param_in
         name="doc_org_id_class_name"
         value="@rep_ctr_doc_org_id_class_name">
         
      </param_in>
      <param_in
         name="doc_org_id_ecl_id"
         value="@rep_ctr_doc_org_id_ecl_id">
         
      </param_in>
      <param_in
         name="doc_vn_id"
         value="@rep_ctr_doc_vn_id">
         
      </param_in>
      <param_in
         name="doc_vn_id_class_name"
         value="@rep_ctr_doc_vn_id_class_name">
         
      </param_in>
      <param_in
         name="doc_vn_id_ecl_id"
         value="@rep_ctr_doc_vn_id_ecl_id">
         
      </param_in>
      <param_in
         name="doc_vn_org_id"
         value="@rep_ctr_doc_vn_org_id">
         
      </param_in>
      <param_in
         name="doc_vn_org_id_class_name"
         value="@rep_ctr_doc_vn_org_id_class_name">
         
      </param_in>
      <param_in
         name="doc_vn_org_id_ecl_id"
         value="@rep_ctr_doc_vn_org_id_ecl_id">
         
      </param_in>
      <param_in
         name="domain"
         value="@rep_ctr_domain">
         
      </param_in>
      <param_in
         name="domain_ecl_id"
         value="@rep_ctr_domain_ecl_id">
         
      </param_in>
      <param_in
         name="life_cycle_stage"
         value="@rep_ctr_life_cycle_stage">
         
      </param_in>
      <param_in
         name="life_cycle_stage_ecl_id"
         value="@rep_ctr_life_cycle_stage_ecl_id">
         
      </param_in>
   </call_template>
   <bind
      parameter="view_definition_context">
      <template_instance
         template="representing_document"
         parameter="view_definition_context">
         
      </template_instance>
   </bind>
   <bind
      parameter="document_definition">
      <template_instance
         template="representing_document"
         parameter="document_definition">
         
      </template_instance>
   </bind>
   <bind
      parameter="document_version">
      <template_instance
         template="representing_document"
         parameter="document_version">
         
      </template_instance>
   </bind>
   <bind
      parameter="document">
      <template_instance
         template="representing_document"
         parameter="document">
         
      </template_instance>
   </bind>
   <comment>
      Assign a document to the Contract
   </comment>
   <call_template
      name="assigning_document"
      business_context="">
      <param_in
         name="doc_ass_role"
         value="'Document_assignment'">
         
      </param_in>
      <param_in
         name="doc_ar_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^contract)">
         
      </param_in>
      <param_in
         name="assigned_document"
         value="^document_version">
         
      </param_in>
   </call_template>
   <bind
      parameter="document_assignment">
      <template_instance
         template="assigning_document"
         parameter="doc_asg">
         
      </template_instance>
   </bind>
   <comment>
      Assign a contractee to the Contract
   </comment>
   <call_template
      name="assigning_organization"
      business_context="">
      <param_in
         name="items"
         value="^contract">
         
      </param_in>
      <param_in
         name="org_id"
         value="@rep_ctr_ass_contractee_org_id">
         
      </param_in>
      <param_in
         name="org_id_class_name"
         value="@rep_ctr_ass_contractee_org_id_class_name">
         
      </param_in>
      <param_in
         name="org_id_ecl_id"
         value="@rep_ctr_ass_contractee_org_id_ecl_id">
         
      </param_in>
      <param_in
         name="org_assgn_class_name"
         value="'Contractee'">
         
      </param_in>
      <param_in
         name="org_assgn_ecl_id"
         value="'urn:plcs:rdl:std' ">
         
      </param_in>
   </call_template>
   <bind
      parameter="contractee">
      <template_instance
         template="assigning_organization"
         parameter="organization">
         
      </template_instance>
   </bind>
   <comment>
      Assign a contractor to the Contract
   </comment>
   <call_template
      name="assigning_organization"
      business_context="">
      <param_in
         name="items"
         value="^contract">
         
      </param_in>
      <param_in
         name="org_id"
         value="@rep_ctr_ass_contractor_org_id">
         
      </param_in>
      <param_in
         name="org_id_class_name"
         value="@rep_ctr_ass_contractor_org_id_class_name">
         
      </param_in>
      <param_in
         name="org_id_ecl_id"
         value="@rep_ctr_ass_contractor_org_id_ecl_id">
         
      </param_in>
      <param_in
         name="org_assgn_class_name"
         value="'Contractor'">
         
      </param_in>
      <param_in
         name="org_assgn_ecl_id"
         value="'urn:plcs:rdl:std' ">
         
      </param_in>
   </call_template>
   <bind
      parameter="contractor">
      <template_instance
         template="assigning_organization"
         parameter="organization">
         
      </template_instance>
   </bind>
</refpath>

© OASIS 2010 — All rights reserved