version 1.4, 2001/01/30 07:40:22
|
version 1.5, 2001/01/30 23:37:49
|
|
|
<body bgcolor="#CCCCCC"> | <body bgcolor="#CCCCCC"> |
<table width="100%"> | <table width="100%"> |
<tr> | <tr> |
<td width="50%" align="bottom"><h1>GetClass Operation</h1><td> |
<td width="50%" align="bottom"><h1>GetClass CIM Operation</h1><td> |
<td width="50%" align="right"> | <td width="50%" align="right"> |
<img border=1 src="/pegasus/icons/OpenGroupLogo.gif"> | <img border=1 src="/pegasus/icons/OpenGroupLogo.gif"> |
</td> | </td> |
|
|
<p>The <TT>GetClass</TT> method returns a single CIM Class from the target Namespace | <p>The <TT>GetClass</TT> method returns a single CIM Class from the target Namespace |
where the ClassName input parameter defines the name of the class to be retrieved. | where the ClassName input parameter defines the name of the class to be retrieved. |
<p><b>NameSpace</b> <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv20"> | <p><b>NameSpace</b> <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv20"> |
The NameSpace parameter is a string that defines the target namespace. |
String that defines the target namespace. See <a href="getnamespaces.html">NameSpace |
<p><b>ClassName</b> <INPUT TYPE="text" NAME="ClassName" SIZE=30> |
Operations</a> for more information<p><b>ClassName</b> <INPUT TYPE="text" NAME="ClassName" SIZE=30> |
The ClassName input parameter defines the name of the Class to be retrieved. |
Defines the name of the Class to be retrieved. See <a href="EnumerateClassNames.html">Enumerate |
<p><b>LocalOnly</b> <INPUT TYPE="checkbox" NAME="LocalOnly" VALUE="true" checked> |
Class Names</a> for a list of classes |
|
<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>. |
|
<p><INPUT TYPE="submit" VALUE="Submit Request"> |
|
<INPUT TYPE="reset" VALUE="Reset Form"> |
|
<p> <b>RETURN - </b>If successful, the return value is a single CIM Class.If unsuccessful, one of the |
|
CIM status codes show below 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_INVALID_NAMESPACE |
|
<LI>CIM_ERR_INVALID_PARAMETER (including missing, duplicate, |
|
unrecognized or otherwise incorrect parameters) |
|
<LI>CIM_ERR_ACCESS_DENIED |
|
<LI>CIM_ERR_INVALID_CLASS (the CIM Class does not exist in the |
|
specified namespace) |
|
<LI>CIM_ERR_NOT_FOUND (the CIM Class does exist, but the |
|
requested CIM Instance does not exist in the specified namespace) |
|
<LI>CIM_ERR_FAILED (some other unspecified error occurred) |
|
</LI> |
|
</UL> |
|
|
|
<p> ADDDITIONAL Description of Fields |
|
<p><a name="LocalOnly"><b>LocalOnly</b></a> - |
If the <TT>LocalOnly</TT> input parameter is true, this specifies that only CIM | If the <TT>LocalOnly</TT> input parameter is true, this specifies that only CIM |
Elements (properties, methods and qualifiers) overriden within the definition of | Elements (properties, methods and qualifiers) overriden within the definition of |
the Class are returned. If false, all elements are returned. This parameter | the Class are returned. If false, all elements are returned. This parameter |
therefore effects a CIM Server-side mechanism to filter certain elements of the | 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 | returned object based on whether or not they have been propagated from the parent |
Class (as defined by the PROPAGATED attribute). | Class (as defined by the PROPAGATED attribute). |
<p><b>IncludeQualifiers</b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true"> |
<p><b><a name="IncludeQualifiers">IncludeQualifiers</a></b> - |
If the <TT>IncludeQualifiers</TT> input parameter is true, this specifies that | If the <TT>IncludeQualifiers</TT> input parameter is true, this specifies that |
all Qualifiers for that Class (including Qualifiers on the Class and on any | all Qualifiers for that Class (including Qualifiers on the Class and on any |
returned Properties, Methods or Method Parameters) MUST be included as <QUALIFIER> | returned Properties, Methods or Method Parameters) MUST be included as <QUALIFIER> |
elements in the response. If false no QUALIFIER elements are present in the | elements in the response. If false no QUALIFIER elements are present in the |
returned Class. |
returned Class.<p><b><a name="IncludeClassOrigins">IncludeClassOrigin</a>s</b> |
<p><b>IncludeClassOrigins</b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigins" VALUE="true"> |
- |
If the <TT>IncludeClassOrigin</TT> input parameter is true, this specifies that | If the <TT>IncludeClassOrigin</TT> input parameter is true, this specifies that |
the CLASSORIGIN attribute MUST be present on all appropriate elements in the returned | the CLASSORIGIN attribute MUST be present on all appropriate elements in the returned |
Class. If false, no CLASSORIGIN attributes are present in the returned Class. | Class. If false, no CLASSORIGIN attributes are present in the returned Class. |
<p><b>PropertyList </b> <INPUT TYPE="text" NAME="PropertyList" SIZE=30 VALUE="NULL"> |
<p><b><a name="PropertyList">PropertyList</a> - </b>If the <TT>PropertyList</TT> input parameter is not NULL, the members of the array |
NOTE: <b> NOT IMPLEMENTED</b>. |
|
If the <TT>PropertyList</TT> input parameter is not NULL, the members of the array |
|
define one or more Property names. The returned Class MUST NOT include elements for any | define one or more Property names. The returned Class MUST NOT include elements for any |
Properties missing from this list. Note that if <TT>LocalOnly</TT> is specified as true this acts | Properties missing from this list. Note that if <TT>LocalOnly</TT> is specified as true this acts |
as an additional filter on the set of Properties returned (for example, if Property A is | as an additional filter on the set of Properties returned (for example, if Property A is |
|
|
the duplicates but otherwise process the request normally. If the PropertyList contains | the duplicates but otherwise process the request normally. If the PropertyList contains |
elements which are invalid Property names for the target Class, the Server MUST ignore | elements which are invalid Property names for the target Class, the Server MUST ignore |
such entries but otherwise process the request normally. | such entries but otherwise process the request normally. |
<p><INPUT TYPE="submit" VALUE="Submit Request"> |
<p> |
<INPUT TYPE="reset" VALUE="Reset Form"> |
|
<p> <b>RETURN - </b>If successful, the return value is a single CIM Class.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 |
|
<p> |
|
</form> | </form> |
| |
</body> | </body> |