Index

DXAttrDefIP

Purpose:

This class represents an attribute definition for Image Plus for OS/390. Each entity in an Image Plus for OS/390 datastore will have one or more attributes. Additional attributes may be added to a DXEntityDefIP object, but the ability to create and delete persistent attributes is not supported for Image Plus for OS/390.

Methods:

datastoreName
   BSTR datastoreName();

Get the name of the associated datastore.

datastoreType
   BSTR datastoreType();

Gets the type of the associated datastore.

getDatastore
   LPDISPATCH getDatastore();

Gets the associated datastore. The returned LPDISPATCH pointer contains a DXDatastoreIP object.

getDescription
   BSTR getDescription();

Gets the description.

getEntity
   LPDISPATCH getEntity();

Gets the associated entity. The returned LPDISPATCH pointer contains a DXEntityDefIP object.

getId
   short getId();

Gets the attribute id.

getMax
   long getMax();

Gets the maximum value allowed for the attribute.

getMin
   long getMin();

Gets the minimum value allowed for the attribute.

getName
   BSTR getName();

Gets the name of the attribute.

getPrecision
   long getPrecision();

Gets the precision.

getScale
   long getScale();

Gets the scale.

getSize
   long getSize();

Gets the size.

getStringType
   long getStringType();

Gets the string type.

getType
   short getType();

Return the datatype of the attribute. The possible datatypes are:

DX_IP_LONG (int)
may need to check upper and lower limits

DK_IP_SHORT (short int)
may need to check upper and lower limits

DK_IP_FSTRING (char)
fixed size char, get maximum length from getMax() and the minimum size from getMin()

DK_IP_VSTRING (varchar)
get the maximum length from getMax() and the minimum size from getMin()

DK_CM_TIMESTAMP (timestamp)
yyyy-mm-dd-hh.mm.ss.nnnnnn

DK_CM_DATE (date)
yyyy-mm-dd

DK_CM_TIME (time)
24 hour clock, hh.mm.ss

DK_CM_DECIMAL (decimal)
use the getPrecision(), getScale() methods to determine valid format. Use getSize() to determine display length (accounts for decimal point, and so forth).

All the time, date, and timestamp formats are ISO.

isNullable
   BOOL isNullable();

Returns true if the attribute value can be null.

isQueryable
   BOOL isQueryable();

Returns true if the attribute can be used in a query.

isUpdatable
   BOOL isUpdatable();

Returns true if the attribute value can be modified.

setDatastore
   setDatastore(LPDISPATCH ds);

Sets the associated datastore. The input parameter LPDISPATCH pointer contains a DXDatastoreIP object.

setDescription
   setDescription(LPCTSTR name);

Sets the description.

setEntity
   setEntity(LPDISPATCH ent);

Sets the entity. The input parameter LPDISPATCH pointer contains a DXEntityDefIP object.

setId
   setId(short id);

Sets the attribute id.

setMax
   setMax(long max);

Sets the maximum value allowed for the attribute.

setMin
   setMin(long Min);

Sets the minimum value allowed for the attribute.

setName
   setName(LPCTSTR name);

Sets the name of the attribute.

setNullable
   setNullable(BOOL nullable);

Sets the nullable indicator.

setPrecision
   setPrecision(long precision);

Sets the precision.

setQueryable
   setQueryable(BOOL queryable);

Sets the queryable indicator.

setScale
   setScale(long scale);

Sets the scale.

setSize
   setSize(long displaySize);

Sets the size.

setStringType
   setStringType(long stringType);

Sets the string type.

setType
   setType(short type);

Sets the data type for the attribute.

setUpdatable
   setUpdatable(BOOL updatable);

Set updatable indicator.

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