(file) Return to EnumerateClassNames.html CVS log (file) (dir) Up to [Pegasus] / pegasus / cgi / htdocs

  1 mike  1.1 <html>
  2             <body bgcolor="#CCCCCC">
  3               <table width="100%">
  4                 <tr>
  5 karl  1.3 	<td width="50%" align="bottom"><h1>EnumerateClassNames Operation</h1><td>
  6 mike  1.1 	<td width="50%" align="right">
  7 karl  1.5 	    <img border=1 src="/pegasus/icons/OpenGroupLogo.gif">
  8 mike  1.1 	</td>
  9                 </tr>
 10               </table>
 11 karl  1.3     <hr>
 12 karl  1.8     <form name="EnumerateClassNames" METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient" >
 13 mike  1.1       <INPUT TYPE="hidden" NAME="Operation" VALUE="EnumerateClassNames">
 14 karl  1.10       <INPUT TYPE="hidden" NAME="hostaddress" VALUE="localhost:5988">
 15                  <INPUT TYPE="hidden" NAME="debug" VALUE="">
 16 karl  1.3        <p>
 17                The <TT>enumerateClassNames</TT> operation is used to enumerate the
 18                names of subclasses of a CIM Class in the target Namespace.
 19                  <p><b><a href="#NameSpace">NameSpace</a></b>
 20 karl  1.9          <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv2">
 21 a.arora 1.12       String that defines the target namespace. See <a href="enumeratenamespaces.html">NameSpace
 22 karl    1.11       Operations</a> for more information.<p><b><a href="http://www.opengroup.org/management#className">ClassName</a></b>
 23                      <INPUT TYPE="text" NAME="ClassName" SIZE=30>&nbsp;
 24 karl    1.6        Defines the name of the Class that is the basis for the enumeration.. Null (no entry) lists all
 25 karl    1.3        class names in the Namespace<p><b><a href="#DeepInheritance">DeepInheritance</a></b>
 26                      <INPUT TYPE="checkbox" NAME="DeepInheritance" VALUE="true" checked>&nbsp;
 27                    If true return names of all subclasses of specified class. If false, only
 28                    immediate subclasses are returned.
 29                    <p><INPUT TYPE="submit" VALUE="Submit Request">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 30 a.arora 1.12       <INPUT TYPE="reset" VALUE="Reset Form">
 31 mike    1.1      </form>
 32 karl    1.3      <hr>
 33              
 34 karl    1.8      <h2>Request Return&nbsp;</h2>
 35 karl    1.3  
 36                  <p> If successful, the method returns zero or more names of Classes that
 37                  meet the requested criteria as a CIM Array.
 38              
 39                  <p>If unsuccessful, one of the following status codes MUST be returned by this
 40                  method, where the first applicable error in the list (starting with the
 41                  first element of the list, and working down) is the error returned. Any
 42                  additional method-specific interpretation of the error in is given in
 43                  parentheses.
 44                  <UL>
 45                    <LI>CIM_ERR_ACCESS_DENIED
 46                    <LI>CIM_ERR_NOT_SUPPORTED
 47                    <LI>CIM_ERR_INVALID_NAMESPACE&nbsp;
 48                    <LI>CIM_ERR_INVALID_PARAMETER (including missing,
 49                      duplicate,&nbsp;unrecognized or otherwise incorrect parameters)
 50                    <LI>CIM_ERR_INVALID_CLASS (the CIM Class that is the
 51                      basis for this enumeration does not exist)
 52                    <LI>CIM_ERR_FAILED (some other unspecified error occurred)</LI>
 53                  </UL>
 54 karl    1.5  
 55 karl    1.3      <hr>
 56                  <h2>Additional Information on the Fields</h2>
 57                  <p><a name="NameSpace"><b>NameSpace</b></a> - The NameSpace parameter is a string that defines the
 58                  target namespace
 59              
 60 karl    1.11     <p><a name="ClassName"><b>className</b></a> - The <TT>ClassName</TT> input parameter defines the Class
 61 karl    1.6      that is the basis for the enumeration.&nbsp;Note that the class named is not
 62                  retrieved as part of the enumeration. Thus, if there are no subclasses to
 63                  the named class, zero classe names are returned.
 64 karl    1.3  
 65                  <p><a name="DeepInheritance"><b>DeepInheritance</b></a> - If the DeepInheritance input parameter is true, this
 66                  specifies that the names of all subclasses of the specified Class should be
 67                  returned (if the ClassName input parameter is absent, this implies that the
 68                  names of all Classes in the target Namespace should be returned).  If false,
 69                  only the names of immediate child subclasses are returned (if the ClassName
 70                  input parameter is NULL, this implies that the names of all base Classes in
 71 karl    1.6      the target Namespace should be returned.
 72 karl    1.3      <hr>
 73              
 74                  <h2>C++ Call</h2>
 75 karl    1.5  
 76 karl    1.3      <PRE>
 77                  virtual Array<String> enumerateClassNames(
 78                  	const String&amp; nameSpace,
 79                  	const String&amp; className = String::EMPTY,
 80                  	Boolean deepInheritance = false) = 0;
 81                  </PRE>
 82 karl    1.7    <hr><p style="margin-top: 0; margin-bottom: 0"> <font size="2">Demonstration
 83                   Prepared by the OpenGroup Manageability Work Group Pegasus Development Team</font>
 84              
 85                   <p style="margin-top: 0; margin-bottom: 0"> <font size="2">See (<a href="http://www.opengroup.org/management">http://www.opengroup.org/management</a>)
 86                   for more information on Pegasus</font>
 87              
 88                   <p style="margin-top: 0; margin-bottom: 0"> <font size="1">Last Modified <!--webbot bot="Timestamp" S-Type="EDITED"
 89 karl    1.11     S-Format="%A, %B %d, %Y %I:%M:%S %p" startspan -->Tuesday, January 29, 2002 11:36:22 AM<!--webbot bot="Timestamp" i-CheckSum="11606" endspan -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 90 karl    1.7       Copyright @ The Open Group 2001&nbsp;</font>
 91 karl    1.3  
 92 karl    1.10    <script>
 93                     document.EnumerateClassNames.hostaddress.value = top.hostAddress;
 94                     document.EnumerateClassNames.debug.value = top.debug;
 95                     document.EnumerateClassNames.NameSpace.value = top.NameSpace;
 96              	   window.focus();
 97                 </script>
 98 karl    1.3  
 99 mike    1.1    </body>
100              </html>

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2