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