Index

DXDDOV4

Purpose:

This is the class that is used to represent a DDO base object.

Methods:

initialization
        setDatastore(LPDISPATCH ds);

For the add, del, update and retrieve method calls, this method must be called following the creation of a DXDDOV4 object (except for methods returning a DXDDOV4 object). The method initializes the DDO object with the datastore. The input parameter LPDISPATCH pointer contains a DXDatastoreV4 object.

add
        add();

Adds this object to the persistent datastore. The setDatastore method must be called prior to this call in order to associate the object to a datastore, unless this DXDDOV4 was returned from a method.

addData
        short   addData(LPCTSTR dataName);

Adds a new data-item to a DDO and returns the new data-item number (data-ID).

addDataProperty
        short   addDataProperty(short   dataId, LPCTSTR propertyName);

Adds a new data-item property to a DDO and returns the new property-item number (property-ID).

addDataPropertyAndValue
        short   addDataPropertyAndValue(short dataId, LPCTSTR propertyName,
                                        VARIANT propertyValue);

Adds a new data-item property to a DDO and returns the new property-item number (property-ID).

addProperty
        short   addProperty(LPCTSTR     propertyName);

Adds a new property to this DDO and returns the property ID.

addPropertyAndValue
        short addPropertyAndValue(LPCTSTR     propertyName,
                                    VARIANT propertyValue);

Adds a new property and its value to this DDO and returns the property-ID.

dataCount
        short   dataCount();

Gets the number of data-items in this DDO.

dataId
        short   dataId(LPCTSTR dataName);

Gets the data-ID of a given data-item name.

dataPropertyCount
        short   dataPropertyCount(short dataId);

Gets the number properties associated with this data-item.

dataPropertyId
         short dataPropertyId(short     dataId, LPCTSTR propertyName);

Gets the property ID of a given data-item property name.

del
        del();

Deletes this object from the persistent datastore. The setDatastore method must be called prior to this call in order to associate the object to a datastore, unless this DXDDOV4 was returned from a method.

getData
        VARIANT getData(short   dataId);

Gets the value of a given data item.

getDataByName
        VARIANT getDataByName(LPCTSTR   dataName);

Gets the value a given data item by its name.

getDataName
        BSTR getDataName(short dataId);

Gets the name of a given data item.

getDataProperty
        VARIANT getDataProperty(short   dataId, short   propertyId);

Gets the value of a given data-item property.

getDataPropertyById
        VARIANT getDataPropertyById(short dataId, LPCTSTR 
                                    LPCTSTR propertyName);

Gets the value a given data-item property by its name.

getDataPropertyByName
        VARIANT getDataPropertyByName(LPCTSTR   dataName,
                                      LPCTSTR propertyName);

Gets the value a given data-item property by its name.

getDataPropertyName
         BSTR   getDataPropertyName(short       dataId, short   propertyId);

Gets the name of a given data-item property.

getDatastore
         LPDISPATCH getDatastore();

Gets the datastore. The returned LPDISPATCH pointer contains a DXDatastoreV4 object.

getObjectType
        BSTR getObjectType();

Returns the object type of this DDO.

getPidObject
        LPDISPATCH getPidObject();

Returns the PID of this DDO. The returned LPDISPATCH pointer contains a DXPidV4 object.

getProperty
        VARIANT getProperty(short       propertyId);

Gets the value of a given property ID in this DDO.

getPropertyByName
        VARIANT getPropertyByName(LPCTSTR       propertyName);

Gets the value of a given property name in this DDO.

getPropertyName
        BSTR getPropertyName(short propertyId);

Gets the name of a given property ID in this DDO.

isDataPropertySet
        BOOL isDataPropertySet(short dataId, short propertyId);

Returns true if this data-item property value is set already.

isDataSet
        BOOL isDataSet(short dataId);

Returns true if this data-item value is set already.

isNull
        BOOL isNull(short       dataId);

Returns true if this data-item value is null or zero.

isPropertySet
        BOOL isPropertySet(short propertyId);

Returns true if the given property ID of this DDO is set.

propertyCount
        short   propertyCount();

Gets the number of properties associated with this DDO.

propertyId
        short   propertyId(LPCTSTR propertyName);

Gets the property-ID of a given property name in this DDO.

retrieve
        retrieve();

Retrieves this object from the persistent datastore. The setDatastore method must be called prior to this call in order to associate the object to a datastore, unless this DXDDOV4 was returned from a method.

setData
        setData(short   dataId, VARIANT propertyValue);

Sets the value of a given data item.

setDataName
        setDataName(short dataId,
                    LPCTSTR dataName);

Sets the name of a given data item.

setDataProperty
        setDataProperty(short dataId, short propertyId,
                        VARIANT propertyValue);

Sets the value of a given data-item property.

setDataPropertyName
        setDataPropertyName(short dataId, short propertyId,
                            LPCTSTR propertyName);

Sets the name of a given data-item property.

setDatastore
         setDatastore(LPDISPATCH ds);

Sets the datastore. The input parameter LPDISPATCH pointer contains a DXDatastoreV4.

setNull
        setNull(short   dataId);

Sets the value a given data item to a null value.

setObjectType
        setObjectType(LPCTSTR   objectType);

Sets the object type of this DDO.

setPidObject
        setPidObject(LPDISPATCH pid);
 

Sets the PID of this DDO. The input parameter LPDISPATCH pointer contains a DXPidV4 object.

setProperty
        setProperty(short propertyId,
                    VARIANT propertyValue);

Sets the value of a given property ID in this DDO.

setPropertyName
        setPropertyName(short   propertyId,
                        LPCTSTR propertyName);

Sets the name of a given property ID in this DDO.

updatable
        BOOL updatable();

Returns true if this object is updatable.

update
        update();

Updates this object in the persistent datastore. The setDatastore method must be called prior to this call in order to associate the object to a datastore, unless this DXDDOV4 was returned from a method.

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.