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