Index

DXDDODES

Purpose:

This class represents a DDO base object.

Methods:

getObjectType
BSTR getObjectType();
 

Returns the object type of this DDO.

setObjectType
setObjectType(LPCTSTR objectType);

Sets the object type of this DDO.

getPidObject
LPDISPATCH getPidObject();

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

setPidObject
setPidObject(LPDISPATCH pid);

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

updatable
BOOL updatable();

Returns TRUE if this object is updatable.

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).

dataCount
short dataCount();

Gets the number of data items in this DDO.

dataPropertyCount
short dataPropertyCount(short dataId);

Gets the number properties associated with this data item.

getDataProperty
afx_msg VARIANT getDataProperty(short dataId, short propertyId);

Gets the value of a given data item property.

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.

getDataPropertyName
BSTR getDataPropertyName(short dataId, short propertyId);

Gets the name of a given data item property.

setData
setData(short dataId, VARIANT propertyValue);

Sets the value of a given data item.

getData
VARIANT getData(short dataId);

Gets the value of a given data item.

setDataName
setDataName(short dataId, LPCTSTR dataName);

Sets the name of a given data item.

getDataName
BSTR getDataName(short dataId);

Gets the name of a given data item.

dataId
short dataId(LPCTSTR dataName);

Gets the data ID of a given data item name.

dataPropertyId
short dataPropertyId(short dataId, LPCTSTR propertyName);

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

getDataByName
Variant getDataByName(LPCTSTR dataName);

Gets the value of a given data item by its name.

getDataPropertyByName
VARIANT getDataPropertyByName(LPCTSTR dataName, LPCTSTR propertyName);

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

getDataPropertyById
VARIANT getDataPropertyById(short dataId, LPCTSTR propertyName);

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

setNull
setNull(short dataId);

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

isNull
BOOL isNull(short dataId);

Returns TRUE if this data item value is null or zero.

isDataSet
BOOL isDataSet(short dataId);

Returns TRUE if this data item value is set already.

isDataPropertySet
BOOL isDataPropertySet(short dataId, short propertyId);

Returns TRUE if this data item property value is set already.

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.

propertyCount
short propertyCount();

Gets the number of properties associated with this DDO.

setProperty
setProperty(short propertyId, VARIANT propertyValue);

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

getProperty
VARIANT getProperty(short propertyId);

Gets 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.

getPropertyName
BSTR getPropertyName(short propertyId);

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

propertyId
short propertyId(LPCTSTR propertyName);

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

getPropertyByName
VARIANT getPropertyByName(LPCTSTR propertyName);

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

isPropertySet
BOOL isPropertySet(short propertyId);

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

add/retrieve/update/del
add();
retrieve();
update();
del()

Add, retrieve, update, or delete this object from the persistent store. The setDatastore method must be called prior to any of these callings to associate the object to a datastore unless this DXDDODES is returned from a method.

getDatastore
LPDISPATCH getDatstore();

Gets the datastore. The returned LPDISPATCH pointer contains either a DXDatastoreDES object, a DXDatastoreTS object or a DXDatastoreQBIC object.

setDatastore
setDatastore(LPDISPATCH ds);

Sets the datastore. The input parameter LPDISPATCH pointer contains either a DXDatastoreDES object, a DXDatastoreTS object, or a DXDatastoreQBIC object.

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