Generated <Class>DataId

This class is generated only if the schema has data ID columns. Objects of this class represent the data ID attributes of a persistent object.


Hierarchy

Inherits from:

IBase
 |
 +----IVBase
       |
       +----INotifier
             |
             +----IStandardNotifier
                   |
                   +----IPODataId
                         |
                         +----<Class>DataId

Public Functions by Category

Constructors

<Class>DataId

public:
<Class>DataId();
<Class>DataId([<attributeType> <attribute>, ... ]);
<Class>DataId(const <Class>DataId& partCopy);
Supported Platforms
Windows OS/2 AIX
Y Y Y

Destructor

~<Class>DataId

public:
virtual ~<Class>DataId() 
Supported Platforms
Windows OS/2 AIX
Y Y Y

Object Display

forDisplay

public:
virtual IString forDisplay( const char* separator = " " ) const;

Use this method to return an IString representation of the object. Only those attributes specified as For Display in the Attribute Properties notebook are returned in the string. The separator is used to separate the attributes.

Supported Platforms
Windows OS/2 AIX
Y Y Y

asString

public:
virtual IString asString( const char* separator ) const; 
virtual IString asString() const;

Use this method to return an IString representation of the object. The separator is used to separate the attributes. If no separator is specified, a period (".") separates the attributes.

Supported Platforms
Windows OS/2 AIX
Y Y Y

Attribute Access and Manipulation

<attribute>

public:
<attributeType> <attribute>() const;

Use this method to return the value of the specified attribute. You can change the value of this attribute by calling the set<Attribute> method.

Supported Platforms
Windows OS/2 AIX
Y Y Y

is<Attribute>Null

public:
IBoolean is<Attribute>Null() const;

Use this method to check whether the specified attribute is null. Returns true if it is null, or false if it is not.

Supported Platforms
Windows OS/2 AIX
Y Y Y

is<Attribute>Nullable

public:
IBoolean is<Attribute>Nullable() const;

Use this method to check whether the specified attribute can be set to null. Returns true if it can be set to null, or false if it cannot.

Supported Platforms
Windows OS/2 AIX
Y Y Y

<attribute>AsString

public:
IString <attribute>AsString() const;

Use this method to return the specified attribute as a string.

Supported Platforms
Windows OS/2 AIX
Y Y Y

set<Attribute>ToNull

public:
<Class>DataId& set<attribute>ToNull(IBoolean nullState=true);

Use this method to set the specified attribute to null. You can use this method only if is<Attribute>Nullable returns true. If the attribute is not nullable, calling this method throws an exception.

Supported Platforms
Windows OS/2 AIX
Y Y Y

set<Attribute>

public:
<Class>DataId& set<attribute>(const IString& aString ); 
<Class>DataId& set<attribute>(<attributeType> an<Attribute>); 

Use this method to change the value of the specified attribute.

Supported Platforms
Windows OS/2 AIX
Y Y Y

Public Operators

=

public:
<Class>DataId& operator= (const <Class>DataId& a<Class>);

==

public:
IBoolean operator == (const <Class>DataId& value) const;
IBoolean operator == (const <Class>DataId* value) const;

!=

public:
IBoolean operator != (const <Class>DataId& value) const;
IBoolean operator != (const <Class>DataId* value) const;

<

public:
IBoolean operator < (const <Class>DataId& value) const;
IBoolean operator < (const <Class>DataId* value) const; 
Supported Platforms
Windows OS/2 AIX
Y Y Y

Public Data

Notification ID Support

public:
static const INotificationId <attribute>;
static const INotificationId <attribute>NullId;
Supported Platforms
Windows OS/2 AIX
Y Y Y

Inherited Members

Inherited from IPODataId:

Public Functions