1 karl 1.1 <html>
2 <body bgcolor="#CCCCCC">
3 <table width="100%">
4 <tr>
5 <td width="50%" align="bottom"><h1>Associator Names CIM Operation</h1><td>
6 <td width="50%" align="right">
7 <img border=1 src="/pegasus/icons/OpenGroupLogo.gif">
8 </td>
9 </tr>
10 </table>
11 <hr>
12 <form name="ReferenceNames" METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient">
13 <INPUT TYPE="hidden" NAME="Operation" VALUE="ReferenceNames">
14 <INPUT TYPE="hidden" NAME="hostaddress" VALUE="localhost:5988">
15 <p>
16 <a name="TOP"></a>
17
18 The <TT>associatorNames</TT> operation enumerates the names of
19 CIM Objects (Classes or Instances) that are associated to a particular
20 source CIM Object.
21 <p><b><a href="#NameSpace">NameSpace</a></b>
22 karl 1.1 <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv2"> String that defines the target namespace. See <a href="getnamespaces.html">NameSpace
23 Operations</a> for more information.
24 <p><b><a href="#ObjectName">ObjectName</a></b> <INPUT TYPE="text" NAME="ObjectName" SIZE=33> Defines
25 name of the Class
26 for which instance names are to be retrieved. This must be a legal
27 class in the repository<p><b>AssocClass </b> <input type="text" name="AssocClass" size="20"><p><b><a href="#ResultClass">ResultClass</a></b>
28 <input type="text" name="ResultClass" size="34"> NULL or a valid CIM class name
29 that acts as a filter on returned set of Object Names.<p><b><a href="#Role">Role</a></b><a href="#Role"> </a>
30 <input type="text" name="Role" size="34"> Null or valid CIM Property name.
31 Acts as filter on returned set of object names.<p>ResultRole
32 <input type="text" name="ResultRole" size="34">
33 <p><INPUT TYPE="submit" VALUE="Submit Request">
34 <INPUT TYPE="reset" VALUE="Reset">
35 </form>
36
37 <hr>
38 <hr>
39 <h2>Additional Information</h2>
40 <p>The <TT>associatorNames</TT> operation enumerates the names of
41 CIM Objects (Classes or Instances) that are associated to a particular
42 source CIM Object.
43 karl 1.1 <p><b><a name="NameSpace">NameSpace</a></b> The NameSpace parameter is a string that defines the target
44 namespace. <br>
45 <br>
46 <b>
47 <a name="ObjectName">
48 ObjectName</a></b> The <TT>objectName</TT> input parameter defines the target CIM Object whose referring object names are to be returned. It may be either a Class name or an Instance name (model path).<br>
49 <br>
50 <b>assocClass</b> The <TT>assocClass</TT> input parameter, if not NULL,
51 MUST be a valid CIM Association Class name. It acts as a filter on the
52 returned set of names by mandating that each returned name identifies an
53 Object that MUST be associated to the source Object via an Instance of this
54 Class or one of its subclasses.
55 <p><b>resultClass</b> The <TT>resultClass</TT> input parameter, if not NULL,
56 MUST be a valid CIM Class name. It acts as a filter on the returned set of
57 names by mandating that each returned name identifies an Object that MUST be
58 either an Instance of this Class (or one of its subclasses) or be this Class
59 (or one of its subclasses).
60 <p><b>role</b> The <TT>role</TT> input parameter, if not NULL, MUST be a valid
61 CIMProperty name. It acts as a filter on the returned set of names by
62 mandating that each returned name identifies an Object that MUST be
63 associated to the source Object via an Association in which the source
64 karl 1.1 Object plays the specified role (i.e. the name of the CIMProperty in the
65 Association Class that refers to the source Object MUST match the value of
66 this parameter).
67 <p><b>resultRole</b> The <TT>resultRole</TT> input parameter, if not
68 <TT>NULL</TT>, MUST be a valid CIMProperty name. It acts as a filter on the
69 returned set of names by mandating that each returned name identifies an
70 Object that MUST be associated to the source Object via an Association in
71 which the named returned Object plays the specified role (i.e. the name of
72 the CIMProperty in the Association Class that refers to the returned Object
73 MUST match the value of this parameter).
74 <hr>
75 <h2>Return</h2>
76 <p>
77
78 If successful, the method returns zero or more full CIM Class paths
79 or Instance paths of Objects meeting the requested criteria. Since it is
80 possible for CIM Objects from different hosts or namespaces to be
81 associated, each returned path is an absolute path that includes host and
82 namespace information.
83
84 If unsuccessful, one of the following status codes MUST be returned by this
85 karl 1.1 method, where the first applicable error in the list (starting with the
86 first element of the list, and working down) is the error returned. Any
87 additional method-specific interpretation of the error in is given in
88 parentheses.
89
90 <UL>
91 <LI>CIM_ERR_ACCESS_DENIED
92 <LI>CIM_ERR_NOT_SUPPORTED
93 <LI>CIM_ERR_INVALID_NAMESPACE;
94 <LI>CIM_ERR_INVALID_PARAMETER (including missing,
95 duplicate, unrecognized or otherwise incorrect parameters)
96 <LI>CIM_ERR_FAILED (some other unspecified error occurred)</LI>
97 </UL>
98 <hr>
99 <h2>C++ Call</h2>
100 <pre>
101 virtual Array<CIMReference> associatorNames(
102 const String& nameSpace,
103 const CIMReference& objectName,
104 const String& assocClass = String::EMPTY,
105 const String& resultClass = String::EMPTY,
106 karl 1.1 const String& role = String::EMPTY,
107 const String& resultRole = String::EMPTY) = 0;
108 <a href="#TOP">Go To Top</a> </pre>
109 <hr><p style="margin-top: 0; margin-bottom: 0"> <font size="2">Demonstration
110 Prepared by the OpenGroup Manageability Work Group Pegasus Development Team</font>
111
112 <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>)
113 for more information on Pegasus</font>
114
115 <p style="margin-top: 0; margin-bottom: 0"> <font size="1">Last Modified <!--webbot bot="Timestamp" S-Type="EDITED"
116 S-Format="%A, %B %d, %Y %I:%M:%S %p" startspan -->Friday, June 29, 2001 06:59:20 PM<!--webbot bot="Timestamp" i-CheckSum="54859" endspan -->
117 Copyright @ The Open Group 2001 </font>
118
119 <pre> </pre>
120 <pre> <script>
121 document.ReferenceNames.hostaddress.value = top.hostAddress;
122 document.ReferenceNames.debug = top.debug;
123 document.ReferenceNames.NameSpace = top.namespace;
124 window.focus();
125 </script></pre>
126 </body>
127 karl 1.1 </html>
128
|
Return to
AssociatorNames.html
CVS log
Up to [Pegasus] / pegasus / cgi / htdocs