blob: 8ab194b85ba276fc18aebb175f528f60f438b570 [file] [log] [blame]
## Copyright (c) 2008 Cisco Systems, Inc.
## All rights reserved. This program and the accompanying materials
## are made available under the terms of the Eclipse Public License v1.0
## which accompanies this distribution, and is available at
## http://www.eclipse.org/legal/epl-v10.html
##
## Contributors:
## Cisco Systems, Inc. - dkeysell
$castUtils.setPluginRef($pluginConfig)##
<html xmlns:xdt="http://www.w3.org/2005/02/xpath-datatypes" xmlns:fn="http://www.w3.org/2005/02/xpath-functions" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:fo="http://www.w3.org/1999/XSL/Format">
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>$tsProjectHandle.ProjectDetails.Name version: $tsProjectHandle.ProjectDetails.Version Documentation</title>
<link rel="stylesheet" type="text/css" href="../css/styles.css">
<!--
Generated by: $templateName in ${pluginConfig.pluginId}
-->
</head>
<body>
<h1>$tsProjectHandle.ProjectDetails.Name version: $tsProjectHandle.ProjectDetails.Version Documentation</h1>
<dl>
<dt>Project Description</dt>
<dd>${tsProjectHandle.ProjectDetails.Description}</dd>
</dl>
<h2>Index</h2>
<dl>
<dt><a href="#sd">Service Definitions</a></dt>
<dd>A list of the services available from ${tsProjectHandle.ProjectDetails.Name}.</dd>
<dt><a href="#p">Package List.</a></dt>
<dd>A description of the segmentation of ${tsProjectHandle.ProjectDetails.Name}.</dd>
<dt><a href="#e">Entity Class List.</a></dt>
<dd>A list of the entity classes in ${tsProjectHandle.ProjectDetails.Name}.</dd>
<dt><a href="enumerations.html">Enumerations</a></dt>
<dd>A list of the enumerations in ${tsProjectHandle.ProjectDetails.Name}.</dd>
<dt><a href="cTypes.html">Complex Types</a></dt>
<dd>A list of the complex types ${tsProjectHandle.ProjectDetails.Name}.</dd>
<dt><a href="updates.html">Update Procedures</a></dt>
<dd>A list of the Update Procedures in ${tsProjectHandle.ProjectDetails.Name}.</dd>
<dt><a href="notifications.html">Notifications</a></dt>
<dd>A list of the Notifications in ${tsProjectHandle.ProjectDetails.Name}.</dd>
<dt><a href="queries.html">Queries</a></dt>
<dd>A list of the Queries in ${tsProjectHandle.ProjectDetails.Name}.</dd>
<dt><a href="exceptions.html">Exceptions</a></dt>
<dd>A list of the Exceptions in ${tsProjectHandle.ProjectDetails.Name}.</dd>
</dl>
## Package hierarchy
<h2><a name="p">Package List</a></h2>
A description of the segmentation of ${tsProjectHandle.ProjectDetails.Name}.
<ul>
#foreach ($p in $docUtils.getRootPackages($managerSession, $allArtifacts))
#package($p)
#end
</ul>
## Class hierarchy
<h2><a name="e">Entity Class List</a></h2>
<p>A list of the entity classes in the ${tsProjectHandle.ProjectDetails.Name}. Entries in <i>italics</i> are abstract.</p>
#foreach ($i in $docUtils.sortByName($castUtils.toModel($allEntities)))
#href($i)#generals($i)<br/>
#end
<h2><a name="sd">Service Definitions</a></h2>
A list of the services available from ${tsProjectHandle.ProjectDetails.Name}.
<ul>
#foreach ($s in $docUtils.sortByName($castUtils.toModel($allSessions)))
<li>#href($s) #if(${s.inheritedOperations.size()}>0)has operations#end</li><ul>
#foreach($o in $docUtils.sortByName(${s.inheritedOperations}))
<li>#href($o)</li>
#end
</ul>
#set($ec=false)
#foreach($e in $castUtils.toModel($allEntities))
#foreach($i in $e.implements)
#if($i == $s)
#set($ec = true)
#end
#end
#end
#if($ec==true)
Interface $s.name is implemented by:
<ul>
#foreach($e in $docUtils.sortByName($castUtils.toModel($allEntities)))
#foreach($i in $e.implements)
#if($i == $s)
<li>#href($e)#if(${e.inheritedOperations.size()}>0)has operations#end</li><ul>
#foreach($o in $docUtils.sortByName($e.inheritedOperations))
<li>#href($o)</li>
#end
#end
#end
</ul>
#end
</ul>
#end
#if(${s.getArtifact().ManagedEntityDetails.size()}>0)
Interface $s.name exposes:
<ul>
#foreach($e in ${s.getArtifact().ManagedEntityDetails})
#foreach($a in $docUtils.sortByName($castUtils.toModel($allEntities)))
#if($a.fullyQualifiedName.equals($e.fullyQualifiedName))
<li>#href($a)#if(${a.inheritedOperations.size()}>0)has operations#end</li><ul>
#foreach($o in $a.inheritedOperations)
<li>#href($o)</li>
#end
</ul>
#end
#end
#end
</ul>
#end
#if(${s.getArtifact().EmittedEvents.size()}>0)
Interface $s.name emits:
<ul>
#foreach($e in ${s.getArtifact().EmittedEvents})
#foreach($a in $docUtils.sortByName($castUtils.toModel($allEvents)))
#if($a.fullyQualifiedName.equals($e.fullyQualifiedName))
<li>#href($a)</li>
#end
#end
#end
</ul>
#end
#end
</ul>
<p/>
<div id="footer-copyright">&copy; $tsProjectHandle.getProjectDetails().getProperty("copyrightNotice","")</div>
</body>
</html>