tmf854.v1 > SimpleFilter_T LOCATION: file:/xsd/interfaces/InventoryRetrieval.xsd
SECTIONS: Basic | XML Instance | Attributes | XML | Reference Overview | TOC | No TOC | Help
tmf854.v1
The SimpleFilter_T Complex Type
The data structure of the Inventory Retrieval filter. Some examples are listed in the following table.

Filter Constraint | Simple Filter
Given an ME name (e.g., md1/ME123), get all the EHs and Equipment Attributes | BaseInstanceList: { (MD=md1;ME=ME123)} IncludedObjectTypes: { (EH, ATTRS), (EQ, ATTRS) }
Given an ME name (e.g., md1/ME123), get all the contained Ehs Attributes and the ME attibutes | BaseInstanceList: { (MD=md1;ME=ME123) } IncludedObjectTypes: { (ME, ATTRS), (EH, ATTRS) }
Get all MEs and associated attributes (within the entire inventory known to the target OS) | BaseInstanceList: { } IncludedObjectTypes { (ME, ATTRS) }
Get all ME, OS and MD names (within the entire inventory known to the target OS) | BaseInstanceList: { } IncludedObjectTypes: { (ME, NAME), (MD, NAME), (OS, NAME) }
Given an EH name (e.g., md1/ME123/ACME7), get all the contained Equipment (and relationship pointers) | BaseInstanceList: { (MD=md1;ME=ME123;EH=ACME7) } IncludedObjectTypes: { (EQ,FULL)}
Given a PTP name (e.g., md1/ME123/PTPxyz), get the PTP Attributes | BaseInstanceList: { (MD=md1;ME=ME123;PTP=PTPxyz) } IncludedObjectTypes: { (PTP, ATTRS) }

Local elements (4)
  baseInstance includedObjectType includedObjectType/objectType includedObjectType/granularity

Complex Type SimpleFilter_T
The SimpleFilter_T type does not allow mixed content. There is no restriction on type derivation.

XML Instance
<... extAuthor="xsd:string" extVersion="xsd:string" tmf854Version="TMF854_Version_T"> -Begin Sequence [1...1] This attribute identifies a list of base object instances for the subtrees to be retrieved. BaseInstanceList is a list of serialized MTOSI names. If the BaseInstanceList is left empty then all the nodes at the top of the MTOSI instance tree are selected (i.e., all MDs, TMDs, and OSs are selected). Specification of the BaseInstanceList does not select any objects in and of itself. In order to select specific objects, one needs to specify the IncludedObjectTypes. <baseInstance extVersion="xsd:string" extAuthor="xsd:string" tmf854Version="TMF854_Version_T">NamingAttributes_T</baseInstance> [0..*] This attribute identifies the type of objects contained under the selected base object instances that are to be included in the returned inventory file. The base object itself is included only if the type of the base instance appears in the IncludedObjectTypes list. If no included object types are listed, then the entire subtree under the base object instance is returned. For each included object type, one needs to indicate whether. just the name, all the associated attributes (including the name), or the associated attributes and relationship pointers are to be returned for each instance. The IncludedObjectTypes need to be picked such that each selected base class has a single (connected) subtree below it. For example, if all the EHs under a given MD where needed, the requesting OS would need to list the given MD as a base instance and put ME and EH in the IncludedObjectTypes list. The requesting OS could just request the names of the MEs to reduce the size of the returned file. <includedObjectType> -Begin Sequence [1...1] Specify the object type acronym. The ";" is used as a separator, and "=" is used to associate a value with a type of object. For example, MD=md1;ME=ME123;EH=ACME7 identifies an equipment holder within managed element ME123 within management domain md1. The relative name of the equipment holder is ACME7. <objectType>ObjectAcronym_T</objectType> [1..1] Specify the granularity of the inventory report. <granularity>Granularity_T</granularity> [1..1] End Sequence </includedObjectType> [0..*] End Sequence </...>

﻿

Attributes |
﻿
Name | Type | Summary
--- | --- | ---
extAuthor | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extAuthor is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
extVersion | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extVersion is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
tmf854Version | TMF854_Version_T | This attribute is optional. Its form is unqualified. Show details.
Base type of tmf854Version is string. There are several restrictions on the value. The schema processor preserves value's whitespace. The value must match "`1\.([0-9]|[A-Z]|[a-z])*`".
﻿
Name | Type | Summary
--- | --- | ---
extAuthor | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extAuthor is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
extVersion | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extVersion is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
tmf854Version | TMF854_Version_T | This attribute is optional. Its form is unqualified. Show details.
Base type of tmf854Version is string. There are several restrictions on the value. The schema processor preserves value's whitespace. The value must match "`1\.([0-9]|[A-Z]|[a-z])*`".
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes

﻿

