pegasus/cgi/htdocs/Attic/EnumerateInstances.html - diff

Return to EnumerateInstances.html CVS log

Up to [Pegasus] / pegasus / cgi / htdocs / Attic

Diff for /pegasus/cgi/htdocs/Attic/EnumerateInstances.html between version 1.1 and 1.2

version 1.1, 2001/02/05 14:16:44

version 1.2, 2001/02/06 15:47:12

Line 10

</table>

<hr>

<p>

The <TT>enumerateInstanceNames</TT> operation enumerates the

The <TT>enumerateInstances</TT> method enumerates instances of a CIM

names (model paths) of the instances of a CIM Class in the target Namespace.

Class in the target Namespace.

<p><b><a href="#NameSpace">NameSpace</a></b>

<INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv20">  String that defines the target namespace. See <a href="getnamespaces.html">NameSpace

Operations</a> for more information.

<p><b><a href="#ClassName">ClassName</a></b> <INPUT TYPE="text" NAME="ClassName" SIZE=30>   Defines

name of the Class

for which instance names are to be retrieved.  This must be a legal

class in the        repository<p><INPUT TYPE="submit" VALUE="Submit Request">          

class in the repository

<p><b>LocalOnly</b> <INPUT TYPE="checkbox" NAME="LocalOnly" VALUE="true" checked>                       

If true only CIM Elements overridden within definition of class are

returned.

<p><b>IncludeQualifiers</b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true">            

If checked, show Qualifiers for class and returned Properties, Methods,

and Method Parameters.

<p><b>IncludeClassOrigins</b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigins" VALUE="true">       

If checked (TRUE), CLASSORIGIN attribute will be returned for all

appropriate elements<p><b>PropertyList </b> <INPUT TYPE="text" NAME="PropertyList" SIZE=30 VALUE="NULL">

NOTE: <b> NOT IMPLEMENTED </b>Null or array of property names to filter

request. <a href="#PropertyList">See below</a>.

</form>

<hr>

<h2>RETURN</h2>

If successful, the method returns zero or more names of Instances

(model paths) that meet the requested criteria.

If unsuccessful, one of the following status codes MUST be returned by this

<P>The <TT>enumerateInstances</TT> method enumerates instances of a CIM

method, where the first applicable error in the list (starting with the

Class in the target Namespace.

first element of the list, and working down) is the error returned. Any

additional method-specific interpretation of the error in is given in

NameSpace The NameSpace parameter is a string that defines the

parentheses.

target namespace \Ref{NAMESPACE}

ClassName The <TT>ClassName</TT> input parameter defines the

Class that is the basis for the enumeration. </P>

LocalOnly If the <TT>LocalOnly</TT> input parameter is

<TT>true</TT>, this specifies that, for each returned Instance,

only elements (properties and qualifiers) overriden within the

definition of that Instance are included. If <TT>false</TT>,

all elements are returned. This parameter therefore effects a CIM

Server-side mechanism to filter certain elements of the returned object

based on whether or not they have been propagated from the parent

Class (as defined by the <TT>PROPAGATED</TT> attribute).

@param DeepInheritance If the <TT>DeepInheritance</TT> input

parameter is <TT>true</TT>, this specifies that, for each

returned Instance of the Class, all properties of the Instance MUST

be present (subject to constraints imposed by the other

parameters), including any which were added by subclassing the specified

Class. If <TT>false</TT>, each returned Instance includes only

properties defined for the specified Class.

@param IncludeQualifiersIf the <TT>IncludeQualifiers</TT> input

parameter is <TT>true</TT>, this specifies that all Qualifiers

for each Instance (including Qualifiers on the Instance

and on any returned Properties) MUST be included as

<TT><QUALIFIER></TT> elements in the response. If false no

<TT><QUALIFIER></TT> elements are present in each

returned Instance.

@param IncludeClassOrigin If the <TT>IncludeClassOrigin</TT> input

parameter is <TT>true</TT>, this specifies that the

<TT>CLASSORIGIN</TT> attribute MUST be present on all appropriate

elements in each returned Instance. If false, no

<TT>CLASSORIGIN</TT> attributes are present in each returned

Instance.

@param PropertyList If the <TT>PropertyList</TT> input parameter is not

<TT>NULL</TT>, the members of the array define one or more Property

names. Each returned Instance MUST NOT include elements

for any Properties missing from this list. Note that if

<TT>LocalOnly</TT> is specified as <TT>true</TT> (or

<TT>DeepInheritance</TT> is specified as <TT>false</TT>) this acts as an

additional filter on the set of Properties returned (for example,

if Property <TT>A</TT> is included in the

<TT>PropertyList</TT> but <TT>LocalOnly</TT> is set to true and

<TT>A</TT> is not local to a returned Instance, then it will not be

included in that Instance). If the <TT>PropertyList</TT> input parameter

is an empty array this signifies that no Properties are included in each

returned Instance. If the <TT>PropertyList</TT> input parameter is

NULL this specifies that all Properties (subject to the conditions

expressed by the other parameters) are included in each returned

Instance.

If the <TT>PropertyList</TT> contains duplicate elements,

the Server MUST ignore the duplicates but otherwise process the request

normally. If the <TT>PropertyList</TT> contains elements which are

invalid Property names for any target Instance, the Server MUST

ignore such entries but otherwise process the request normally.

@return If successful, the method returns zero or more named

Instances that meet the required criteria.

If unsuccessful, one of the following status codes MUST be returned

by this method, where the first applicable error in the list (starting

with the first element of the list, and working down) is the error

returned. Any additional method-specific interpretation of the error in

is given in parentheses.

<UL>

<LI>CIM_ERR_ACCESS_DENIED

<LI>CIM_ERR_NOT_SUPPORTED

<LI>CIM_ERR_INVALID_NAMESPACE 

<LI>CIM_ERR_INVALID_PARAMETER (including missing,

duplicate, unrecognized or otherwise incorrect parameters)

duplicate, unrecognized or otherwise incorrect parameters)

<LI>CIM_ERR_INVALID_CLASS (the CIM Class that is the

basis for this enumeration does not exist)

<LI>CIM_ERR_FAILED (some other unspecified error occurred)</LI>

</UL>

<hr>

<h2>Additional Information</h2>

<p><b><a name="NameSpace">NameSpace</a></b> The NameSpace parameter is a string that defines the target

namespace. 

ClassName</b></a> The ClassName input parameter defines the Class that is the

basis for the enumeration. The ClassName input must be in the

repository

<hr>

<p>

<PRE>

virtual Array<Reference> enumerateInstanceNames(

virtual Array<InstanceDecl> enumerateInstances(

const String& nameSpace,

const String& className) = 0;

const String& className,

Boolean deepInheritance = true,

Boolean localOnly = true,

Boolean includeQualifiers = false,

Boolean includeClassOrigin = false,

const Array<String>& propertyList = _getStringArray()) = 0;

</PRE>

</body>

</html>

Legend:

Removed from v.1.1
changed lines
	Added in v.1.2

No CVS admin address has been configured