CIMPropertyList Class Reference

#include <CIMPropertyList.h>

List of all members.

Public Member Functions

 CIMPropertyList ()
 CIMPropertyList (const CIMPropertyList &x)
 CIMPropertyList (const Array< CIMName > &propertyNames)
 ~CIMPropertyList ()
void set (const Array< CIMName > &propertyNames)
CIMPropertyListoperator= (const CIMPropertyList &x)
void clear ()
Boolean isNull () const
Uint32 size () const
const CIMNameoperator[] (Uint32 index) const
Array< CIMNamegetPropertyNameArray () const

Detailed Description

The CIMPropertyList class represents a propertyList parameter in a CIM operation request, as defined in the DMTF Specification for CIM Operations over HTTP.

This class consists of an array of property names and a flag indicating whether the list is null. A null property list indicates that no filtering is performed on the basis of this parameter. A non-null property list indicates that any property not specified in the list is to be filtered from the CIM operation response. (An empty property list implies that all properties should be filtered from the response.)

A null property list is created by using the default constructor or the clear method. An empty property list is created by setting the value to an empty Array.


Constructor & Destructor Documentation

Constructs a null property list.

Example:

            CIMPropertyList pl;
            assert(pl.isNull());
        

Constructs a CIMPropertyList object from the value of a specified CIMPropertyList object.

Parameters:
xThe CIMPropertyList object from which to construct a new CIMPropertyList object.
CIMPropertyList::CIMPropertyList ( const Array< CIMName > &  propertyNames)

Constructs a non-null property list with the specified property names.

Example:

            Array<CIMName> n;
            n.append("name");
            n.append("type");
            CIMPropertyList pl(n);
        
Parameters:
propertyNamesAn Array of CIMNames specifying the property names in the list.

Member Function Documentation

Sets the property list to a null value.

Gets an Array of the property names in the property list.

Example:

            Array<CIMName> n = pl.getPropertyNameArray();
        
Returns:
An Array of CIMName objects containing the property names in the property list.
Boolean CIMPropertyList::isNull ( ) const

Determines whether the property list is null.

Returns:
True if the property list is null, false otherwise.
CIMPropertyList& CIMPropertyList::operator= ( const CIMPropertyList x)

Assigns the value of the specified CIMPropertyList object to this object.

Parameters:
xThe CIMPropertyList object from which to assign this CIMPropertyList object.
Returns:
A reference to this CIMPropertyList object.
const CIMName& CIMPropertyList::operator[] ( Uint32  index) const

Gets the property name at a specified index.

Example:

            Array<CIMName> n;
            n.append("name");
            n.append("type");
            CIMPropertyList pl(n);
            assert(pl[0] == CIMName("name"));
        
Parameters:
indexThe index of the property name to be retrieved.
Returns:
A CIMName containing the property name at the specified index.
Exceptions:
IndexOutOfBoundsExceptionIf the index is outside the range of property names in the property list or if the property list is null.
void CIMPropertyList::set ( const Array< CIMName > &  propertyNames)

Sets the property list with the specified property names. The resulting property list is non-null.

Example:

            Array<CIMName> n;
            n.append("name");
            n.append("type");
            CIMPropertyList pl;
            pl.set(n);
            assert(pl.size() = 2);
        
Parameters:
propertyNamesAn Array of CIMNames specifying the property names in the list.
Uint32 CIMPropertyList::size ( ) const

Gets the number of property names in the property list.

Returns:
An integer count of the property names in the CIMPropertyList. A value of 0 is returned if the list is null or empty.

The documentation for this class was generated from the following file: