IlsRelationDef

Category

Dynamic view-related class (server side)

Inheritance Path

IlsRelationDef

Description

An IlsRelationDef object defines the runtime visibility and access to a relation of a server object type. It is implicitly created in the server model interpreter via static initialization data declared in macros such as ILS_W_RELATION_X, ILS_RW_RELATION_X, ILS_USES_S, ILS_OWNS_X, ILS_INVERTED_X.

Library

Header File

#include <ilserver/rtmodel.h>

Synopsis

class IlsRelationDef {

public:

const IlsString& getName()const;

IlsRTTypes::RelationKind getKind() const;

const IlsString& getTargetTypeNm()const;

const IlsString& getReverse()const;

IlsBoolean isImplicit() const;

IlsRelationAccessor getRelationAccessor()const;

IlsSimpleTargetAccessor getSimpleTargetAccessor()const;

IlsRelationModifier getModifier()const;

IlsRelationModifier getInserter()const;

IlsRelationModifier getExtractor()const;

IlsBoolean isExported() const;

void setExported(IlsBoolean b);

};

Member Functions

const IlsString& getName()const;

This member function returns the name associated with the relation in the macro that declares the relation.


Note: This name can be different from the actual identifier of the C++ data member.

IlsRTTypes::RelationKind getKind() const;

This member function returns the kind of the relation.

const IlsString& getTargetTypeNm()const;

This member function returns the name of the relation target type.

const IlsString& getReverse()const;

This member function returns one of the following:

Either the name of the relation that is inverted in the case of an inverted relation,

Or the name of the associated inverted relation in the case of a direct relation,

Or the null string by default.

See also the macro ILS_REVERSE.

IlsBoolean isImplicit() const;

This member function returns IlsTrue if the relation has been declared implicitly by Rogue Wave Server, as is, for instance, the origin relation of any dynamic view type.

IlsRelationAccessor getRelationAccessor()const;

This member function returns the relation accessor.

IlsSimpleTargetAccessor getSimpleTargetAccessor()const;

In the case of a unary relation, this member function returns the target accessor. Otherwise, it returns the null pointer.

IlsRelationModifier getModifier()const;

This member function returns one of the following:

Either the modifier of the relation in the case of an editable direct unary relation,

Or the modifier of the inverse relation in the case of an inverse relation inverting an editable direct unary relation,

Or the null pointer.

IlsRelationModifier getInserter()const;

This member function returns one of the following:

Either the insertion operator of the relation in the case of an editable direct n-ary relation,

Or the insertion operator of the inverse relation in the case of an inverse relation inverting an editable direct n-ary relation,

Or the null pointer.

IlsRelationModifier getExtractor()const;

This member function returns one of the following:

Either the extraction operator of the relation in the case of an editable direct n-ary relation,

Or the extraction operator of the inverse relation in the case of an inverse relation inverting an editable direct n-ary relation,

Or the null pointer.

IlsBoolean isExported() const;

This member function returns IlsTrue if this element of the server model interpreter is exported. By default, all model interpreter elements are exported.

void setExported(IlsBoolean b);

Use this member function to export an element of the server model interpreter or to cancel exportation. Non-exported elements are not seen in Rogue Wave Server Studio.