IldSchemaEntity Class Reference

This class is the base class for all descriptions of schema entities in a database. More...

#include <ildblink/ildent.h>

Inheritance diagram for IldSchemaEntity:

Public Member Functions
virtual	~IldSchemaEntity ()
	This virtual destructor is invoked when any instance of a subclass from IldSchemaEntity is being destroyed. More...
IldDbms *	getDbms () const
	Get the attached to connection object. More...
IldEntityType	getEntityType () const
	Get the type of the entity. More...
IlInt	getId () const
	get the identifier of the entity. More...
const char *	getName () const
	Get the name of the entity. More...
const char *	getOwner () const
	Get the owner of the entity. More...

Detailed Description

This class is the base class for all descriptions of schema entities in a database.

Library: dbkernel

See also

IldEntityType

Constructor & Destructor Documentation

~IldSchemaEntity()

virtual IldSchemaEntity::~IldSchemaEntity ( )

virtual

This virtual destructor is invoked when any instance of a subclass from IldSchemaEntity is being destroyed.

The destructor also updates the IldDbms object that refers to that entity.

Member Function Documentation

getDbms()

IldDbms* IldSchemaEntity::getDbms

(

)

const

Get the attached to connection object.

Returns

The IldDbms object related to this entity.

Note

A null object will be returned if the entity was retrieved by means of one of the metadata read methods (e.g. readRelation).

getEntityType()

IldEntityType IldSchemaEntity::getEntityType

(

)

const

Get the type of the entity.

Returns

The type of the entity.

The returned value is any value from the enumeration IldEntityType with the exception of IldUnknownEntity.

getId()

IlInt IldSchemaEntity::getId

(

)

const

get the identifier of the entity.

Returns

The numeric identifier of the entity if it exists.

Otherwise, it returns 0. The existence of the identifier depends on the RDBMS.

getName()

const char * IldSchemaEntity::getName

(

)

const

Get the name of the entity.

Returns

The name of the entity as a string.

There always exists a name for any entity. It may be RDBMS generated.

Warning

Do not modify nor destroy the returned string.

getOwner()

const char * IldSchemaEntity::getOwner

(

)

const

Get the owner of the entity.

Returns

The owner of the entity as a string.

The owner may differ from the current user.

Warning

Do not modify nor destroy the returned string.