javax.wbem.provider
Interface PropertyProvider

All Superinterfaces:

CIMProvider

public interface PropertyProvider

extends CIMProvider

This is the interface implemented by property providers. Property providers are used to retrieve and update properties which are dynamic in nature i.e. their values are not stored in the CIMOM data store.

Since:

WBEM 1.0

Method Summary

CIMValue	getPropertyValue(CIMObjectPath op, java.lang.String originClass, java.lang.String propertyName) This method retrieves the value of the property specified by the parameters.
void	setPropertyValue(CIMObjectPath op, java.lang.String originClass, java.lang.String propertyName, CIMValue cv) This method modifies the value of the property specified by the parameters.

Methods inherited from interface javax.wbem.provider.CIMProvider

cleanup, initialize

Method Detail

getPropertyValue

public CIMValue getPropertyValue(CIMObjectPath op,
                                 java.lang.String originClass,
                                 java.lang.String propertyName)
                          throws CIMException

This method retrieves the value of the property specified by the parameters.

Parameters:

op - The object path of the instance whose property must be retrieved. It must include all of the keys.

originClass - Contains the name of the class where this property was locally defined in the hierarchy. NOTE: This is needed where a class has a locally defined property with the same property name as another locally defined property in a superclass or subclass.

propertyName - The name of the property.

Returns:

CIMValue The value of the property.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_NOT_FOUND (if instance does not exist),
   CIM_ERR_NO_SUCH_PROPERTY (in this instance),
   CIM_ERR_TYPE_MISMATCH (for this property),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

setPropertyValue

public void setPropertyValue(CIMObjectPath op,
                             java.lang.String originClass,
                             java.lang.String propertyName,
                             CIMValue cv)
                      throws CIMException

This method modifies the value of the property specified by the parameters.

Parameters:

op - The object path of the instance whose property will be modified. It must include all of the keys.

originClass - Refer to originClass in getPropertyValue

propertyName - The name of the property.

cv - The new value of the property.

Throws:

CIMException - Refer to CIMException in getPropertyValue