tmf854.v1 > SimpleFilter_T > includedObjectType
LOCATION: file:/xsd/interfaces/InventoryRetrieval.xsd
SECTIONS: Basic | XML Instance | Attributes | XML | Reference Overview | TOC | No TOC | Help
tmf854.v1
The includedObjectType Element

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.
Element SimpleFilter_T/includedObjectType : local complex type [0 .. *]
The includedObjectType element cannot have "xsi:nil" as an attribute. The includedObjectType element in XML instance can be substituted with other elements.

XML Instance
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>

﻿

Attributes |
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes

﻿

XML
-<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>

﻿

Uses
Type (2) Granularity_T ObjectAcronym_T

Used-By

Generated by WSDLdoc ©