Associator Names CIM Operation


The associatorNames operation enumerates the names of CIM Objects (Classes or Instances) that are associated to a particular source CIM Object. 

NameSpace   String that defines the target namespace. See NameSpace Operations for more information.

ObjectName      Defines name of the Class or Instance for which Associator names are to be retrieved.  This must be a legal class in the repository or a valid Instance

AssocClass        Association Class that acts as filter

ResultClass    NULL or a valid CIM class name that acts as a filter on returned set of Object Names.

Role                Null or valid CIM Property name. Acts as filter on returned set of object names.

ResultRole         Null or Valid CIM Property name that acts as filter on returned set of names.

          



Additional Information

The associatorNames operation enumerates the names of CIM Objects (Classes or Instances) that are associated to a particular source CIM Object. 

NameSpace The NameSpace parameter is a string that defines the target namespace. 

ObjectName  The objectName 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).

assocClass The assocClass input parameter, if not NULL, MUST be a valid CIM Association Class name. It acts as a filter on the returned set of names by mandating that each returned name identifies an Object that MUST be associated to the source Object via an Instance of this Class or one of its subclasses. 

resultClass The resultClass input parameter, if not NULL, MUST be a valid CIM Class name. It acts as a filter on the returned set of names by mandating that each returned name identifies an Object that MUST be either an Instance of this Class (or one of its subclasses) or be this Class (or one of its subclasses). 

role The role input parameter, if not NULL, MUST be a valid CIMProperty name. It acts as a filter on the returned set of names by mandating that each returned name identifies an Object that MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the CIMProperty in the Association Class that refers to the source Object MUST match the value of this parameter). 

resultRole The resultRole input parameter, if not NULL, MUST be a valid CIMProperty name. It acts as a filter on the returned set of names by mandating that each returned name identifies an Object that MUST be associated to the source Object via an Association in which the named returned Object plays the specified role (i.e. the name of the CIMProperty in the Association Class that refers to the returned Object MUST match the value of this parameter). 


Return

If successful, the method returns zero or more full CIM Class paths or Instance paths of Objects meeting the requested criteria. Since it is possible for CIM Objects from different hosts or namespaces to be associated, each returned path is an absolute path that includes host and namespace information. 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.


C++ Call

    virtual Array associatorNames(
        const String& nameSpace,
        const CIMReference& objectName,
        const String& assocClass = String::EMPTY,
        const String& resultClass = String::EMPTY,
        const String& role = String::EMPTY,
        const String& resultRole = String::EMPTY) = 0;
    Go To Top 

Demonstration Prepared by the OpenGroup Manageability Work Group Pegasus Development Team

See (http://www.opengroup.org/management) for more information on Pegasus

Last Modified Friday, July 06, 2001 08:43:53 PM       Copyright @ The Open Group 2001