XML
-<xsd:complexType name="SimpleFilter_T"> -<xsd:annotation> -<xsd:documentation> The data structure of the Inventory Retrieval filter. Some examples are listed in the following table. -<table cellpadding="0" cellspacing="0"> -<tr> -<td valign="top"> -<p> <b>Filter Constraint</b> </p> </td> -<td valign="top"> -<p> <b>Simple Filter</b> </p> </td> </tr> -<tr> -<td valign="top"> <p>Given an ME name (e.g., md1/ME123), get all the EHs and Equipment Attributes</p> </td> -<td valign="top"> <p>BaseInstanceList: { (MD=md1;ME=ME123)}</p> <p>IncludedObjectTypes: { (EH, ATTRS), (EQ, ATTRS) }</p> </td> </tr> -<tr> -<td valign="top"> <p>Given an ME name (e.g., md1/ME123), get all the contained Ehs Attributes and the ME attibutes</p> </td> -<td valign="top"> <p>BaseInstanceList: { (MD=md1;ME=ME123) }</p> <p>IncludedObjectTypes: { (ME, ATTRS), (EH, ATTRS) }</p> </td> </tr> -<tr> -<td valign="top"> <p>Get all MEs and associated attributes (within the entire inventory known to the target OS)</p> </td> -<td valign="top"> <p>BaseInstanceList: { }</p> <p>IncludedObjectTypes { (ME, ATTRS) }</p> </td> </tr> -<tr> -<td valign="top"> <p>Get all ME, OS and MD names (within the entire inventory known to the target OS)</p> </td> -<td valign="top"> <p>BaseInstanceList: { }</p> <p>IncludedObjectTypes: { (ME, NAME), (MD, NAME), (OS, NAME) }</p> </td> </tr> -<tr> -<td valign="top"> <p>Given an EH name (e.g., md1/ME123/ACME7), get all the contained Equipment (and relationship pointers)</p> </td> -<td valign="top"> <p>BaseInstanceList: { (MD=md1;ME=ME123;EH=ACME7) }</p> <p>IncludedObjectTypes: { (EQ,FULL)}</p> </td> </tr> -<tr> -<td valign="top"> <p>Given a PTP name (e.g., md1/ME123/PTPxyz), get the PTP Attributes</p> </td> -<td valign="top"> <p>BaseInstanceList: { (MD=md1;ME=ME123;PTP=PTPxyz) }</p> <p>IncludedObjectTypes: { (PTP, ATTRS) }</p> </td> </tr> </table> </xsd:documentation> </xsd:annotation> -<xsd:sequence> -<xsd:element maxOccurs="unbounded" minOccurs="0" name="baseInstance" type="NamingAttributes_T"> -<xsd:annotation> <xsd:documentation> This attribute identifies a list of base object instances for the subtrees to be retrieved. BaseInstanceList is a list of serialized MTOSI names. If the BaseInstanceList is left empty then all the nodes at the top of the MTOSI instance tree are selected (i.e., all MDs, TMDs, and OSs are selected). Specification of the BaseInstanceList does not select any objects in and of itself. In order to select specific objects, one needs to specify the IncludedObjectTypes. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element maxOccurs="unbounded" minOccurs="0" name="includedObjectType"> -<xsd:annotation> -<xsd:documentation> -<p> This attribute identifies the type of objects contained under the selected base object instances that are to be included in the returned inventory file. The base object itself is included only if the type of the base instance appears in the IncludedObjectTypes list. If no included object types are listed, then the entire subtree under the base object instance is returned. For each included object type, one needs to indicate whether. -<ul> <li>just the name,</li> <li>all the associated attributes (including the name), or</li> <li>the associated attributes and relationship pointers are to be returned for each instance.</li> </ul> The IncludedObjectTypes need to be picked such that each selected base class has a single (connected) subtree below it. For example, if all the EHs under a given MD where needed, the requesting OS would need to list the given MD as a base instance and put ME and EH in the IncludedObjectTypes list. The requesting OS could just request the names of the MEs to reduce the size of the returned file. </p> </xsd:documentation> </xsd:annotation> -<xsd:complexType> -<xsd:sequence> -<xsd:element name="objectType" type="ObjectAcronym_T"> -<xsd:annotation> <xsd:documentation> Specify the object type acronym. The ";" is used as a separator, and "=" is used to associate a value with a type of object. For example, MD=md1;ME=ME123;EH=ACME7 identifies an equipment holder within managed element ME123 within management domain md1. The relative name of the equipment holder is ACME7. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element name="granularity" type="Granularity_T"> -<xsd:annotation> <xsd:documentation> Specify the granularity of the inventory report. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:attribute name="extVersion" type="xsd:string" use="optional" /> <xsd:attribute name="extAuthor" type="xsd:string" use="optional" /> <xsd:attribute name="tmf854Version" type="TMF854_Version_T" use="optional" /> </xsd:complexType>

﻿

Uses
Type (5) Granularity_T NamingAttributes_T ObjectAcronym_T string TMF854_Version_T

Used-By
Element (1) getInventory_T/filter

Generated by WSDLdoc ©