18 karl 1.2 The <TT>enumerateInstances</TT> method enumerates instances of a CIM
19 Class in the target Namespace.
20 <p><b><a href="#NameSpace">NameSpace</a></b>
21 <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv20"> String that defines the target namespace. See <a href="getnamespaces.html">NameSpace
22 Operations</a> for more information.
23 <p><b><a href="#ClassName">ClassName</a></b> <INPUT TYPE="text" NAME="ClassName" SIZE=30> Defines
24 name of the Class
25 for which instance names are to be retrieved. This must be a legal
26 class in the repository
27 <p><b>LocalOnly</b> <INPUT TYPE="checkbox" NAME="LocalOnly" VALUE="true" checked>
28 If true only CIM Elements overridden within definition of class are
29 returned.
30 <p><b>IncludeQualifiers</b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true">
31 If checked, show Qualifiers for class and returned Properties, Methods,
32 and Method Parameters.
33 <p><b>IncludeClassOrigins</b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigins" VALUE="true">
34 If checked (TRUE), CLASSORIGIN attribute will be returned for all
35 appropriate elements<p><b>PropertyList </b> <INPUT TYPE="text" NAME="PropertyList" SIZE=30 VALUE="NULL">
36 NOTE: <b> NOT IMPLEMENTED </b>Null or array of property names to filter
37 request. <a href="#PropertyList">See below</a>.
38 <p><INPUT TYPE="submit" VALUE="Submit Request">
39 karl 1.2 <INPUT TYPE="reset" VALUE="Reset">
40 </form>
41
42 <hr>
43 <h2>RETURN</h2>
44
45 <P>The <TT>enumerateInstances</TT> method enumerates instances of a CIM
46 Class in the target Namespace.
47
48 NameSpace The NameSpace parameter is a string that defines the
49 target namespace \Ref{NAMESPACE}
50
51 ClassName The <TT>ClassName</TT> input parameter defines the
52 Class that is the basis for the enumeration. </P>
53
54 LocalOnly If the <TT>LocalOnly</TT> input parameter is
55 <TT>true</TT>, this specifies that, for each returned Instance,
56 only elements (properties and qualifiers) overriden within the
57 definition of that Instance are included. If <TT>false</TT>,
58 all elements are returned. This parameter therefore effects a CIM
59 Server-side mechanism to filter certain elements of the returned object
60 karl 1.2 based on whether or not they have been propagated from the parent
61 Class (as defined by the <TT>PROPAGATED</TT> attribute).
62
63 @param DeepInheritance If the <TT>DeepInheritance</TT> input
64 parameter is <TT>true</TT>, this specifies that, for each
65 returned Instance of the Class, all properties of the Instance MUST
66 be present (subject to constraints imposed by the other
67 parameters), including any which were added by subclassing the specified
68 Class. If <TT>false</TT>, each returned Instance includes only
69 properties defined for the specified Class.
70
71 @param IncludeQualifiersIf the <TT>IncludeQualifiers</TT> input
72 parameter is <TT>true</TT>, this specifies that all Qualifiers
73 for each Instance (including Qualifiers on the Instance
74 and on any returned Properties) MUST be included as
75 <TT><QUALIFIER></TT> elements in the response. If false no
76 <TT><QUALIFIER></TT> elements are present in each
77 returned Instance.
78
79 @param IncludeClassOrigin If the <TT>IncludeClassOrigin</TT> input
80 parameter is <TT>true</TT>, this specifies that the
81 karl 1.2 <TT>CLASSORIGIN</TT> attribute MUST be present on all appropriate
82 elements in each returned Instance. If false, no
83 <TT>CLASSORIGIN</TT> attributes are present in each returned
84 Instance.
85
86 @param PropertyList If the <TT>PropertyList</TT> input parameter is not
87 <TT>NULL</TT>, the members of the array define one or more Property
88 names. Each returned Instance MUST NOT include elements
89 for any Properties missing from this list. Note that if
90 <TT>LocalOnly</TT> is specified as <TT>true</TT> (or
91 <TT>DeepInheritance</TT> is specified as <TT>false</TT>) this acts as an
92 additional filter on the set of Properties returned (for example,
93 if Property <TT>A</TT> is included in the
94 <TT>PropertyList</TT> but <TT>LocalOnly</TT> is set to true and
95 <TT>A</TT> is not local to a returned Instance, then it will not be
96 included in that Instance). If the <TT>PropertyList</TT> input parameter
97 is an empty array this signifies that no Properties are included in each
98 returned Instance. If the <TT>PropertyList</TT> input parameter is
99 NULL this specifies that all Properties (subject to the conditions
100 expressed by the other parameters) are included in each returned
101 Instance.
102 karl 1.2
103 If the <TT>PropertyList</TT> contains duplicate elements,
104 the Server MUST ignore the duplicates but otherwise process the request
105 normally. If the <TT>PropertyList</TT> contains elements which are
106 invalid Property names for any target Instance, the Server MUST
107 ignore such entries but otherwise process the request normally.
108
109 @return If successful, the method returns zero or more named
110 Instances that meet the required criteria.
111
112 If unsuccessful, one of the following status codes MUST be returned
113 by this method, where the first applicable error in the list (starting
114 with the first element of the list, and working down) is the error
115 returned. Any additional method-specific interpretation of the error in
116 is given in parentheses.
117
118 <UL>
119 <LI>CIM_ERR_ACCESS_DENIED
120 <LI>CIM_ERR_NOT_SUPPORTED
121 <LI>CIM_ERR_INVALID_NAMESPACE
122 <LI>CIM_ERR_INVALID_PARAMETER (including missing,
123 karl 1.2 duplicate, unrecognized or otherwise incorrect parameters)
124 <LI>CIM_ERR_INVALID_CLASS (the CIM Class that is the
125 basis for this enumeration does not exist)
126 <LI>CIM_ERR_FAILED (some other unspecified erroroccurred)</LI>
127 </UL>
|
130 karl 1.2 virtual Array<InstanceDecl> enumerateInstances(
131 const String& nameSpace,
132 const String& className,
133 Boolean deepInheritance = true,
134 Boolean localOnly = true,
135 Boolean includeQualifiers = false,
136 Boolean includeClassOrigin = false,
137 const Array<String>& propertyList = _getStringArray()) = 0;
138 </PRE>
|
Return to
EnumerateInstances.html
CVS log
Up to [Pegasus] / pegasus / cgi / htdocs