Template:— representing_dated_effectivity (rep_date_eff) Date: 2008/02/26 17:20:57
Revision: 1.16
Template: representing_dated_effectivity

XML references to the Template

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

representing_dated_effectivity

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

Set up a table of the template parameters.
<template_table figure_id="?" instance="" name="representing_dated_effectivity" capability="assigning_effectivity">
  <param name="start_year">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="start_month">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="start_day">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="start_hour">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="start_minute">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="start_second">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="start_sense">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="start_hour_offset">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="start_minute_offset">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="end_year">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="end_month">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="end_day">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="end_hour">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="end_minute">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="end_second">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="end_sense">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="end_hour_offset">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="end_minute_offset">
    <param_value></param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="representing_dated_effectivity">
  <param_in name="start_year" value=""/>
  <param_in name="start_month" value=""/>
  <param_in name="start_day" value=""/>
  <param_in name="start_hour" value=""/>
  <param_in name="start_minute" value=""/>
  <param_in name="start_second" value=""/>
  <param_in name="start_sense" value=""/>
  <param_in name="start_hour_offset" value=""/>
  <param_in name="start_minute_offset" value=""/>
  <param_in name="end_year" value=""/>
  <param_in name="end_month" value=""/>
  <param_in name="end_day" value=""/>
  <param_in name="end_hour" value=""/>
  <param_in name="end_minute" value=""/>
  <param_in name="end_second" value=""/>
  <param_in name="end_sense" value=""/>
  <param_in name="end_hour_offset" value=""/>
  <param_in name="end_minute_offset" value=""/>
</template_example>

representing_dated_effectivity
/representing_dated_effectivity(start_year='', start_month='', start_day='', start_hour='', start_minute='', start_second='', start_sense='', start_hour_offset='', start_minute_offset='', end_year='', end_month='', end_day='', end_hour='', end_minute='', end_second='', end_sense='', end_hour_offset='', end_minute_offset='')/

Path

-- Instantiate Dated_effectivity entity
Dated_effectivity

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

-- Set the Dated_effectivity attributes to be ignored
Dated_effectivity.id = '/IGNORE'
Dated_effectivity.name = '/IGNORE'
Dated_effectivity.description = '/IGNORE'

-- Set up date for start_bound - Instantiate the representing_date_time template
/representing_date_time(
    year=@start_year,
    month=@start_month,
    day=@start_day,
    hour=@start_hour,
    minute=@start_minute,
    second=@start_second,
    sense=@start_sense,
    hour_offset=@start_hour_offset,
    minute_offset=@start_minute_offset)/

-- representing_date_time has a reference parameter ^date_time
-- which is bound to the entity Date_time
-- Assign Dated_effectivity.start_bound to ^date_time
%^start_date_time = $representing_date_time.date_time%
Dated_effectivity.start_bound -> ^start_date_time

-- Set up date for end_bound - Instantiate the representing_date_time template
-- NOTE - this is optional
/representing_date_time(
    year=@end_year,
    month=@end_month,
    day=@end_day,
    hour=@end_hour,
    minute=@end_minute,
    second=@end_second,
    sense=@end_sense,
    hour_offset=@end_hour_offset,
    minute_offset=@end_minute_offset)/

-- representing_date_time has a reference parameter ^date_time
-- which is bound to the entity Date_time
-- Assign Dated_effectivity.end_bound to ^date_time
%^end_date_time = $representing_date_time.date_time%
Dated_effectivity.end_bound -> ^end_date_time
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Dated_effectivity.id '/IGNORE' Effectivity.id
Dated_effectivity.name '/IGNORE' Effectivity.name
Dated_effectivity.description '/IGNORE' Effectivity.description

XML representation of path

<refpath
   template="representing_dated_effectivity">
   <comment>
      Instantiate Dated_effectivity entity
   </comment>
   <instantiate
      entity="Dated_effectivity"
      context="">
      
   </instantiate>
   <comment>
      Bind the Dated_effectivity entity to the parameter dated_effectivity
   </comment>
   <comment>
      The dated_effectivity parameter is a reference parameter so the
   </comment>
   <comment>
      Dated_effectivity entity can be referred to when this template is used.
   </comment>
   <bind
      parameter="dated_effectivity">
      <express_entity
         entity="Dated_effectivity"
         context="">
         
      </express_entity>
   </bind>
   <comment>
      Set the Dated_effectivity attributes to be ignored
   </comment>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Dated_effectivity"
            attribute="id"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Dated_effectivity"
            attribute="name"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Dated_effectivity"
            attribute="description"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <comment>
      Set up date for start_bound - Instantiate the representing_date_time template
   </comment>
   <call_template
      name="representing_date_time"
      business_context="">
      <param_in
         name="year"
         value="@start_year">
         
      </param_in>
      <param_in
         name="month"
         value="@start_month">
         
      </param_in>
      <param_in
         name="day"
         value="@start_day">
         
      </param_in>
      <param_in
         name="hour"
         value="@start_hour">
         
      </param_in>
      <param_in
         name="minute"
         value="@start_minute">
         
      </param_in>
      <param_in
         name="second"
         value="@start_second">
         
      </param_in>
      <param_in
         name="sense"
         value="@start_sense">
         
      </param_in>
      <param_in
         name="hour_offset"
         value="@start_hour_offset">
         
      </param_in>
      <param_in
         name="minute_offset"
         value="@start_minute_offset">
         
      </param_in>
   </call_template>
   <comment>
      representing_date_time has a reference parameter ^date_time
   </comment>
   <comment>
      which is bound to the entity Date_time
   </comment>
   <comment>
      Assign Dated_effectivity.start_bound to ^date_time
   </comment>
   <bind
      parameter="start_date_time">
      <template_instance
         template="representing_date_time"
         parameter="date_time">
         
      </template_instance>
   </bind>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Dated_effectivity"
            attribute="start_bound"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="start_date_time">
            
         </bound_parameter>
      </source>
   </assign>
   <comment>
      Set up date for end_bound - Instantiate the representing_date_time template
   </comment>
   <comment>
      NOTE - this is optional
   </comment>
   <call_template
      name="representing_date_time"
      business_context="">
      <param_in
         name="year"
         value="@end_year">
         
      </param_in>
      <param_in
         name="month"
         value="@end_month">
         
      </param_in>
      <param_in
         name="day"
         value="@end_day">
         
      </param_in>
      <param_in
         name="hour"
         value="@end_hour">
         
      </param_in>
      <param_in
         name="minute"
         value="@end_minute">
         
      </param_in>
      <param_in
         name="second"
         value="@end_second">
         
      </param_in>
      <param_in
         name="sense"
         value="@end_sense">
         
      </param_in>
      <param_in
         name="hour_offset"
         value="@end_hour_offset">
         
      </param_in>
      <param_in
         name="minute_offset"
         value="@end_minute_offset">
         
      </param_in>
   </call_template>
   <comment>
      representing_date_time has a reference parameter ^date_time
   </comment>
   <comment>
      which is bound to the entity Date_time
   </comment>
   <comment>
      Assign Dated_effectivity.end_bound to ^date_time
   </comment>
   <bind
      parameter="end_date_time">
      <template_instance
         template="representing_date_time"
         parameter="date_time">
         
      </template_instance>
   </bind>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Dated_effectivity"
            attribute="end_bound"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="end_date_time">
            
         </bound_parameter>
      </source>
   </assign>
</refpath>

© OASIS 2010 — All rights reserved